com.deltaxml.cores9api.config.subtreeProcessing

Class Subtree

java.lang.Object

com.deltaxml.cores9api.config.subtreeProcessing.Subtree

public class Subtree
extends java.lang.Object

This class configures elements based on how they need to be processed.

Constructor Summary

Constructors

Constructor and Description
Subtree(java.lang.String elemXpath) Initialises a subtree with only an element XPath.
Subtree(java.lang.String elemXpath, java.lang.Boolean ordered) Initialises a subtree with both element XPath and ordered.
Subtree(java.lang.String elemXpath, java.lang.Boolean ordered, java.util.List<ChildAlignment> childAlignments) Initialises a subtree with both element XPath and ordered along with the child alignment list.
Subtree(java.lang.String elemXpath, SubtreeMode mode) Initialises a subtree with both element XPath and mode.
Subtree(java.lang.String elemXpath, SubtreeMode mode, java.lang.Boolean ordered) Initialises a subtree with element XPath, mode and ordered.
Subtree(java.lang.String elemXpath, SubtreeMode mode, java.lang.Boolean ordered, java.util.List<ChildAlignment> childAlignments) Initialises a subtree with element XPath, mode and ordered along with the child alignment list.

Method Summary

Modifier and Type	Method and Description
void	addChildAlignment(ChildAlignment childAlignment) Adds to the list of children alignments.
java.util.List<ChildAlignment>	getChildAlignments() Gets the list of all children alignment specifiers.
java.lang.String	getElemXpath() Gets the Subtree element XPath.
SubtreeMode	getMode() Gets the Subtree element mode.
java.lang.Boolean	isOrdered() Returns the ordered alignment value.
void	setChildAlignments(java.util.List<ChildAlignment> childAlignments) Sets the list for children alignment specifiers.
void	setElemXpath(java.lang.String elemXpath) Sets the element XPath.
void	setMode(SubtreeMode mode) Sets the element mode.
void	setOrdered(java.lang.Boolean ordered) Sets the ordered alignment value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Subtree

public Subtree(java.lang.String elemXpath,
               SubtreeMode mode)

Initialises a subtree with both element XPath and mode.

Parameters:

elemXpath - The XPath string representing the element location.

mode - The SubtreeMode used to identify content type for the subtree.

Throws:

java.lang.IllegalArgumentException - if passed elemXpath is invalid.

Subtree

public Subtree(java.lang.String elemXpath,
               SubtreeMode mode,
               java.lang.Boolean ordered)

Initialises a subtree with element XPath, mode and ordered.

Parameters:

elemXpath - The XPath string representing the element location.

mode - The SubtreeMode used to identify content type for the subtree.

ordered - The boolean where true represents ordered alignment, and false represents unordered alignment.

Throws:

java.lang.IllegalArgumentException - if passed elemXpath is invalid.

Subtree

public Subtree(java.lang.String elemXpath,
               java.lang.Boolean ordered)

Initialises a subtree with both element XPath and ordered.

Parameters:

elemXpath - The XPath string representing the element location.

ordered - The boolean where true represents ordered alignment, and false represents unordered alignment.

Throws:

java.lang.IllegalArgumentException - if passed elemXpath is invalid.

Subtree

public Subtree(java.lang.String elemXpath,
               java.lang.Boolean ordered,
               java.util.List<ChildAlignment> childAlignments)

Initialises a subtree with both element XPath and ordered along with the child alignment list.

Parameters:

elemXpath - The XPath string representing the element location.

ordered - The boolean where true represents ordered alignment, and false represents unordered alignment.

childAlignments - The list of ChildAlignment instances specifying children for alignment.

Throws:

java.lang.IllegalArgumentException - if passed elemXpath is invalid.

Subtree

public Subtree(java.lang.String elemXpath,
               SubtreeMode mode,
               java.lang.Boolean ordered,
               java.util.List<ChildAlignment> childAlignments)

Initialises a subtree with element XPath, mode and ordered along with the child alignment list.

Parameters:

elemXpath - The XPath string representing the element location.

mode - The SubtreeMode used to identify content type for the subtree.

ordered - The boolean where true represents ordered alignment, and false represents unordered alignment.

childAlignments - The list of ChildAlignment instances specifying children for alignment.

Throws:

java.lang.IllegalArgumentException - if passed elemXpath is invalid.

Subtree

public Subtree(java.lang.String elemXpath)

Initialises a subtree with only an element XPath. The mode in which the subtree will be processed is the default mode for the file.

Parameters:

elemXpath - The Subtree element XPath.

Throws:

java.lang.IllegalArgumentException - if passed elemXpath is invalid.

Method Detail

getElemXpath

public java.lang.String getElemXpath()

Gets the Subtree element XPath.

Returns:

An element XPath used to identify the subtree.

setElemXpath

public void setElemXpath(java.lang.String elemXpath)

Sets the element XPath.

Parameters:

elemXpath - An XPath used to identify the subtree.

Throws:

java.lang.IllegalArgumentException - if passed elemXpath is invalid.

getMode

public SubtreeMode getMode()

Gets the Subtree element mode.

Returns:

The SubtreeMode used to identify content type for the subtree.

setMode

public void setMode(SubtreeMode mode)

Sets the element mode.

Parameters:

mode - The SubtreeMode used to identify content type for the subtree.

getChildAlignments

public java.util.List<ChildAlignment> getChildAlignments()

Gets the list of all children alignment specifiers.

Returns:

The list of ChildAlignment instances specifying children for alignment.

setChildAlignments

public void setChildAlignments(java.util.List<ChildAlignment> childAlignments)

Sets the list for children alignment specifiers.

Parameters:

childAlignments - The list of ChildAlignment instances specifying children for alignment.

addChildAlignment

public void addChildAlignment(ChildAlignment childAlignment)

Adds to the list of children alignments.

Parameters:

childAlignment - The ChildAlignment to be added to the existing list of children alignment specifiers.

isOrdered

public java.lang.Boolean isOrdered()

Returns the ordered alignment value.

Returns:

The boolean where true represents ordered alignment, and false represents unordered alignment.

setOrdered

public void setOrdered(java.lang.Boolean ordered)

Sets the ordered alignment value.

Parameters:

ordered - The boolean where true represents ordered alignment, and false represents unordered alignment.