com.levigo.jadice.server

Class Node

java.lang.Object

com.levigo.jadice.server.internal.NodeInternal

com.levigo.jadice.server.Node

Direct Known Subclasses:

AbstractToXMLNode, DemultiplexerNode, DocumentPrintNode, DummyNode, DynamicPipelineNode, EmbedAttachmentsNode, ExternalProcessCallNode, GhostscriptNode, HTML2TextNode, HTMLRendererNode, JadiceDocumentInfoNode, JadiceServerInfoNode, JadiceToTiffNode, JavamailInputNode, LibreOfficeConversionNode, MailBodyCreatorNode, MessageRFC822Node, MSExcelNode, MSOutlookNode, MSPowerpointNode, MSProjectNode, MSVisioNode, MSWordNode, MultipartAlternativeNode, MultipartAppleDoubleNode, MultipartEncryptedNode, MultipartMixedNode, MultipartRelatedNode, MultipartSignedNode, MultiplexerNode, NotificationNode, NullNode, OLEExtractorNode, PDFAnnotationRemoverNode, PDFCompositeNode, PDFDecryptNode, PDFImageOptimizationNode, PDFMergeNode, PDFMetadataNode, PDFRotationNode, PDFSplitNode, PortableCollectionDisassemblingNode, ReshapeNode, RouterNode, ScriptNode, SeparatorPageNode, StreamAnalysisNode, StreamInputNode, StreamOutputNode, TIFFMergeNode, TIFFSplitNode, TNEFNode, UnGZIPNode, UnRARNode, UnSevenZIPNode, UnTARNode, UnZIPNode, URLInputNode, URLOutputNode, XSLFOFormatterNode, XSLTransformationNode, ZIPNode

public abstract class Node
extends com.levigo.jadice.server.internal.NodeInternal

Nodes represent vertices of the processing node graph. They represent functionality which has to be applied to the processed data, in order to achieve a desired goal. Node processing graphs (sometimes referred to as "pipelines") for a directed graph through which data passes, "visiting" the nodes for processing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Node.Cardinality Cardinality enum for input/output bundles.

Field Summary

Fields inherited from class com.levigo.jadice.server.internal.NodeInternal

limits, subsidiaryNodes

Constructor Summary

Constructors

Constructor and Description
Node()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addTransportReceiver(com.levigo.jadice.server.shared.transport.internal.TransportReceiver receiver) Add a TransportReceiver for this node.
Node	appendSuccessor(Node successor) Append one successor ("child" in tree lingo) to this node.
void	apply(Limit limit) Apply a Limit to this Node.
boolean	equals(Object obj)
Node.Cardinality	getInputCardinality() Return the input cardinality of this node, i.e.
Job	getJob() Get the associated job, or null if the node is not yet initialized.
Node.Cardinality	getOutputCardinality() Return the output cardinality of this node, i.e.
List<Node>	getPredecessors() Get the predecessors ("parents" in tree lingo) to this node.
Set<? extends Node>	getSubsidiaryNodes() Nodes that were created on behalf of this node while executing the job on the server side can be retrieved with this method.
List<Node>	getSuccessors() Get the successors ("children" in tree lingo) of this node.
protected com.levigo.jadice.server.shared.transport.internal.TransportSender	getTransportSender() Return a TransportSender for this node.
String	getUUID() Get the node's UUID.
String	getWorkerClassName() Return the node's associated NodeWorker full qualified class's name.
int	hashCode()
protected void	initialize(CommunicationSide side)
Node	prependPredecessor(Node predecessor) Add a predecessor ("parent" in tree lingo) to this node.
boolean	remove(Limit limit) Remove a previously applied Limit.
protected void	validateConfiguration()

Methods inherited from class com.levigo.jadice.server.internal.NodeInternal

addSubsidiaryNodes, getJobInternal, getLimit, getLimits, getNodeLimits, setNodeLimits

Methods inherited from class java.lang.Object

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

Constructor Detail

Node

public Node()

Method Detail

getSuccessors

public List<Node> getSuccessors()

Get the successors ("children" in tree lingo) of this node.

Returns:

this node's successors

getUUID

public String getUUID()

Get the node's UUID.

Returns:

a UUID

getInputCardinality

public Node.Cardinality getInputCardinality()

Return the input cardinality of this node, i.e. how many bundles (not streams!) it expects to process. By default, nodes are "pipe-style", i.e. one input, one output.

Returns:

input cardinality

getOutputCardinality

public Node.Cardinality getOutputCardinality()

Return the output cardinality of this node, i.e. how many bundles (not streams!) it expects to produce. By default, nodes are "pipe-style", i.e. one input, one output.

Returns:

output cardinality

appendSuccessor

public Node appendSuccessor(Node successor)

Append one successor ("child" in tree lingo) to this node.

Parameters:

successor -

Returns:

the added successor

getWorkerClassName

public String getWorkerClassName()

Return the node's associated NodeWorker full qualified class's name. By default, the worker class name is

• The same as the node name with the trailing "Node" replaced by "Worker" if the node name ends in "Node"
• The node class name with an appended "Worker" otherwise.

The package name of the worker class is the name of the Node's package with an appended ".worker".

This behavior can be overridden in concrete subclasses.

Returns:

the full qualified class name of the worker of this node.

Since:

jadice server 4.2.0.0

prependPredecessor

public Node prependPredecessor(Node predecessor)

Add a predecessor ("parent" in tree lingo) to this node. Since in a tree scenario, a node has at most one parent, we use directed graph terminology here.

Parameters:

predecessor -

Returns:

the added predecessor

getPredecessors

public List<Node> getPredecessors()

Get the predecessors ("parents" in tree lingo) to this node. Since in a tree scenario, a node has at most one parent, we use directed graph terminology here.

Returns:

the added predecessor

getSubsidiaryNodes

public Set<? extends Node> getSubsidiaryNodes()

Nodes that were created on behalf of this node while executing the job on the server side can be retrieved with this method.

Returns:

an unmodifiable view of the subsidiary nodes that were created while job execution

Since:

jadice server 4.3.1.0

getJob

public Job getJob()

Get the associated job, or null if the node is not yet initialized.

Returns:

the associated job

initialize

protected void initialize(CommunicationSide side)

Specified by:

initialize in class com.levigo.jadice.server.internal.NodeInternal

getTransportSender

protected final com.levigo.jadice.server.shared.transport.internal.TransportSender getTransportSender()

Return a TransportSender for this node. The server sided worker can use this to communicate with the client sided node.

Returns:

a TransportSender

addTransportReceiver

protected final void addTransportReceiver(com.levigo.jadice.server.shared.transport.internal.TransportReceiver receiver)

Add a TransportReceiver for this node.

Parameters:

receiver -

validateConfiguration

protected void validateConfiguration()
                              throws ConfigurationException

Specified by:

validateConfiguration in class com.levigo.jadice.server.internal.NodeInternal

Throws:

ConfigurationException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

apply

public void apply(Limit limit)

Apply a Limit to this Node.

Parameters:

limit - The limit to apply

remove

public boolean remove(Limit limit)

Remove a previously applied Limit. This call will have no effect, if the limit has not been applied previously.

Parameters:

limit - the Limit to remove.

Returns:

true iff this limit was registered before.