|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The AbleDataBufferManager interface describes the unique behavior required of AbleBeans which pass data using data buffers. A bean implementing this interface has either an inputBuffer, an outputBuffer, or both. Buffers are collections or arrays, and are not necessarily indexable. A bean expecting to process data via data buffers has dataflow enabled.
Method Summary | |
---|---|
void |
addDestBufferConnection(AbleBufferConnection theAbleBufferConnection)
Adds a destination buffer connection. |
void |
addSourceBufferConnection(AbleBufferConnection theAbleBufferConnection)
Adds a source buffer connection. |
java.util.Vector |
getDestBufferConnections()
Returns the list of all destination (output) buffer connections. |
java.lang.Object |
getInputBuffer()
Returns a reference to the input buffer. |
java.lang.Object |
getInputBuffer(int theIndex)
Returns the value of a single element of the input buffer. |
java.lang.String[] |
getInputBufferAsStringArray()
Returns the contents of the input buffer as an array of strings. |
java.util.Enumeration |
getInputBufferContents()
Returns the contents of the input buffer as an enumeration. |
java.lang.Object |
getOutputBuffer()
Returns a reference to the output buffer. |
java.lang.Object |
getOutputBuffer(int theIndex)
Returns the value of a single element of the output buffer. |
java.lang.String[] |
getOutputBufferAsStringArray()
Returns the contents of the output buffer as an array of Strings. |
java.util.Enumeration |
getOutputBufferContents()
Returns the contents of the output buffer as an enumeration. |
java.util.Vector |
getSourceBufferConnections()
Returns a list of all source (input) buffer connections. |
boolean |
hasInputBuffer()
Indicates if this bean has an input buffer. |
boolean |
hasOutputBuffer()
Indicates if this bean has an output buffer. |
boolean |
isConnectable()
Indicates if this bean supports buffer connections. |
boolean |
isDataFlowEnabled()
Indicates if the bean will process data in buffers. |
void |
processBufferConnections()
Processes all buffer connections. |
void |
removeAllBufferConnections()
Remove all buffer connections whether source or destination. |
void |
removeDestBufferConnection(AbleBufferConnection theAbleBufferConnection)
Remove a destination buffer connection. |
void |
removeSourceBufferConnection(AbleBufferConnection theAbleBufferConnection)
Removes a source buffer connection. |
void |
setDataFlowEnabled(boolean theDataFlowEnabledState)
Sets the data flow processing state of the bean. |
void |
setInputBuffer(int theIndex,
java.lang.Object theObject)
Sets the value of a single element of the input buffer. |
void |
setInputBuffer(java.lang.Object theInputBuffer)
Sets the input buffer to the specified object. |
void |
setOutputBuffer(int theIndex,
java.lang.Object theObject)
Sets the value of a single element of the output buffer. |
void |
setOutputBuffer(java.lang.Object theOutputBuffer)
Sets the output buffer to the specified object. |
Method Detail |
public void setDataFlowEnabled(boolean theDataFlowEnabledState)
AbleBeanContainer
should recalculate its processing list.theDataFlowEnabledState
- Indicates if this bean will process
data in buffers. When set to true, this bean
will be included in its parent's process list.public boolean isDataFlowEnabled()
public void setInputBuffer(java.lang.Object theInputBuffer) throws AbleException
theInputBuffer
- Any object, such as a String[], Vector, Hashtable, and
so on, that can act as a buffer of input data. A
reference to the object is saved; the object is not
cloned. Note that once the input buffer is set,
it must not be tampered with while an AbleBean is
reading data from it.
AbleException
- If an error occurs.public java.lang.Object getInputBuffer() throws AbleException
AbleException
- If an error occurs.public void setInputBuffer(int theIndex, java.lang.Object theObject) throws AbleException
theIndex
- The location in the input buffer to be set
to the specified value.
theObject
- The new value of the element at the specified
location.
AbleException
- If the input buffer does not support indexing.public java.lang.Object getInputBuffer(int theIndex) throws AbleException
theIndex
- The location to retrieve from the input buffer.
AbleException
- If the input buffer does not support indexing.public boolean hasInputBuffer()
public java.lang.String[] getInputBufferAsStringArray() throws AbleException
AbleException
- If the input buffer cannot be converted to an array of
string values.public java.util.Enumeration getInputBufferContents() throws AbleException
AbleException
- If the input buffer cannot be returned as an
enumeration.public void setOutputBuffer(java.lang.Object theOutputBuffer) throws AbleException
theOutputBuffer
- Any object, such as a String[], Vector, Hashtable, and
so on, that can act as a buffer of output data. A
reference to the object is saved; the object is not
cloned. Note that once the output buffer is set,
it must not be tampered with while an AbleBean is
writing data to it.
AbleException
- If an error occurs.public java.lang.Object getOutputBuffer() throws AbleException
AbleException
- If an error occurs.public void setOutputBuffer(int theIndex, java.lang.Object theObject) throws AbleException
theIndex
- The location in the output buffer to be set
to the specified value.
theObject
- The new value of the element at the specified
location.
AbleException
- If the output buffer does not support indexing.public java.lang.Object getOutputBuffer(int theIndex) throws AbleException
theIndex
- The location in the output buffer to be retrieved.
AbleException
- If the output buffer does not support indexing.public boolean hasOutputBuffer()
public java.lang.String[] getOutputBufferAsStringArray() throws AbleException
AbleException
- If the output buffer cannot be converted to an array
of String values.public java.util.Enumeration getOutputBufferContents() throws AbleException
AbleException
- If the output buffer cannot be returned as an
enumeration.public void addSourceBufferConnection(AbleBufferConnection theAbleBufferConnection)
theAbleBufferConnection
- An AbleBufferConnection object including a bean whose output buffer
populates this bean's input buffer.public void removeSourceBufferConnection(AbleBufferConnection theAbleBufferConnection)
theAbleBufferConnection
- The AbleBufferConnection object to be removed.public java.util.Vector getSourceBufferConnections()
public void addDestBufferConnection(AbleBufferConnection theAbleBufferConnection)
theAbleBufferConnection
- An AbleBufferConnection object including a bean whose input
buffer is to be populated from this bean's output buffer.public void removeDestBufferConnection(AbleBufferConnection theAbleBufferConnection)
theAbleBufferConnection
- The AbleBufferConnection object to be removed.public java.util.Vector getDestBufferConnections()
public boolean isConnectable()
public void processBufferConnections() throws AbleException
AbleException
- If an error occurs.public void removeAllBufferConnections()
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |