com.ricebridge.xmlman.in
Class SubPathManager

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

public class SubPathManager

extends Object

Handle activation events of sub paths.

For example, the data field paths are sub paths of the record path, and are activated when the record path matches a target element.

Constructor Summary

SubPathManager(String pDocContextPrefix)
Create SubPathManager with specified document context prefix.

Method Summary

List	activate(StartPoint pStartPoint, DocContext pDocContext) Activate the subpaths and pass in the specified StartPoint.
void	addPath(TargetPath pTargetPath) Add a TargetPath as a subpath.
void	complete(EndPoint pEndPoint, DocContext pDocContext) Pass the matching EndPoint to the subpaths.
void	deactivate(DocContext pDocContext) Deactivate the subpaths.
void	setDocContextPrefix(String pDocContextPrefix) Set the document context prefix.
void	setRequiresClear(DocContext pDocContext, boolean pRequiresClear, TargetPath pSource, String pReason) Mark the subpaths to have their data values cleared.
void	setRequiresDeactivation(DocContext pDocContext, boolean pRequiresDeactivation) Mark the subpaths for deactivation.
String	toString() Debugging description.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubPathManager

public SubPathManager(String pDocContextPrefix)

Create SubPathManager with specified document context prefix.

See Also:

setDocContextPrefix(java.lang.String)

Method Detail

addPath

public void addPath(TargetPath pTargetPath)

Add a TargetPath as a subpath.

setDocContextPrefix

public void setDocContextPrefix(String pDocContextPrefix)

Set the document context prefix. This is normally the text of the record Xpath expression.

toString

public String toString()

Debugging description.

activate

public List activate(StartPoint pStartPoint,
                     DocContext pDocContext)

Activate the subpaths and pass in the specified StartPoint.

complete

public void complete(EndPoint pEndPoint,
                     DocContext pDocContext)

Pass the matching EndPoint to the subpaths.

deactivate

public void deactivate(DocContext pDocContext)

Deactivate the subpaths.

setRequiresDeactivation

public void setRequiresDeactivation(DocContext pDocContext,
                                    boolean pRequiresDeactivation)

Mark the subpaths for deactivation.

setRequiresClear

public void setRequiresClear(DocContext pDocContext,
                             boolean pRequiresClear,
                             TargetPath pSource,
                             String pReason)

Mark the subpaths to have their data values cleared.