org.modeshape.sequencer.teiid.model
Class ModelSequencer

java.lang.Object
  org.modeshape.jcr.api.sequencer.Sequencer
      org.modeshape.sequencer.teiid.model.ModelSequencer

public class ModelSequencer
extends Sequencer

A sequencer of Teiid XMI model files.

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.jcr.api.sequencer.Sequencer

Sequencer.Context

Constructor Summary

ModelSequencer()
Constructs a sequencer and an internal reference resolver.

ModelSequencer(ReferenceResolver resolver)

Method Summary

boolean	execute(Property inputProperty, Node outputNode, Sequencer.Context context) Execute the sequencing operation on the specified property, which has recently been created or changed.
boolean	hasModelFileExtension(String resourceName)
void	initialize(NamespaceRegistry registry, NodeTypeManager nodeTypeManager) Initialize the sequencer.
boolean	sequenceVdbModel(InputStream modelStream, Node modelOutputNode, VdbModel vdbModel, Sequencer.Context context) Used only by the VDB sequencer to sequence a model file contained in a VDB.
static boolean	shouldSequence(org.modeshape.sequencer.teiid.model.ModelReader modelReader)

Methods inherited from class org.modeshape.jcr.api.sequencer.Sequencer

getAcceptedMimeTypes, getLogger, getName, getPathExpressions, getRepositoryName, getUniqueId, hasAcceptedMimeTypes, isAccepted, registerDefaultMimeTypes, registerNamespace, registerNodeTypes, registerNodeTypes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModelSequencer

public ModelSequencer()

Constructs a sequencer and an internal reference resolver.

ModelSequencer

public ModelSequencer(ReferenceResolver resolver)

Parameters:

resolver - the reference resolver to use during sequencing (cannot be null)

Method Detail

shouldSequence

public static boolean shouldSequence(org.modeshape.sequencer.teiid.model.ModelReader modelReader)

Parameters:

modelReader - the reader who processed the model file (cannot be null)

Returns:

true if the model process by the reader should be sequenced

execute

public boolean execute(Property inputProperty,
                       Node outputNode,
                       Sequencer.Context context)
                throws Exception

Description copied from class: Sequencer

Execute the sequencing operation on the specified property, which has recently been created or changed.

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:

1. the selected node, in which case the sequencer was configured to generate the output information directly under the selected input node; or
2. a newly created node in a different location than node being sequenced (in this case, the primary type of the new node will be 'nt:unstructured', but the sequencer can easily change that using 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).

Specified by:

execute in class Sequencer

Parameters:

inputProperty - the property that was changed and that should be used as the input; never null

outputNode - 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 node

context - the context in which this sequencer is executing, and which may contain additional parameters useful when generating the output structure; never null

Returns:

true if the sequencer's output should be saved, or false otherwise

Throws:

Exception - if there was a problem with the sequencer that could not be handled. All exceptions will be logged automatically as errors by ModeShape.

See Also:

Sequencer.execute(javax.jcr.Property, javax.jcr.Node, org.modeshape.jcr.api.sequencer.Sequencer.Context)

hasModelFileExtension

public boolean hasModelFileExtension(String resourceName)

Parameters:

resourceName - the name of the resource being checked (cannot be null)

Returns:

true if the resource has a model file extension

initialize

public void initialize(NamespaceRegistry registry,
                       NodeTypeManager nodeTypeManager)
                throws RepositoryException,
                       IOException

Description copied from class: Sequencer

Initialize the sequencer. This is called automatically by ModeShape once for each Sequencer instance, and should not be called by the 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.

Overrides:

initialize in class Sequencer

Parameters:

registry - the namespace registry that can be used to register custom namespaces; never null

nodeTypeManager - the node type manager that can be used to register custom node types; never null

Throws:

RepositoryException - if operations on the NamespaceRegistry or NodeTypeManager fail

IOException - if any stream based operations fail (like importing cnd files)

See Also:

Sequencer.initialize(javax.jcr.NamespaceRegistry, org.modeshape.jcr.api.nodetype.NodeTypeManager)

sequenceVdbModel

public boolean sequenceVdbModel(InputStream modelStream,
                                Node modelOutputNode,
                                VdbModel vdbModel,
                                Sequencer.Context context)
                         throws Exception

Used only by the VDB sequencer to sequence a model file contained in a VDB.

Parameters:

modelStream - the input stream of the model file (cannot be null)

modelOutputNode - the root node of the model being sequenced (cannot be null)

vdbModel - the VDB model associated with the input stream (cannot be null)

context - the sequencer context (cannot be null)

Returns:

true if the model file input stream was successfully sequenced

Throws:

Exception - if there is a problem during sequencing or node does not have a VDB model primary type