Package org.smooks.engine.resource.config

Class DefaultResourceConfig

java.lang.Object

org.smooks.engine.resource.config.DefaultResourceConfig

All Implemented Interfaces:

ResourceConfig

public class DefaultResourceConfig
extends Object
implements ResourceConfig

Field Summary

Fields inherited from interface org.smooks.api.resource.config.ResourceConfig

DOCUMENT_FRAGMENT_SELECTOR, SELECTOR_NONE

Constructor Summary

Constructors

Constructor	Description
DefaultResourceConfig()	Public default constructor.
DefaultResourceConfig(String selector, Properties namespaces)	Public constructor.
DefaultResourceConfig(String selector, Properties namespaces, String resource)	Public constructor.
DefaultResourceConfig(String selector, Properties namespaces, String profile, String resource)	Public constructor.
DefaultResourceConfig(ResourceConfig resourceConfig)

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ResourceConfigChangeListener resourceConfigChangeListener)	Adds the specified change listener to the list of change listeners.
void	addParameters(ResourceConfig resourceConfig)	Shallow copies parameters from another ResourceConfig and adds them to this ResourceConfig.
ResourceConfig	copy()	Performs a shallow clone of this ResourceConfig.
boolean	equals(Object obj)
protected void	fireChangedEvent()
byte[]	getBytes()	Returns the resource in bytes.
<T> Parameter<T>	getParameter(String name, Class<T> valueClass)	Gets a parameter by name from this ResourceConfig.
int	getParameterCount()	Get the parameter count of this ResourceConfig.
Map<String,Object>	getParameters()	Gets the parameters associated with this ResourceConfig as a Map.
List<Parameter<?>>	getParameters(String name)	Gets all the parameters of this ResourceConfig by name.
Object	getParameterValue(String name)
<T> T	getParameterValue(String name, Class<T> valueClass)	Get the named parameter from this ResourceConfig.
<T> T	getParameterValue(String name, Class<T> valueClass, T defaultValue)	Get value of named parameter from this ResourceConfig.
List<?>	getParameterValues()	Gets all parameter values set of this ResourceConfig.
String	getProfile()	Gets the target profile/s of this ResourceConfig.
ProfileTargetingExpression[]	getProfileTargetingExpressions()	Gets the profile targeting expressions of this ResourceConfig.
String	getResource()	Get the resource for this ResourceConfig.
String	getResourceType()	Get the resource type of this ResourceConfig.
SelectorPath	getSelectorPath()	Gets the selector in its parsed form.
boolean	isInline()	Evaluates whether the resource of this ResourceConfig is defined inline or referenced from a URI.
boolean	isJavaResource()	Evaluates whether this ResourceConfig object references a Java class.
boolean	isSystem()	Evaluates whether this ResourceConfig is for a default resource.
void	removeChangeListener(ResourceConfigChangeListener resourceConfigChangeListener)	Removes the specified change listener from the list of change listeners.
void	removeParameter(String name)	Remove the named parameter this ResourceConfig
<T> Parameter<T>	setParameter(String name, String type, T value)	Adds a parameter with a specified type to this ResourceConfig.
<T> Parameter<T>	setParameter(String name, T value)	Adds a parameter to this ResourceConfig.
<T> void	setParameter(Parameter<T> parameter)	Adds a parameter to this ResourceConfig.
void	setProfile(String profile)	Sets the target profile of this ResourceConfig.
void	setResource(String resource)	Sets the resource of this ResourceConfig.
void	setResourceType(String resourceType)	Sets the resource type (e.g., "class", "xsl", "groovy", etc...)
void	setSelector(String selector, Properties namespaces)	Sets the raw selector of this ResourceConfig.
void	setSelectorPath(SelectorPath selectorPath)	Sets the selector in its parsed form.
void	setSystem(boolean isSystem)	Set this ResourceConfig as a default applied resource.
protected Class<?>	toJavaResource()	Returns the resource as a Java Class instance.
Properties	toProperties()	Creates a Properties instance from the parameters ResourceConfig object.
String	toString()
String	toXml()	Generates an XML'ified description of this resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultResourceConfig

