com.deltaxml.cores9api

Class FilterStepHelper

java.lang.Object

com.deltaxml.cores9api.FilterStepHelper

public class FilterStepHelper
extends java.lang.Object

Provides a mechanism for creating FilterStep instances. A FilterStepHelper stores a Saxon Processor and a URIResolver, both of which are used in the creation of FilterSteps. If you wish to use different instances of these objects for different FilterStep instances, we would recommend creating multiple instances of a FilterStepHelper.

The simplest, and recommended, way of creating a FilterStepHelper is to call the creation method from PipelinedComparatorS9. This will use the Processor and URIResolver currently in use by the PipelinedComparatorS9 to create FilterStep instances.

Since:

7.0

See Also:

PipelinedComparatorS9.newFilterStepHelper()

Constructor Summary

Constructors

Constructor and Description
FilterStepHelper(net.sf.saxon.s9api.Processor p, org.xml.sax.EntityResolver er, javax.xml.transform.URIResolver ur) Creates a FilterStepHelper using the specified Processor and URIResolver.

Method Summary

Modifier and Type	Method and Description
FilterChain	newFilterChain() Creates a new, empty FilterChain in which to add FilterSteps.
FilterChain	newFilterChain(java.util.List<FilterStep> filterSteps) Create a new FilterChain which is initially made up of the supplied FilterSteps.
FilterChain	newFilterChain(java.lang.String name) Creates a new, empty, named FilterChain in which to add FilterSteps.
FilterStep	newFilterStep(java.lang.Class<? extends org.xml.sax.helpers.XMLFilterImpl> filter, java.lang.String name) Creates a new FilterStep Object from a Class that extends XMLFilterImpl.
FilterStep	newFilterStep(java.io.File filter, java.lang.String name) Creates a new FilterStep Object from a File containing an XSLT stylesheet.
FilterStep	newFilterStep(java.net.URL filter, java.lang.String name) Creates a new FilterStep Object from a URL referencing an XSLT stylesheet.
FilterStep	newFilterStep(org.xml.sax.helpers.XMLFilterImpl filter, java.lang.String name) Creates a FilterStep from an instance of an XMLFilterImpl.
FilterStep	newFilterStep(net.sf.saxon.s9api.XsltExecutable filter, java.lang.String name) Creates a new FilterStep Object from an XsltExecutable.
FilterStep	newFilterStep(net.sf.saxon.s9api.XsltExecutable filter, java.lang.String name, SummarisingErrorListener errorListener) Creates a new FilterStep Object from an XsltExecutable.
FilterStep	newFilterStepFromResource(java.lang.String resource, java.lang.String name) Creates a FilterStep from a resource on the classpath.
FilterChain	newLockedFilterChain(java.util.List<FilterStep> filterSteps, java.lang.String name) Create a new FilterChain which is made up of the supplied FilterSteps and cannot be subsequently modified.
FilterChain	newSingleStepFilterChain(java.lang.Class<? extends org.xml.sax.helpers.XMLFilterImpl> filter, java.lang.String filterName) Creates a new FilterChain containing a single FilterStep from a Class that extends XMLFilterImpl.
FilterChain	newSingleStepFilterChain(java.io.File filter, java.lang.String filterName) Creates a new FilterChain containing a single FilterStep from a File containing an XSLT stylesheet..
FilterChain	newSingleStepFilterChain(java.net.URL filter, java.lang.String filterName) Creates a new FilterChain containing a single FilterStep from a URL referencing an XSLT stylesheet.
FilterChain	newSingleStepFilterChain(org.xml.sax.helpers.XMLFilterImpl filter, java.lang.String filterName) Creates a new FilterChain containing a single FilterStep from an instance of an XMLFilterImpl.
FilterChain	newSingleStepFilterChain(net.sf.saxon.s9api.XsltExecutable filter, java.lang.String filterName) Creates a new FilterChain containing a single FilterStep from an XsltExecutable.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterStepHelper

public FilterStepHelper(net.sf.saxon.s9api.Processor p,
                        org.xml.sax.EntityResolver er,
                        javax.xml.transform.URIResolver ur)
                 throws ParserInstantiationException

Creates a FilterStepHelper using the specified Processor and URIResolver.

N.B. The recommended way of constructing a FilterStepHelper is to use PipelinedComparatorS9.newFilterStepHelper()

Parameters:

p - the Processor to use when creating FilterStep instances

er - the EntityResolver to use when creating FilterStep instances

ur - the URIResolver to use when creating FilterStep instances

Throws:

ParserInstantiationException - if there is an issue creating a parser for use by the FilterStepHelper

Method Detail

newFilterChain

public FilterChain newFilterChain()

Creates a new, empty FilterChain in which to add FilterSteps.

Returns:

