Package com.levigo.jadice.server.documentplatform

Class JadiceDocumentInfoNode

java.lang.Object

com.levigo.jadice.server.internal.NodeInternal

com.levigo.jadice.server.Node

com.levigo.jadice.server.documentplatform.JadiceDocumentInfoNode

public class JadiceDocumentInfoNode
extends Node

This Node is used to gain information about a document. The resulting information is stored as property in the StreamDescriptor of given stream under the key PROPERTY_NAME. The result is an object of the type IDocumentInfo.

As the functionality of this node is based on the jadice document platform only those type of documents are supported that the jadice document platform can load. In any other case the action specified via setUnhandledFormatAction(UnhandledFormatAction) and an event with MessageID JS.DOCP-UNKNOWN_DOCUMENT_FORMAT will be fired.

See Also:

StreamDescriptor.getProperties(), IDocumentInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JadiceDocumentInfoNode.UnhandledFormatAction	Possible action when a given document cannot be analyzed because its format is unknown or not supported by the jadice document platform.

Nested classes/interfaces inherited from class com.levigo.jadice.server.Node

Node.Cardinality

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_NAME	The key under which the result is stored in the stream's descriptor

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

limits, subsidiaryNodes

Constructor Summary

Constructors

Constructor	Description
JadiceDocumentInfoNode()

Method Summary

Modifier and Type	Method	Description
JadiceDocumentInfoNode.UnhandledFormatAction	getUnhandledFormatAction()
String	getWorkerClassName()	Return the node's associated com.levigo.jadice.server.core.NodeWorker full qualified class's name.
void	setUnhandledFormatAction(JadiceDocumentInfoNode.UnhandledFormatAction action)	Set the action to take when a given document has an unknown or unsupported format.

Methods inherited from class com.levigo.jadice.server.Node

addTransportReceiver, appendSuccessor, apply, equals, getInputCardinality, getJob, getOutputCardinality, getPredecessors, getSubsidiaryNodes, getSuccessors, getTransportSender, getUUID, hashCode, initialize, prependPredecessor, remove, validateConfiguration

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

addSubsidiaryNodes, getJobInternal, getLimit, getLimits, getNodeLimits, setJob, setNodeLimits

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME

public static final String PROPERTY_NAME

The key under which the result is stored in the stream's descriptor

Constructor Detail

JadiceDocumentInfoNode

public JadiceDocumentInfoNode()

Method Detail

setUnhandledFormatAction

public void setUnhandledFormatAction(JadiceDocumentInfoNode.UnhandledFormatAction action)

Set the action to take when a given document has an unknown or unsupported format.

Parameters:

action - action to take. Default: JadiceDocumentInfoNode.UnhandledFormatAction.WARN

getUnhandledFormatAction

public JadiceDocumentInfoNode.UnhandledFormatAction getUnhandledFormatAction()

Returns:

The action to take when a given document cannot be analyzed.

getWorkerClassName

public String getWorkerClassName()

Description copied from class: Node

Return the node's associated com.levigo.jadice.server.core.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.

Overrides:

getWorkerClassName in class Node

Returns:

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