public DefaultResourceConfig()

Public default constructor.

See Also:

#setSelector(String), setProfile(String), setResource(String), setResourceType(String), setParameter(String, Object)

DefaultResourceConfig

public DefaultResourceConfig(String selector,
                             Properties namespaces)

Public constructor.

Parameters:

selector - The selector definition.

See Also:

setProfile(String), setResource(String), setResourceType(String), setParameter(String, Object)

DefaultResourceConfig

public DefaultResourceConfig(ResourceConfig resourceConfig)

DefaultResourceConfig

public DefaultResourceConfig(String selector,
                             Properties namespaces,
                             String resource)

Public constructor.

Parameters:

selector - The selector definition.

resource - The resource.

See Also:

setProfile(String), setResourceType(String), setParameter(String, Object)

DefaultResourceConfig

public DefaultResourceConfig(String selector,
                             Properties namespaces,
                             String profile,
                             String resource)

Public constructor.

Parameters:

selector - The selector definition.

profile - Target Profile(s). Comma separated list of ProfileTargetingExpressions.

resource - The resource.

See Also:

setResourceType(String), setParameter(String, Object)

Method Detail

copy

public ResourceConfig copy()

Description copied from interface: ResourceConfig

Performs a shallow clone of this ResourceConfig.

Specified by:

copy in interface ResourceConfig

Returns:

clone of this >ResourceConfig

addParameters

public void addParameters(ResourceConfig resourceConfig)

Description copied from interface: ResourceConfig

Shallow copies parameters from another ResourceConfig and adds them to this ResourceConfig.

Specified by:

addParameters in interface ResourceConfig

Parameters:

resourceConfig - ResourceConfig to copy parameters from

setSelector

public void setSelector(String selector,
                        Properties namespaces)

Description copied from interface: ResourceConfig

Sets the raw selector of this ResourceConfig.

Specified by:

setSelector in interface ResourceConfig

Parameters:

selector - an expression that defines the target of this resource. Any namespaces must be bound in the namespaces parameter.

namespaces - namespaces bound to prefixes. The property key is the prefix while the value is the namespace.

setResource

public void setResource(String resource)

Description copied from interface: ResourceConfig

Sets the resource of this ResourceConfig. Unless the resource type is set, the resource is assumed to be a Java resource.

Specified by:

setResource in interface ResourceConfig

Parameters:

resource - an identifier for the resource. This could be anything like a path, a name, etc... The meaning of this value is driven by the resource type.

See Also:

ResourceConfig.setResourceType(String)

isInline

public boolean isInline()

Description copied from interface: ResourceConfig

Evaluates whether the resource of this ResourceConfig is defined inline or referenced from a URI.

Note that this method also returns false if the resource is undefined (null).

Specified by:

isInline in interface ResourceConfig

Returns:

true if the resource is defined inline, otherwise false

See Also:

ResourceConfig.setResource(String)

getProfile

public String getProfile()

Description copied from interface: ResourceConfig

Gets the target profile/s of this ResourceConfig.

Specified by:

getProfile in interface ResourceConfig

Returns:

target profile/s

See Also:

ResourceConfig.setProfile(String)

setProfile

public void setProfile(String profile)

Description copied from interface: ResourceConfig

Sets the target profile of this ResourceConfig.

Specified by:

setProfile in interface ResourceConfig

Parameters:

profile - comma-separated list of ProfileTargetingExpressions

See Also:

ResourceConfig.getProfile()

setResourceType

public void setResourceType(String resourceType)

Description copied from interface: ResourceConfig

Sets the resource type (e.g., "class", "xsl", "groovy", etc...)

Specified by:

setResourceType in interface ResourceConfig

Parameters:

resourceType - resource type

See Also:

ResourceConfig.getResourceType(), ResourceConfig.setResource(String)

setSelectorPath

public void setSelectorPath(SelectorPath selectorPath)

Description copied from interface: ResourceConfig

Sets the selector in its parsed form.

Specified by:

setSelectorPath in interface ResourceConfig

Parameters:

selectorPath - selector steps

See Also:

ResourceConfig.setSelector(String, Properties), ResourceConfig.getSelectorPath()

