cgl.hpsearch.common.xml
Class Stream

java.lang.Object
  cgl.hpsearch.common.xml.Stream

All Implemented Interfaces:

Serializable

public class Stream

extends Object

implements Serializable

Specifies each individual stream Connects the source to the destination stream. The source and dest fields may contain any type of URI, e.g.

•  topic:///CGL/WORKFLOW/STREAM_ID-3473f38f/stream1
   

•  http://156.56.104.155/data/hugeDatafiles/disc1.iso
   

•  file:///u/hgadgil/massStorage/dataFiles/archive1.tar.gz
   

The

 waitfor
 

will be used for joins tospecify the RequestHandler to wait until this particular stream is ready to be read. This functionality should be probably moved to the Filter object so that we can either wait on all streams or none. The current implementation proposes to have a more fine-grained control over the WAIT mechanism.

Version:

$Revision: 1.1 $ $Date: 2005/10/16 14:40:46 $

See Also:

Serialized Form

Constructor Summary

Stream()

Method Summary

void	addStreamComponent(int index, StreamComponent vStreamComponent) Method addStreamComponent
void	addStreamComponent(StreamComponent vStreamComponent) Method addStreamComponent
void	deleteWaitfor() Method deleteWaitfor
Enumeration	enumerateStreamComponent() Method enumerateStreamComponent
StreamComponent[]	getStreamComponent() Method getStreamComponent
StreamComponent	getStreamComponent(int index) Method getStreamComponent
int	getStreamComponentCount() Method getStreamComponentCount
boolean	getWaitfor() Returns the value of field 'waitfor'.
boolean	hasWaitfor() Method hasWaitfor
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
void	removeAllStreamComponent() Method removeAllStreamComponent
StreamComponent	removeStreamComponent(int index) Method removeStreamComponent
void	setStreamComponent(int index, StreamComponent vStreamComponent) Method setStreamComponent
void	setStreamComponent(StreamComponent[] streamComponentArray) Method setStreamComponent
void	setWaitfor(boolean waitfor) Sets the value of field 'waitfor'.
static Object	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Stream

public Stream()

Method Detail

addStreamComponent

public void addStreamComponent(StreamComponent vStreamComponent)
                        throws IndexOutOfBoundsException

Method addStreamComponent

Parameters:

vStreamComponent -

Throws:

IndexOutOfBoundsException

addStreamComponent

public void addStreamComponent(int index,
                               StreamComponent vStreamComponent)
                        throws IndexOutOfBoundsException

Method addStreamComponent

Parameters:

index -

vStreamComponent -

Throws:

IndexOutOfBoundsException

deleteWaitfor

public void deleteWaitfor()

Method deleteWaitfor

enumerateStreamComponent

public Enumeration enumerateStreamComponent()

Method enumerateStreamComponent

getStreamComponent

public StreamComponent getStreamComponent(int index)
                                   throws IndexOutOfBoundsException

Method getStreamComponent

Parameters:

index -

Throws:

IndexOutOfBoundsException

getStreamComponent

public StreamComponent[] getStreamComponent()

Method getStreamComponent

getStreamComponentCount

public int getStreamComponentCount()

Method getStreamComponentCount

getWaitfor

public boolean getWaitfor()

Returns the value of field 'waitfor'.

Returns:

the value of field 'waitfor'.

hasWaitfor

public boolean hasWaitfor()

Method hasWaitfor

isValid

public boolean isValid()

Method isValid

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeAllStreamComponent

public void removeAllStreamComponent()

Method removeAllStreamComponent

removeStreamComponent

public StreamComponent removeStreamComponent(int index)

Method removeStreamComponent

Parameters:

index -

setStreamComponent

public void setStreamComponent(int index,
                               StreamComponent vStreamComponent)
                        throws IndexOutOfBoundsException

Method setStreamComponent

Parameters:

index -

vStreamComponent -

Throws:

IndexOutOfBoundsException

setStreamComponent

public void setStreamComponent(StreamComponent[] streamComponentArray)

Method setStreamComponent

Parameters:

streamComponentArray -

setWaitfor

public void setWaitfor(boolean waitfor)

Sets the value of field 'waitfor'.

Parameters:

waitfor - the value of field 'waitfor'.

unmarshal

public static Object unmarshal(Reader reader)
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException