org.jboss.dna.repository.sequencers
Class SequencerNodeContext

java.lang.Object
  org.jboss.dna.repository.sequencers.SequencerNodeContext

All Implemented Interfaces:

SequencerContext

@Immutable
public class SequencerNodeContext
extends Object
implements SequencerContext

Contains context information that is passed to stream sequencers, including information about the input node containing the data being sequenced.

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFactories

public ValueFactories getFactories()

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

Specified by:

getFactories in interface SequencerContext

Returns:

the collection of factories; never null.

getInputPath

public Path getInputPath()

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

Specified by:

getInputPath in interface SequencerContext

Returns:

input node's path.

See Also:

SequencerContext.getInputPath()

getInputProperties

public Set<Property> getInputProperties()

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

Specified by:

getInputProperties in interface SequencerContext

Returns:

the input node's properties; never null.

See Also:

SequencerContext.getInputProperties()

getInputProperty

public Property getInputProperty(Name name)

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

Specified by:

getInputProperty in interface SequencerContext

Returns:

the input node property, or null if none exists.

See Also:

SequencerContext.getInputProperty(org.jboss.dna.graph.properties.Name)

getMimeType

public String getMimeType()

Return the MIME-type of the content being sequenced.

Specified by:

getMimeType in interface SequencerContext

Returns:

the MIME-type

See Also:

SequencerContext.getMimeType()

getNamespaceRegistry

public NamespaceRegistry getNamespaceRegistry()

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

Specified by:

getNamespaceRegistry in interface SequencerContext

Returns:

the namespace registry; never null.

getLogger

public 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.

Specified by:

getLogger in interface SequencerContext

Parameters:

clazz - the class that is doing the logging

Returns:

the logger, named after clazz; never null

See Also:

SequencerContext.getLogger(java.lang.Class)

getLogger

public 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.

Specified by:

getLogger in interface SequencerContext

Parameters:

name - the name for the logger

Returns:

the logger, named after clazz; never null

See Also:

SequencerContext.getLogger(java.lang.String)