getSelectorPath

public SelectorPath getSelectorPath()

Description copied from interface: ResourceConfig

Gets the selector in its parsed form.

Specified by:

getSelectorPath in interface ResourceConfig

Returns:

selector steps

See Also:

ResourceConfig.setSelector(String, Properties), ResourceConfig.getSelectorPath()

getProfileTargetingExpressions

public ProfileTargetingExpression[] getProfileTargetingExpressions()

Description copied from interface: ResourceConfig

Gets the profile targeting expressions of this ResourceConfig.

Specified by:

getProfileTargetingExpressions in interface ResourceConfig

Returns:

profile targeting expressions

getResource

public String getResource()

Description copied from interface: ResourceConfig

Get the resource for this ResourceConfig.

Specified by:

getResource in interface ResourceConfig

Returns:

resource

See Also:

ResourceConfig.setResource(String)

isSystem

public boolean isSystem()

Description copied from interface: ResourceConfig

Evaluates whether this ResourceConfig is for a default resource.

System resources (e.g. SystemConsumeSerializerVisitor) are applied by default when no other resource is targeting the element.

Specified by:

isSystem in interface ResourceConfig

Returns:

true if this is a default applied resource, otherwise false

See Also:

ResourceConfig.setSystem(boolean)

setSystem

public void setSystem(boolean isSystem)

Description copied from interface: ResourceConfig

Set this ResourceConfig as a default applied resource.

System resources (e.g. SystemConsumeSerializerVisitor) are applied by default when no other resource is targeting the element.

Specified by:

setSystem in interface ResourceConfig

Parameters:

isSystem - whether this ResourceConfig is for a default resource

getResourceType

public String getResourceType()

Description copied from interface: ResourceConfig

Get the resource type of this ResourceConfig.

Determines the type through the following checks (in order):

1. Is it a Java resource. See ResourceConfig.isJavaResource(). If it is, return "class".
2. Is the resource type explicitly set on this configuration. If it is, return the value. Ala the "type" attribute on the resource element on DTD v2.0
3. Return the resource path file extension e.g. "xsl".

Specified by:

getResourceType in interface ResourceConfig

Returns:

resource type

See Also:

ResourceConfig.getResourceType()

setParameter

public <T> Parameter<T> setParameter(String name,
                                     T value)

Description copied from interface: ResourceConfig

Adds a parameter to this ResourceConfig. Multiple parameters with the same names can coexist.

Specified by:

setParameter in interface ResourceConfig

Parameters:

name - parameter name

value - parameter value

Returns:

new parameter added to this ResourceConfig

setParameter

public <T> Parameter<T> setParameter(String name,
                                     String type,
                                     T value)

Description copied from interface: ResourceConfig

Adds a parameter with a specified type to this ResourceConfig. Multiple parameters with the same names can coexist.

Specified by:

setParameter in interface ResourceConfig

Parameters:

name - parameter name

type - parameter type

value - parameter value

Returns:

new parameter added to this ResourceConfig

setParameter

public <T> void setParameter(Parameter<T> parameter)

Description copied from interface: ResourceConfig

Adds a parameter to this ResourceConfig. Multiple parameters with the same names can coexist.

Specified by:

setParameter in interface ResourceConfig

Parameters:

parameter - parameter to add to this ResourceConfig

getParameter

public <T> Parameter<T> getParameter(String name,
                                     Class<T> valueClass)

Description copied from interface: ResourceConfig

Gets a parameter by name from this ResourceConfig. If more than one parameter match the name, the first parameter is returned.

Specified by:

getParameter in interface ResourceConfig

Parameters:

name - name of parameter to get

Returns:

parameter reference, or null if not parameter does not exist

getParameters

public Map<String,Object> getParameters()

Description copied from interface: ResourceConfig

Gets the parameters associated with this ResourceConfig as a Map.

Specified by:

getParameters in interface ResourceConfig

Returns:

parameters represented as a Map where the key is the parameter name and the value is either a parameter or a list of parameters. The value is a list when more than one parameter has the same name

getParameterValues

public List<?> getParameterValues()

