Package com.deltaxml.core.config.subtreeProcessing

Class SubtreeProcessingMode

java.lang.Object

com.deltaxml.core.config.subtreeProcessing.SubtreeProcessingMode

public class SubtreeProcessingMode
extends Object

This class configures content processing based on whether file has data or text or both.

Constructor Summary

Constructors

Constructor	Description
SubtreeProcessingMode()	Initialises a new SubtreeProcessingMode with an empty List of Subtree's.
SubtreeProcessingMode(SubtreeMode defaultMode)	Initialises a SubtreeProcessingMode with the given parameters.
SubtreeProcessingMode(SubtreeMode defaultMode, List<Subtree> subtrees)	Initialises a SubtreeProcessingMode with the given parameters.
SubtreeProcessingMode(List<Subtree> subtrees)	Initialises a SubtreeProcessingMode with the given parameters.

Method Summary

Modifier and Type	Method	Description
void	addSubtree(Subtree subtree)	Add a Subtree to the List of Subtree objects.
SubtreeMode	getDefaultMode()	Gets the default mode for subtree processing.
List<Subtree>	getSubtrees()	Gets the List of Subtree objects.
void	setDefaultMode(SubtreeMode defaultType)	Sets the default mode for subtree processing.
void	setSubtrees(List<Subtree> subtrees)	Sets the List of Subtree objects.

Methods inherited from class java.lang.Object

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

Constructor Details

SubtreeProcessingMode

public SubtreeProcessingMode()

Initialises a new SubtreeProcessingMode with an empty List of Subtree's. Default mode is set according to the comparator used for that product. For example, TEXT for DocumentComparator and DATA for DataComparator.

SubtreeProcessingMode

public SubtreeProcessingMode(SubtreeMode defaultMode,
 List<Subtree> subtrees)

Initialises a SubtreeProcessingMode with the given parameters.

Parameters:

defaultMode - default mode TEXT or DATA for the input files.

subtrees - a List of Subtree objects.

Throws:

IllegalArgumentException - if List of Subtree's or SubtreeMode is invalid.

SubtreeProcessingMode

public SubtreeProcessingMode(SubtreeMode defaultMode)

Initialises a SubtreeProcessingMode with the given parameters.

Parameters:

defaultMode - default mode TEXT or DATA for the input files.

Throws:

IllegalArgumentException - if SubtreeMode is null.

SubtreeProcessingMode

public SubtreeProcessingMode(List<Subtree> subtrees)

Initialises a SubtreeProcessingMode with the given parameters.

Parameters:

subtrees - a List of Subtree objects.

Throws:

IllegalArgumentException - if List of Subtree's is invalid.

Method Details

getDefaultMode

public SubtreeMode getDefaultMode()

Gets the default mode for subtree processing.

Returns:

default mode currently set.

setDefaultMode

public void setDefaultMode(SubtreeMode defaultType)

Sets the default mode for subtree processing.

Parameters:

defaultType - default mode TEXT or DATA for the input files.

Throws:

IllegalArgumentException - if SubtreeMode is null.

getSubtrees

public List<Subtree> getSubtrees()

Gets the List of Subtree objects.

Returns:

a List of Subtree objects.

setSubtrees

public void setSubtrees(List<Subtree> subtrees)

Sets the List of Subtree objects.

Parameters:

subtrees - a List of Subtree objects.

Throws:

IllegalArgumentException - if List of Subtree's is invalid.

addSubtree

public void addSubtree(Subtree subtree)

Add a Subtree to the List of Subtree objects.

Parameters:

subtree - a Subtree to be added to the existing List of Subtree objects.

Throws:

IllegalArgumentException - if Subtree is null.