com.ricebridge.xmlman.in
Class OutPath

java.lang.Object
  com.ricebridge.xmlman.in.OutPath

Direct Known Subclasses:

TestOutPath

public class OutPath

extends Object

Describe an output element structure based on a TargetPath.

Field Summary

static int	CHILD Child part; place as child element of current element.
static int	DESCEND Descendant part; search subtree of all children for a matching element.

Constructor Summary

protected	OutPath() For testing.
	OutPath(TargetPath pTargetPath, boolean pIsRecord) Create new OutPath based on TargetPath.

Method Summary

int	getNumParts() Get the total number of parts.
OutData	getOutData() Get the data field represented by this path.
String	getPartName() Get the name of the current part.
String	getPartName(int pPartIndex) Get the name of the specified part.
int	getPartPosition() Get the preferred position of the current part among elements with the same name.
int	getPartPosition(int pPartIndex) Get the preferred position of the specified part.
int	getPartType() Get the type of the current part: CHILD or DESCEND.
int	getPartType(int pPartIndex) Get the type of the specified part.
boolean	isAbsolute() Indicate that this path is absolute.
boolean	isRecord() Indicate that this path ends with a record element.
boolean	nextPart() get the next path part.
String	toString() Debugging description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CHILD

public static final int CHILD

Child part; place as child element of current element.

See Also:

Constant Field Values

DESCEND

public static final int DESCEND

Descendant part; search subtree of all children for a matching element.

See Also:

Constant Field Values

Constructor Detail

OutPath

public OutPath(TargetPath pTargetPath,
               boolean pIsRecord)

Create new OutPath based on TargetPath.

Parameters:

pTargetPath - TargetPath from parsed XPath expressions

pIsRecord - Indicate that this is a path to the record element

OutPath

protected OutPath()

For testing.

Method Detail

nextPart

public boolean nextPart()

get the next path part.

getPartName

public String getPartName()

Get the name of the current part.

getPartType

public int getPartType()

Get the type of the current part: CHILD or DESCEND.

getPartPosition

public int getPartPosition()

Get the preferred position of the current part among elements with the same name.

getPartName

public String getPartName(int pPartIndex)

Get the name of the specified part.

getPartType

public int getPartType(int pPartIndex)

Get the type of the specified part.

getPartPosition

public int getPartPosition(int pPartIndex)

Get the preferred position of the specified part.

getNumParts

public int getNumParts()

Get the total number of parts.

isRecord

public boolean isRecord()

Indicate that this path ends with a record element.

isAbsolute

public boolean isAbsolute()

Indicate that this path is absolute.

getOutData

public OutData getOutData()

Get the data field represented by this path.

toString

public String toString()

Debugging description.