org.jomc.modlet

Class DefaultModletProcessor

java.lang.Object

org.jomc.modlet.DefaultModletProcessor

All Implemented Interfaces:

ModletProcessor

public class DefaultModletProcessor
extends Object
implements ModletProcessor

Default ModletProcessor implementation.

Since:

1.6

Version:

$JOMC: DefaultModletProcessor.java 4871 2014-02-17 18:00:51Z schulte $

Author:

Christian Schulte

See Also:

ModelContext.processModlets(org.jomc.modlet.Modlets)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLED_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property enabled.
static String	TRANSFORMER_LOCATION_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property transformerLocation.

Constructor Summary

Constructors

Constructor and Description
DefaultModletProcessor() Creates a new DefaultModletProcessor instance.

Method Summary

Methods

Modifier and Type	Method and Description
List<Transformer>	findTransformers(ModelContext context, String location) Searches a given context for transformers.
static int	getDefaultOrdinal() Gets the default ordinal number of the processor.
static String	getDefaultTransformerLocation() Gets the default location searched for transformer resources.
int	getOrdinal() Gets the ordinal number of the processor.
String	getTransformerLocation() Gets the location searched for transformer resources.
static boolean	isDefaultEnabled() Gets a flag indicating the processor is enabled by default.
boolean	isEnabled() Gets a flag indicating the processor is enabled.
Modlets	processModlets(ModelContext context, Modlets modlets) Processes a given list of Modlets with a context.
static void	setDefaultEnabled(Boolean value) Sets the flag indicating the processor is enabled by default.
static void	setDefaultOrdinal(Integer value) Sets the default ordinal number of the processor.
static void	setDefaultTransformerLocation(String value) Sets the default location searched for transformer resources.
void	setEnabled(Boolean value) Sets the flag indicating the processor is enabled.
void	setOrdinal(Integer value) Sets the ordinal number of the processor.
void	setTransformerLocation(String value) Sets the location searched for transformer resources.

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED_ATTRIBUTE_NAME

public static final String ENABLED_ATTRIBUTE_NAME

Constant for the name of the model context attribute backing property enabled.

See Also:

processModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets), ModelContext.getAttribute(java.lang.String), Constant Field Values

TRANSFORMER_LOCATION_ATTRIBUTE_NAME

public static final String TRANSFORMER_LOCATION_ATTRIBUTE_NAME

Constant for the name of the model context attribute backing property transformerLocation.

Since:

1.2

See Also:

processModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets), ModelContext.getAttribute(java.lang.String), Constant Field Values

Constructor Detail

DefaultModletProcessor

public DefaultModletProcessor()

Creates a new DefaultModletProcessor instance.

Method Detail

isDefaultEnabled

public static boolean isDefaultEnabled()

Gets a flag indicating the processor is enabled by default.

The default enabled flag is controlled by system property org.jomc.modlet.DefaultModletProcessor.defaultEnabled holding a value indicating the processor is enabled by default. If that property is not set, the true default is returned.

Returns:

true, if the processor is enabled by default; false, if the processor is disabled by default.

See Also:

isEnabled(), setDefaultEnabled(java.lang.Boolean)

setDefaultEnabled

public static void setDefaultEnabled(Boolean value)

Sets the flag indicating the processor is enabled by default.

Parameters:

value - The new value of the flag indicating the processor is enabled by default or null.

See Also:

isDefaultEnabled()

isEnabled

public final boolean isEnabled()

Gets a flag indicating the processor is enabled.

Returns:

true, if the processor is enabled; false, if the processor is disabled.

See Also:

isDefaultEnabled(), setEnabled(java.lang.Boolean)

setEnabled

public final void setEnabled(Boolean value)

Sets the flag indicating the processor is enabled.

Parameters:

value - The new value of the flag indicating the processor is enabled or null.

See Also:

isEnabled()

getDefaultOrdinal

public static int getDefaultOrdinal()

Gets the default ordinal number of the processor.

The default ordinal number is controlled by system property org.jomc.modlet.DefaultModletProvider.defaultOrdinal holding the default ordinal number of the processor. If that property is not set, the 0 default is returned.

Returns:

The default ordinal number of the processor.

See Also:

setDefaultOrdinal(java.lang.Integer)

setDefaultOrdinal

public static void setDefaultOrdinal(Integer value)

Sets the default ordinal number of the processor.

Parameters:

value - The new default ordinal number of the processor or null.

See Also:

getDefaultOrdinal()

getOrdinal

public final int getOrdinal()

Gets the ordinal number of the processor.

Specified by:

getOrdinal in interface ModletProcessor

Returns:

The ordinal number of the processor.

See Also:

getDefaultOrdinal(), setOrdinal(java.lang.Integer)

setOrdinal

public final void setOrdinal(Integer value)

Sets the ordinal number of the processor.

Parameters:

value - The new ordinal number of the processor or null.

See Also:

getOrdinal()

getDefaultTransformerLocation

public static String getDefaultTransformerLocation()

Gets the default location searched for transformer resources.

The default transformer location is controlled by system property org.jomc.modlet.DefaultModletProcessor.defaultTransformerLocation holding the location to search for transformer resources by default. If that property is not set, the META-INF/jomc-modlet.xsl default is returned.

Returns:

The location searched for transformer resources by default.

See Also:

setDefaultTransformerLocation(java.lang.String)

setDefaultTransformerLocation

public static void setDefaultTransformerLocation(String value)

Sets the default location searched for transformer resources.

Parameters:

value - The new default location to search for transformer resources or null.

See Also:

getDefaultTransformerLocation()

getTransformerLocation

public final String getTransformerLocation()

Gets the location searched for transformer resources.

Returns:

The location searched for transformer resources.

See Also:

getDefaultTransformerLocation(), setTransformerLocation(java.lang.String)

setTransformerLocation

public final void setTransformerLocation(String value)

Sets the location searched for transformer resources.

Parameters:

value - The new location to search for transformer resources or null.

See Also:

getTransformerLocation()

findTransformers

public List<Transformer> findTransformers(ModelContext context,
                                 String location)
                                   throws ModelException

Searches a given context for transformers.

Parameters:

context - The context to search for transformers.

location - The location to search at.

Returns:

The transformers found at location in context or null, if no transformers are found.

Throws:

NullPointerException - if context or location is null.

ModelException - if getting the transformers fails.

processModlets

public Modlets processModlets(ModelContext context,
                     Modlets modlets)
                       throws ModelException

Processes a given list of Modlets with a context.

Specified by:

processModlets in interface ModletProcessor

Parameters:

context - The context to process Modlets with.

modlets - The Modlets currently being processed.

Returns:

The processed Modlets or null.

Throws:

ModelException - if processing Modlets fails.

See Also:

isEnabled(), getTransformerLocation(), findTransformers(org.jomc.modlet.ModelContext, java.lang.String), ENABLED_ATTRIBUTE_NAME, TRANSFORMER_LOCATION_ATTRIBUTE_NAME