Description copied from interface: ResourceConfig

Gets all parameter values set of this ResourceConfig.

Specified by:

getParameterValues in interface ResourceConfig

Returns:

list of all the parameter values

getParameters

public List<Parameter<?>> getParameters(String name)

Description copied from interface: ResourceConfig

Gets all the parameters of this ResourceConfig by name.

Specified by:

getParameters in interface ResourceConfig

Parameters:

name - name of parameter/s to get

Returns:

list of all the parameters that match the given name, or null if not set

getParameterValue

public Object getParameterValue(String name)

Specified by:

getParameterValue in interface ResourceConfig

getParameterValue

public <T> T getParameterValue(String name,
                               Class<T> valueClass)

Description copied from interface: ResourceConfig

Get the named parameter from this ResourceConfig.

Specified by:

getParameterValue in interface ResourceConfig

Parameters:

name - name of parameter to get from this ResourceConfig

valueClass - expected value type of the parameter to get

Returns:

parameter value, or null if not set

getParameterValue

public <T> T getParameterValue(String name,
                               Class<T> valueClass,
                               T defaultValue)

Description copied from interface: ResourceConfig

Get value of named parameter from this ResourceConfig.

Specified by:

getParameterValue in interface ResourceConfig

Parameters:

name - name of parameter to get.

valueClass - expected value type of the parameter to get

defaultValue - default value to be returned if there are no parameters in this ResourceConfig or if the parameter is not defined

Returns:

parameter value, or defaultValue if not defined

getParameterCount

public int getParameterCount()

Description copied from interface: ResourceConfig

Get the parameter count of this ResourceConfig.

Specified by:

getParameterCount in interface ResourceConfig

Returns:

no. of parameters in this ResourceConfig

removeParameter

public void removeParameter(String name)

Description copied from interface: ResourceConfig

Remove the named parameter this ResourceConfig

Specified by:

removeParameter in interface ResourceConfig

Parameters:

name - name of the parameter to be removed

toString

public String toString()

Overrides:

toString in class Object

getBytes

public byte[] getBytes()

Description copied from interface: ResourceConfig

Returns the resource in bytes. If the resource content is not inlined in the configuration, it will be resolved using the URIResourceLocator. That is, the path will be interpreted as a URI. If the resource does not resolve to a stream producing URI, the resource string will be converted to bytes and returned.

Specified by:

getBytes in interface ResourceConfig

Returns:

resource as a byte array, or null if resource path is null or the resource does not exist

toJavaResource

protected Class<?> toJavaResource()

Returns the resource as a Java Class instance.

Returns:

The Java Class instance refered to be this resource configuration, or null if the resource doesn't refer to a Java Class.

isJavaResource

public boolean isJavaResource()

Description copied from interface: ResourceConfig

Evaluates whether this ResourceConfig object references a Java class.

Specified by:

isJavaResource in interface ResourceConfig

Returns:

true if this resource configuration refers to a Java Class resource, otherwise false

addChangeListener

public void addChangeListener(ResourceConfigChangeListener resourceConfigChangeListener)

Description copied from interface: ResourceConfig

Adds the specified change listener to the list of change listeners.

Specified by:

addChangeListener in interface ResourceConfig

Parameters:

resourceConfigChangeListener - ResourceConfigChangeListener instance to add

removeChangeListener

public void removeChangeListener(ResourceConfigChangeListener resourceConfigChangeListener)

Description copied from interface: ResourceConfig

Removes the specified change listener from the list of change listeners.

Specified by:

removeChangeListener in interface ResourceConfig

Parameters:

resourceConfigChangeListener - ResourceConfigChangeListener instance to remove

toXml

public String toXml()

Description copied from interface: ResourceConfig

Generates an XML'ified description of this resource.

Specified by:

toXml in interface ResourceConfig

Returns:

XML'ified description of the resource

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toProperties

public Properties toProperties()

Description copied from interface: ResourceConfig

Creates a Properties instance from the parameters ResourceConfig object.

Specified by:

toProperties in interface ResourceConfig

Returns:

resource config parameter.

fireChangedEvent

protected void fireChangedEvent()