com.deltaxml.cores9api

Class FilterStep

java.lang.Object

com.deltaxml.cores9api.FilterStep

Direct Known Subclasses:

FilterChain

public abstract class FilterStep
extends java.lang.Object

Represents a single step in an XML processing pipeline. This abstract class is the supertype for the different implementations of pipeline steps.

FilterStep instances can be chained together in a FilterChain to form an XML processing pipeline through which XML input flows, being transformed in some way by each step.

To create an instance of a FilterStep, use the various createFilterStep methods on FilterStepHelper.

Since:

7.0

See Also:

FilterChain, FilterStepHelper.newFilterStep(Class, String), FilterStepHelper.newFilterStep(java.io.File, String), FilterStepHelper.newFilterStep(java.net.URL, String), FilterStepHelper.newFilterStep(org.xml.sax.helpers.XMLFilterImpl, String), FilterStepHelper.newFilterStep(net.sf.saxon.s9api.XsltExecutable, String)

Constructor Summary

Constructors

Constructor and Description
FilterStep()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getParameterNames() Returns a Set containing all of the parameter names for the FilterStep.
java.lang.Class<?>	getParameterType(java.lang.String parameterName) Returns the Class type of the parameter with the name supplied.
java.lang.String	getParameterTypeName(java.lang.String parameterName) Returns a String representation of the type of a parameter.
java.lang.Object	getParameterValue(java.lang.String parameterName) Returns the Object value of the requested parameter.
java.lang.String	getStepName() Returns the name of the FilterStep.
java.lang.String	getStepSource() Returns a String representation of the underlying source of the FilterStep.
abstract java.lang.Object	getUnderlyingFilter() returns any java instance used to create the FilterStep.
boolean	isEnabled() Returns the enabled state of this FilterStep.
net.sf.saxon.s9api.XdmNode	runStep(net.sf.saxon.s9api.XdmNode input) Run this FilterStep to produce a new XdmNode.
void	setEnabled(boolean value) Sets the enabled state of this FilterStep.
abstract void	setParameterValue(java.lang.String paramName, java.lang.Object value) Sets a parameter on this FilterStep.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterStep

public FilterStep()

Method Detail

setParameterValue

public abstract void setParameterValue(java.lang.String paramName,
                                       java.lang.Object value)
                                throws java.lang.IllegalArgumentException,
                                       FilterParameterizationException

Sets a parameter on this FilterStep.

Parameters:

paramName - the name of the parameter to set

value - the value to set the parameter to

Throws:

java.lang.IllegalArgumentException - if the parameter name is null

FilterParameterizationException - if the parameter name provided is not a valid parameter for this FilterStep or if there is a problem setting the value

getUnderlyingFilter

public abstract java.lang.Object getUnderlyingFilter()

returns any java instance used to create the FilterStep.

Returns:

the underlying filter. This will be either an Object that extends XMLFilterImpl if one was passed in or an XsltExecutable. If a class derived from XMLFilterImpl rather than an instance is used to construct the FilterStep then null will be returned.

runStep

public final net.sf.saxon.s9api.XdmNode runStep(net.sf.saxon.s9api.XdmNode input)
                                         throws FilterProcessingSingleException

Run this FilterStep to produce a new XdmNode.

Parameters:

input - the XdmNode to use as the input for the FilterStep

Returns:

an XdmNode that results from running the step on the input

Throws:

FilterProcessingSingleException - when there is an error during the running of this step

getParameterValue

public java.lang.Object getParameterValue(java.lang.String parameterName)
                                   throws java.lang.IllegalArgumentException,
                                          FilterParameterizationException

Returns the Object value of the requested parameter.

Parameters:

parameterName - the name of the parameter value to return a value for

Returns:

an Object representing the value of the parameter or null

Throws:

java.lang.IllegalArgumentException - if the parameterName is null

FilterParameterizationException - if the parameter does not exist on this FilterStep

getParameterType

public java.lang.Class<?> getParameterType(java.lang.String parameterName)
                                    throws java.lang.IllegalArgumentException,
                                           FilterParameterizationException

Returns the Class type of the parameter with the name supplied.

N.B. The type returned will depend not only on the parameter type but also on the underlying implementation class of the FilterStep. If the step is an XMLFilter implementation, the type will be the Java type required by the implementation class for its set method. However, if the underlying implementation is XSLT based, the type returned may not be specific enough to determine what the xs:type of the parameter is.

Parameters:

parameterName - the name of the parameter for which to return the type information

Returns:

a Class representing the Object type of the parameter value

Throws:

java.lang.IllegalArgumentException - if the parameterName is null

FilterParameterizationException - if the parameter does not exist on this FilterStep

getParameterTypeName

public java.lang.String getParameterTypeName(java.lang.String parameterName)
                                      throws java.lang.IllegalArgumentException,
                                             FilterParameterizationException

Returns a String representation of the type of a parameter.

Parameters:

parameterName - the name of the parameter for which to return the type information

Returns:

a String representation of the parameter type

Throws:

java.lang.IllegalArgumentException - if the parameterName is null

FilterParameterizationException - if the parameter does not exist on this FilterStep

setEnabled

public void setEnabled(boolean value)

Sets the enabled state of this FilterStep.

A FilterStep that is NOT enabled will be skipped when run within a FilterChain.

Parameters:

value - whether the FilterStep should be enabled or not

isEnabled

public boolean isEnabled()

Returns the enabled state of this FilterStep.

Returns:

a boolean stating whether or not this FilterStep is enabled

getParameterNames

public java.util.Set<java.lang.String> getParameterNames()

Returns a Set containing all of the parameter names for the FilterStep.

Returns:

a Set of String objects representing parameter names

getStepName

public java.lang.String getStepName()

Returns the name of the FilterStep.

Returns:

a String representing the name of this FilterStep

getStepSource

public java.lang.String getStepSource()

Returns a String representation of the underlying source of the FilterStep.

This could be a Class name, an Object hashCode, a URL or a File path, depending on which underlying implementation is being used for the FilterStep.

Returns:

a String representing the underlying source of the FilterStep