com.deltaxml.cores9api

Class FilterProcessingSingleException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.api.DeltaXMLException

com.deltaxml.core.PipelinedComparatorException

com.deltaxml.cores9api.PipelinedComparatorS9Exception

com.deltaxml.cores9api.FilterProcessingException

com.deltaxml.cores9api.FilterProcessingSingleException

All Implemented Interfaces:

java.io.Serializable

public class FilterProcessingSingleException
extends FilterProcessingException

An exception indicating a problem when applying a single filter to a pipeline input or output. With a single filter it is possible to report its position relative to the other filters in the chain (its 'aggregate position') and also a representation of its name such as a systemId for a URL, a filename or a classname.

A mechanism is provided to allow parameters to be used to identify XsltExecutable based filters. If the filter declares a parameter with name 'pipelineProgressId' then its value will be reported as the filter source in exceptions.

Since:

6.0

See Also:

PipelineProgressListener, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterProcessingSingleException(java.lang.String message, java.lang.Throwable t, PipelineIOIdentifier locationIdentifier, int filterPosition, java.lang.String filterSrc) Create a new FilterProcessingSingleException.

Method Summary

Modifier and Type	Method and Description
int	getAggregatePosition() Reports the member of a filter aggregate which caused the problem.
java.lang.String	getFilterSource() Provides information about the origins of the filter, for example the file or URL from which the XSLT was loaded.

Methods inherited from class com.deltaxml.cores9api.FilterProcessingException

getLocationId

Methods inherited from class com.deltaxml.api.DeltaXMLException

getCause, getThrowable

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterProcessingSingleException

public FilterProcessingSingleException(java.lang.String message,
                                       java.lang.Throwable t,
                                       PipelineIOIdentifier locationIdentifier,
                                       int filterPosition,
                                       java.lang.String filterSrc)

Create a new FilterProcessingSingleException.

Parameters:

message - the exception error message

t - a nested cause

locationIdentifier - identifier of the filter chain

filterPosition - the filter position

filterSrc - a string representation of the filter

Method Detail

getFilterSource

public java.lang.String getFilterSource()

Provides information about the origins of the filter, for example the file or URL from which the XSLT was loaded.

Returns:

a description of the filter origin

getAggregatePosition

public int getAggregatePosition()

Reports the member of a filter aggregate which caused the problem.

Returns:

an index into a list or array for the erroneous filter