an empty FilterChain

newFilterChain

public FilterChain newFilterChain(java.lang.String name)

Creates a new, empty, named FilterChain in which to add FilterSteps.

If you intend to use a FilterChain as a FilterStep within another FilterChain, it should be assigned a name. This constructor enables you to set a name for the FilterChain at the same time as creating it.

Parameters:

name - the name to assign to the FilterChain

Returns:

an empty, named FilterChain

newFilterChain

public FilterChain newFilterChain(java.util.List<FilterStep> filterSteps)
                           throws DuplicateStepNameException,
                                  java.lang.IllegalArgumentException

Create a new FilterChain which is initially made up of the supplied FilterSteps.

The FilterSteps will be ordered in the same order that the supplied List defines.

N.B. If the List is null or empty, an empty FilterChain will be created.

Parameters:

filterSteps - a List of FilterSteps that make up the FilterChain

Returns:

a FilterChain made up of the supplied FilterSteps

Throws:

DuplicateStepNameException - if there is more than one FilterStep with a given name

java.lang.IllegalArgumentException - if the List contains any null entries

newSingleStepFilterChain

public FilterChain newSingleStepFilterChain(java.io.File filter,
                                            java.lang.String filterName)
                                     throws FilterConfigurationException

Creates a new FilterChain containing a single FilterStep from a File containing an XSLT stylesheet..

This helper method can be used to quickly populate a FilterChain with a single step. Please note that it is still possible to add more FilterSteps to the chain.

Parameters:

filter - an instance of a File to use when creating the FilterStep. This must be an XSLT file.

filterName - the name to use for the FilterStep

Returns:

an unnamed FilterChain containing the single FilterStep

Throws:

FilterConfigurationException - if there are problems creating the FilterStep from the XSLT stylesheet. Possible problems include: reading the File, parsing the File, compiling the XSLT.

newSingleStepFilterChain

public FilterChain newSingleStepFilterChain(java.lang.Class<? extends org.xml.sax.helpers.XMLFilterImpl> filter,
                                            java.lang.String filterName)
                                     throws FilterClassInstantiationException

Creates a new FilterChain containing a single FilterStep from a Class that extends XMLFilterImpl.

This helper method can be used to quickly populate a FilterChain with a single step. Please note that it is still possible to add more FilterSteps to the chain.

Parameters:

filter - an instance of a Class that extends XMLFilterImpl to use when creating the FilterStep

filterName - the name to use for the FilterStep

Returns:

an unnamed FilterChain containing the single FilterStep

Throws:

FilterClassInstantiationException - if the supplied Class cannot be instantiated. The underlying cause will give details on the reasons for the Exception

See Also:

FilterStepHelper.newFilterChain(), FilterStepHelper.newFilterStep(Class, String)

newSingleStepFilterChain

public FilterChain newSingleStepFilterChain(java.net.URL filter,
                                            java.lang.String filterName)
                                     throws FilterConfigurationException

Creates a new FilterChain containing a single FilterStep from a URL referencing an XSLT stylesheet.

This helper method can be used to quickly populate a FilterChain with a single step. Please note that it is still possible to add more FilterSteps to the chain.

Parameters:

filter - a URL referencing an XSLT filter to use as the FilterStep

filterName - tthe name to use for the FilterStep

Returns:

an unnamed FilterChain containing the single FilterStep

Throws:

FilterConfigurationException - if there are problems creating the FilterStep from the XSLT stylesheet. Possible problems include: connecting to and reading the URL, parsing the contents of the URL, compiling the XSLT.

See Also:

FilterStepHelper.newFilterChain(), FilterStepHelper.newFilterStep(URL, String)

newSingleStepFilterChain

public FilterChain newSingleStepFilterChain(org.xml.sax.helpers.XMLFilterImpl filter,
                                            java.lang.String filterName)

Creates a new FilterChain containing a single FilterStep from an instance of an XMLFilterImpl.

This helper method can be used to quickly populate a FilterChain with a single step. Please note that it is still possible to add more FilterSteps to the chain.

Parameters:

filter - an XMLFilterImpl instance to use as the basis for the FilterStep

filterName - the name to use for the FilterStep

Returns:

an unnamed FilterChain containing the single FilterStep

See Also:

FilterStepHelper.newFilterChain(), FilterStepHelper.newFilterStep(XMLFilterImpl, String)

newSingleStepFilterChain

public FilterChain newSingleStepFilterChain(net.sf.saxon.s9api.XsltExecutable filter,
                                            java.lang.String filterName)

Creates a new FilterChain containing a single FilterStep from an XsltExecutable.

This helper method can be used to quickly populate a FilterChain with a single step. Please note that it is still possible to add more FilterSteps to the chain.

Parameters:

filter - an XsltExecutable instance to use as the basis for the FilterStep

