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
. 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.
Modifier and Type | Class and 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.
|
Node.Cardinality
Modifier and Type | Field and Description |
---|---|
static String |
PROPERTY_NAME
The key under which the result is stored in the
stream's descriptor |
Constructor and Description |
---|
JadiceDocumentInfoNode() |
Modifier and Type | Method and Description |
---|---|
JadiceDocumentInfoNode.UnhandledFormatAction |
getUnhandledFormatAction() |
String |
getWorkerClassName()
Return the node's associated
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.
|
addTransportReceiver, appendSuccessor, apply, equals, getInputCardinality, getJob, getOutputCardinality, getPredecessors, getSubsidiaryNodes, getSuccessors, getTransportSender, getUUID, hashCode, initialize, prependPredecessor, remove, validateConfiguration
public static final String PROPERTY_NAME
stream's descriptor
public void setUnhandledFormatAction(JadiceDocumentInfoNode.UnhandledFormatAction action)
action
- action to take. Default: JadiceDocumentInfoNode.UnhandledFormatAction.WARN
public JadiceDocumentInfoNode.UnhandledFormatAction getUnhandledFormatAction()
public String getWorkerClassName()
Node
Return the node's associated
NodeWorker
full qualified class's
name. By default, the worker class name is
This behavior can be overridden in concrete subclasses.
getWorkerClassName
in class Node
Copyright © 2017 levigo holding gmbh. All rights reserved.