org.jboss.dna.graph.sequencers
Interface SequencerContext

All Known Implementing Classes:

SequencerNodeContext

public interface SequencerContext

Author:

John Verhaeg

Method Summary

ValueFactories	getFactories() Get the factories that can be used to create paths and other property values.
Path	getInputPath() Return the path of the input node containing the content being sequenced.
Set<Property>	getInputProperties() Return the set of properties from the input node containing the content being sequenced.
Property	getInputProperty(Name name) Return the property with the supplied name from the input node containing the content being sequenced.
Logger	getLogger(Class<?> clazz) Return a logger associated with this context.
Logger	getLogger(String name) Return a logger associated with this context.
String	getMimeType() Return the MIME-type of the content being sequenced.
NamespaceRegistry	getNamespaceRegistry() Convenience method to get the namespace registry used by the name value factory.

Method Detail

getFactories

ValueFactories getFactories()

Get the factories that can be used to create paths and other property values.

Returns:

the collection of factories; never null.

getInputPath

Path getInputPath()

Return the path of the input node containing the content being sequenced.

Returns:

input node's path.

getInputProperties

Set<Property> getInputProperties()

Return the set of properties from the input node containing the content being sequenced.

Returns:

the input node's properties; never null.

getInputProperty

Property getInputProperty(Name name)

Return the property with the supplied name from the input node containing the content being sequenced.

Parameters:

name -

Returns:

the input node property, or null if none exists.

getMimeType

String getMimeType()

Return the MIME-type of the content being sequenced.

Returns:

the MIME-type

getNamespaceRegistry

NamespaceRegistry getNamespaceRegistry()

Convenience method to get the namespace registry used by the name value factory.

Returns:

the namespace registry; never null.

getLogger

Logger getLogger(Class<?> clazz)

Return a logger associated with this context. This logger records only those activities within the context and provide a way to capture the context-specific activities. All log messages are also sent to the system logger, so classes that log via this mechanism should not also obtain a system logger.

Parameters:

clazz - the class that is doing the logging

Returns:

the logger, named after clazz; never null

See Also:

getLogger(String)

getLogger

Logger getLogger(String name)

Return a logger associated with this context. This logger records only those activities within the context and provide a way to capture the context-specific activities. All log messages are also sent to the system logger, so classes that log via this mechanism should not also obtain a system logger.

Parameters:

name - the name for the logger

Returns:

the logger, named after clazz; never null

See Also:

getLogger(Class)