filterName - the name to use for the FilterStep

Returns:

an unnamed FilterChain containing the single FilterStep

See Also:

FilterStepHelper.newFilterChain(), FilterStepHelper.newFilterStep(XsltExecutable, String)

newLockedFilterChain

public FilterChain newLockedFilterChain(java.util.List<FilterStep> filterSteps,
                                        java.lang.String name)
                                 throws DuplicateStepNameException,
                                        java.lang.IllegalArgumentException

Create a new FilterChain which is made up of the supplied FilterSteps and cannot be subsequently modified. FilterStep parameters can be changed but the FilterSteps that make up the FilterChain cannot be modified.

The FilterSteps will be ordered in the same order that the supplied List defines.

N.B. If the List is null or empty, an empty FilterChain will be created.

Parameters:

filterSteps - a List of FilterSteps that make up the FilterChain

name - a name to assign to the FilterChain if it is being added as a FilterStep

Returns:

a locked FilterChain made up of the supplied FilterSteps

Throws:

DuplicateStepNameException - if there is more than one FilterStep with a given name

java.lang.IllegalArgumentException - if the List contains any null entries

newFilterStep

public FilterStep newFilterStep(java.lang.Class<? extends org.xml.sax.helpers.XMLFilterImpl> filter,
                                java.lang.String name)
                         throws FilterClassInstantiationException

Creates a new FilterStep Object from a Class that extends XMLFilterImpl.

Parameters:

filter - a Class instance that is an extension of XMLFilterImpl

name - the name to assign to the FilterStep

Returns:

a FilterStep containing an instance of the XMLFilterImpl

Throws:

FilterClassInstantiationException - if the supplied Class cannot be instantiated. The underlying cause will give details on the reasons for the Exception

newFilterStep

public FilterStep newFilterStep(java.io.File filter,
                                java.lang.String name)
                         throws FilterConfigurationException

Creates a new FilterStep Object from a File containing an XSLT stylesheet.

Parameters:

filter - a File Object representing an XSLT stylesheet

name - the name to assign to the FilterStep

Returns:

a FilterStep containing a runnable version of the XSLT stylesheet

Throws:

FilterConfigurationException - if there are problems creating the FilterStep from the XSLT stylesheet. Possible problems include: reading the File, parsing the File, compiling the XSLT.

newFilterStep

public FilterStep newFilterStep(java.net.URL filter,
                                java.lang.String name)
                         throws FilterConfigurationException

Creates a new FilterStep Object from a URL referencing an XSLT stylesheet.

Parameters:

filter - a URL Object pointing to an XSLT stylesheet

name - the name to assign to the FilterStep

Returns:

a FilterStep containing a runnable version of the XSLT stylesheet

Throws:

FilterConfigurationException - if there are problems creating the FilterStep from the XSLT stylesheet. Possible problems include: connecting to and reading the URL, parsing the contents of the URL, compiling the XSLT.

newFilterStep

public FilterStep newFilterStep(net.sf.saxon.s9api.XsltExecutable filter,
                                java.lang.String name)

Creates a new FilterStep Object from an XsltExecutable.

Parameters:

filter - the XsltExecutable Object to create the FilterStep from

name - the name to assign to the FilterStep

Returns:

a FilterStep containing the XsltExecutable as its underlying step implementation

newFilterStep

public FilterStep newFilterStep(net.sf.saxon.s9api.XsltExecutable filter,
                                java.lang.String name,
                                SummarisingErrorListener errorListener)

Creates a new FilterStep Object from an XsltExecutable.

Parameters:

filter - the XsltExecutable Object to create the FilterStep from

name - the name to assign to the FilterStep

errorListener - an ErrorListener implementation for processing run-time errors

Returns:

a FilterStep containing the XsltExecutable as its underlying step implementation

newFilterStep

public FilterStep newFilterStep(org.xml.sax.helpers.XMLFilterImpl filter,
                                java.lang.String name)

Creates a FilterStep from an instance of an XMLFilterImpl.

Parameters:

filter - an instance of an Object that extends XMLFilterImpl

name - the name to assign to the FilterStep

Returns:

a FilterStep containing an instance of the XMLFilterImpl

newFilterStepFromResource

public FilterStep newFilterStepFromResource(java.lang.String resource,
                                            java.lang.String name)
                                     throws FilterConfigurationException

Creates a FilterStep from a resource on the classpath.

It must be possible to compile the resource as an XSLT stylesheet.

Parameters:

resource - a String representing the path of the resource

name - the name to assign to the FilterStep

Returns:

a FilterStep containing an underlying compiled XSLT stylesheet representation of the resource

Throws:

FilterConfigurationException - if the resource could not be found, loaded or compiled as an XSLT stylesheet