public interface Processor extends PropertiedObject, ContentContainerProvider
| Modifier and Type | Method and Description |
|---|---|
void |
flushCache()
Flushes the cache of this object.
|
java.lang.String |
getID()
Returns the ID of this object.
|
DataModel |
getInputDataModel()
Returns the
DataModel coming into this node. |
DataModel |
getOutputDataModel()
Returns the
DataModel output by this node. |
ProcessorDiagram |
getProcessorDiagram()
Returns the
ProcessorDiagram that owns this node. |
ProcessorStream |
getProcessorStream()
Returns the
ProcessorStream that owns this node. |
ProcessorType |
getProcessorType()
Returns the type of the node.
|
java.lang.String |
getTypeName()
Returns the name of this type of node.
|
int |
getXPosition()
Returns the x position offset of the node in the
ProcessorDiagram. |
int |
getYPosition()
Returns the y position offset of the node in the
ProcessorDiagram. |
boolean |
isCacheEnabled()
Returns
true if the cache is enabled, false otherwise. |
boolean |
isCacheFull()
Returns
true if the cache is full, false otherwise. |
boolean |
isInitial()
Returns
true if this is an initial node i.e. one that occurs at the start of a stream. |
boolean |
isInline()
Returns
true if this is an in-line node i.e. one that occurs mid-stream. |
boolean |
isTerminal()
Returns
true if this is a terminal node i.e. one that occurs at the end of a stream. |
ExecutionHandle |
run(java.util.Collection results)
Executes this node synchronously and waits for execution to complete.
|
void |
setCacheEnabled(boolean val)
Enables or disables the cache for this object.
|
void |
setPositionBetween(Processor source,
Processor target)
Sets the position of the node in the
ProcessorDiagram so it is positioned
between the supplied nodes. |
void |
setXYPosition(int x,
int y)
Sets the position of the node in the
ProcessorDiagram. |
getKeyedPropertyKeys, getKeyedPropertyValue, getLabel, getName, getPropertyType, getPropertyValue, getSavedByVersion, getStructuredPropertyDefinition, isKeyedProperty, isProperty, isServerConnectionRequiredProperty, propertyIterator, setKeyedPropertyValue, setLabel, setPropertyValue, setPropertyValues, setPropertyValuesFromgetContainerTagIterator, getContainerTags, getContainerTypeID, getContentContainer, getContentModel, getContentModelTags, putContentContainerjava.lang.String getID()
ProcessorType getProcessorType()
java.lang.String getTypeName()
boolean isInitial()
true if this is an initial node i.e. one that occurs at the start of a stream.true if this is an initial node, false otherwiseisInline(),
isTerminal()boolean isInline()
true if this is an in-line node i.e. one that occurs mid-stream.true if this is an in-line node, false otherwiseisInitial(),
isTerminal()boolean isTerminal()
true if this is a terminal node i.e. one that occurs at the end of a stream.true if this is a terminal node, false otherwiseisInitial(),
isInline()void setCacheEnabled(boolean val)
val - isCacheEnabled(),
flushCache()boolean isCacheEnabled()
true if the cache is enabled, false otherwise.true if the cache is enabled, false otherwisesetCacheEnabled(boolean),
flushCache()boolean isCacheFull()
true if the cache is full, false otherwise.true if the cache is full, false otherwiseflushCache()void flushCache()
setCacheEnabled(boolean),
isCacheEnabled()DataModel getInputDataModel()
DataModel coming into this node.
The result is the output data model of the first predecessor
or an empty data model if there are no predecessors.
This is a convenience function for the common case where a processor has at most one predecessor.
DataModel coming into this nodeDataModelDataModel getOutputDataModel()
DataModel output by this node.DataModel output by this nodeDataModelProcessorStream getProcessorStream()
ProcessorStream that owns this node.ProcessorStream that owns this nodeProcessorDiagram getProcessorDiagram()
ProcessorDiagram that owns this node.ProcessorDiagram that owns this nodeint getXPosition()
ProcessorDiagram.int getYPosition()
ProcessorDiagram.void setXYPosition(int x,
int y)
ProcessorDiagram.x - the x offsety - the y offsetvoid setPositionBetween(Processor source, Processor target)
ProcessorDiagram so it is positioned
between the supplied nodes.source - the predecessortarget - the successorExecutionHandle run(java.util.Collection results) throws OwnerException, ObjectLockedException, ServerConnectionException, SessionException
ExecutionHandle which can be used to access the exit status and any
result from the task. Equivalent to calling:
node.getProcessorStream().runSelected(new Processor[] {node}, results);
results - OwnerException - if there is inconsistent ownershipObjectLockedException - if the owner stream is locked for some reason (for example, it is already executing)ServerConnectionException - if the connection to the server cannot be establishedSessionException - if some other exception occursProcessorStream.runAll(Collection),
ProcessorStream.runSelected(Processor[], Collection)Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.