com.deltaxml.core

Class FilterParameterizationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.api.DeltaXMLException

com.deltaxml.core.PipelinedComparatorException

com.deltaxml.core.FilterParameterizationException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

XPathFilterParameterException

public class FilterParameterizationException
extends PipelinedComparatorException

Thrown to indicate that a filter parameterization problem has been detected.

In order to set parameters on Java filters, they should be coded to provide methods which allow parameter setting. The methods should have a name which is comprised of "set" concatenated with the parameter name and they should take a single String parameter.

A number of issues can arise with the location and invocation of the parameter setting method. The underlying exception is available through getCause() and will typically be one of:

• NoSuchMethodException
• SecurityException
• IllegalAccessException
• InvocationTargetException

Ideally these exceptions should be thrown when parameters are associated with the ParameterizedFilter. However, due to invocation issues they may not be reported until the filter lists are associated with the PipelinedComparator.

See Also:

PipelinedComparator#setInputFilters(java.util.List), PipelinedComparator#setOutputFilters(java.util.List), Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterParameterizationException(java.lang.String message, java.lang.String parameterName) Creates a new FilterParameterizationException.
FilterParameterizationException(java.lang.String message, java.lang.Throwable t, java.lang.String parameterName) Creates a new FilterParameterizationException.
FilterParameterizationException(java.lang.String message, java.lang.Throwable t, java.lang.String parameterName, int aggregatePosition, PipelineIOIdentifier locationId) Creates a new FilterParameterizationException.

Method Summary

Modifier and Type	Method and Description
int	getAggregatePosition() Identifies which filter within a filter chain is causing the problem.
PipelineIOIdentifier	getLocationId() Identifies which filter chain contains the filter causing the problem.
java.lang.String	getParameterName() Provides the name of the parameter that was causing the problem.

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

FilterParameterizationException

public FilterParameterizationException(java.lang.String message,
                                       java.lang.Throwable t,
                                       java.lang.String parameterName)

Creates a new FilterParameterizationException.

Parameters:

message - The exception message String

t - A nested throwable should it have lead to or caused this exception

parameterName - the parameter which is at fault

FilterParameterizationException

public FilterParameterizationException(java.lang.String message,
                                       java.lang.String parameterName)

Creates a new FilterParameterizationException.

Parameters:

message - The exception message String

parameterName - the parameter which is at fault

FilterParameterizationException

public FilterParameterizationException(java.lang.String message,
                                       java.lang.Throwable t,
                                       java.lang.String parameterName,
                                       int aggregatePosition,
                                       PipelineIOIdentifier locationId)

Creates a new FilterParameterizationException.

Parameters:

message - the Exception message String

t - a nested Throwable that caused this Exception

parameterName - the name of the parameter which is at fault

aggregatePosition - the position of the filter within the filter chain

locationId - the filter chain identifier

Since:

6.0

Method Detail

getParameterName

public java.lang.String getParameterName()

Provides the name of the parameter that was causing the problem.

Returns:

the name of the parameter that was to be set

getLocationId

public PipelineIOIdentifier getLocationId()

Identifies which filter chain contains the filter causing the problem.

N.B. This information is only available if the Exception was thrown when using the PipelinedComparatorS9 or DXPConfigurationS9

Returns:

an identifier used to locate the filter chain causing the problem, or null if the information is not available

Since:

6.0

getAggregatePosition

public int getAggregatePosition()

Identifies which filter within a filter chain is causing the problem.

Filters are numbered from zero according to usual Java aggregate conventions.

N.B. This information is only available if the Exception was thrown when using the PipelinedComparatorS9 or DXPConfigurationS9

Returns:

the location of the filter within a filter chain or -1 if the information is not available

Since:

6.0