@ThreadSafe public abstract class AbstractTextSequencer extends Sequencer
This class provides some fundamental capabilities, including the ability to set a comment
marker
, limit the number of lines
to be read from a file, and
provide custom transformations
from the sets of columns to the graph structure.
Sequencer.Context
Constructor and Description |
---|
AbstractTextSequencer() |
Modifier and Type | Method and Description |
---|---|
boolean |
execute(Property inputProperty,
Node outputNode,
Sequencer.Context context)
Execute the sequencing operation on the specified property, which has recently been created or changed.
|
String |
getCommentMarker() |
int |
getMaximumLinesToRead() |
String |
getRowFactoryClassName() |
void |
initialize(NamespaceRegistry registry,
NodeTypeManager nodeTypeManager)
Initialize the sequencer.
|
protected abstract String[] |
parseLine(String row)
Parse the given row into its constituent columns.
|
void |
setCommentMarker(String commentMarker)
Sets the comment marker to use.
|
void |
setMaximumLinesToRead(int maximumLinesToRead)
Sets the maximum number of lines to read.
|
void |
setRowFactoryClassName(String rowFactoryClassName)
Sets the custom row factory class name.
|
getAcceptedMimeTypes, getLogger, getName, getPathExpressions, getRepositoryName, getUniqueId, hasAcceptedMimeTypes, isAccepted, registerDefaultMimeTypes, registerNamespace, registerNodeTypes, registerNodeTypes, toString
public void initialize(NamespaceRegistry registry, NodeTypeManager nodeTypeManager) throws RepositoryException, IOException
Sequencer
By default this method does nothing, so it should be overridden by implementations to do a one-time initialization of any
internal components. For example, sequencers can use the supplied registry
and nodeTypeManager
objects to register custom namesapces and node types required by the generated content.
initialize
in class Sequencer
registry
- the namespace registry that can be used to register custom namespaces; never nullnodeTypeManager
- the node type manager that can be used to register custom node types; never nullRepositoryException
- if operations on the NamespaceRegistry
or NodeTypeManager
failIOException
- if any stream based operations fail (like importing cnd files)public boolean execute(Property inputProperty, Node outputNode, Sequencer.Context context) throws Exception
Sequencer
Each sequencer is expected to process the value of the property, extract information from the value, and write a structured representation (in the form of a node or a subgraph of nodes) using the supplied output node. Note that the output node will either be:
Node.setPrimaryType(String)
)The implementation is expected to always clean up all resources that it acquired, even in the case of exceptions.
Note: This method must be threadsafe: ModeShape will likely invoke this method concurrently in separate threads,
and the method should never modify the state or fields of the Sequencer implementation class. All initialization should be
performed in Sequencer.initialize(NamespaceRegistry, NodeTypeManager)
.
execute
in class Sequencer
inputProperty
- the property that was changed and that should be used as the input; never nulloutputNode
- the node that represents the output for the derived information; never null, and will either be
new
if the output is being placed outside of the selected node, or will not be new when the
output is to be placed on the selected input nodecontext
- the context in which this sequencer is executing, and which may contain additional parameters useful when
generating the output structure; never nullException
- if there was a problem with the sequencer that could not be handled. All exceptions will be logged
automatically as errors by ModeShape.public void setCommentMarker(String commentMarker)
maximum line limitation
.commentMarker
- the string that indicates that the line is a comment and should be ignored; null indicates that there
is no comment markerpublic String getCommentMarker()
public int getMaximumLinesToRead()
public void setMaximumLinesToRead(int maximumLinesToRead)
Comment lines
do not
count towards the number of lines read.maximumLinesToRead
- the maximum number of lines to read; a non-positive number indicates that all lines should be
read and sequenced.public String getRowFactoryClassName()
public void setRowFactoryClassName(String rowFactoryClassName)
rowFactoryClassName
- the fully-qualified class name of the new custom row factory implementation; null indicates that
the default row factory
should be used.Copyright © 2008–2016 JBoss, a division of Red Hat. All rights reserved.