com.deltaxml.cores9api

Interface PipelineLocationEntry

public interface PipelineLocationEntry

The location of an entry in a comparator pipeline.

A location essentially contains a unique path to a filter (or other processing stage) in a comparator's pipeline. Its string representation is of the following form:

<name> ('/' <pos> '-' <name>)*

where the names and zero-based sibling positions of each of this entry's ancestors is pre-pended to this entry.

For example, the path 'result/4-my-post-processing/2-ignore-whitespace-changes' says that the ignore-whitespace-changes entry, is the third entry of the my-post-processing subchain, which is the fifth entry in the result processing chain.

Method Summary

Modifier and Type	Method and Description
int	getDepth() The depth of the current entry; the number of parents plus one.
java.lang.String	getName() The name of the entry.
PipelineLocationEntry	getParent() The entry's parent or containing entry.
int	getPosition() The position of this entry within its parent.
java.lang.String	getSource() The optional source code location of the entry.
java.lang.String	toString() The path of the entry.

Method Detail

getParent

PipelineLocationEntry getParent()

The entry's parent or containing entry.

Returns:

the parent of the current entry, or null if this entry has no parent.

getPosition

int getPosition()
         throws java.util.NoSuchElementException

The position of this entry within its parent.

Returns:

the position of this entry within its parent.

Throws:

java.util.NoSuchElementException - when there is no parent entry.

getDepth

int getDepth()

The depth of the current entry; the number of parents plus one.

Returns:

the depth of the current entry; the number of parents plus one.

getName

java.lang.String getName()

The name of the entry.

Returns:

the entry's name.

getSource

java.lang.String getSource()

The optional source code location of the entry.

Returns:

the source location of the entry, or null if no source is set.

toString

java.lang.String toString()

The path of the entry. The string representation of a location is of the following form:

<name> ('/' <pos> '-' <name>)*

where the names and zero-based sibling positions of each of this entry's ancestors is pre-pended to this entry.

For example, the path ' result/4-my-post-processing/2-ignore-whitespace-changes' says that the ignore-whitespace-changes entry, is the third entry of the my-post-processing subchain, which is the fifth entry in the result processing chain.

Overrides:

toString in class java.lang.Object

Returns:

the entry's path.