com.deltaxml.cores9api.config.attributeSplitting

Class AttributeLocation

java.lang.Object

com.deltaxml.cores9api.config.attributeSplitting.AttributeLocation

public class AttributeLocation
extends java.lang.Object

This class is used to represent an attribute location by providing an XPath for the attribute. To define an attribute location you must define an XPath which declares what its location is - this is the 'attributeXpath'. You can optionally define an AttributeSplittingMode to use for this location, separators or regex used to tokenize the attribute, output token separator, and finally you can define a value for 'enabled' to toggle attribute splitting for this location

Constructor Summary

Constructors

Constructor and Description
AttributeLocation(java.lang.String attributeXpath) Initialises an new AttributeLocation with an XPath to the attribute.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode, java.lang.Boolean enabled) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode, java.lang.String separator) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode, java.lang.String separator, java.lang.Boolean enabled) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode, java.lang.String separator, java.lang.String outputTokenSeparator) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode, java.lang.String separator, java.lang.String outputTokenSeparator, java.lang.Boolean enabled) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode, java.lang.String separator, java.lang.String outputTokenSeparator, java.lang.String regex) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, AttributeSplittingMode mode, java.lang.String separator, java.lang.String outputTokenSeparator, java.lang.String regex, java.lang.Boolean enabled) Initialises an AttributeLocation with the given parameters.
AttributeLocation(java.lang.String attributeXpath, java.lang.Boolean enabled) Initialises an AttributeLocation with the given parameters.

Method Summary

Modifier and Type	Method and Description
AttributeSplittingMode	getAttributeSplittingMode() Get the AttributeSplittingMode used for this location.
java.lang.String	getAttributeXPath() Return the XPath to the attribute.
java.lang.Boolean	getEnabled() Get whether Attribute Splitting is enabled at this location.
java.lang.String	getOutputTokenSeparator() Get the output token separator to use for this location.
java.lang.String	getRegex() Get the regular expression to use for this location.
java.lang.String	getSeparator() Get the string of separators for this location.
void	setAttributeSplittingMode(AttributeSplittingMode mode) Set the AttributeSplittingMode used for this location.
void	setAttributeXPath(java.lang.String xPath) Change the attribute XPath.
void	setEnabled(java.lang.Boolean enabled) Set whether Attribute Splitting is enabled at this location only.
void	setOutputTokenSeparator(java.lang.String outputTokenSeparator) Set the output token separator to use for this location.
void	setRegex(java.lang.String regex) Set the regular expression to use for this location.
void	setSeparator(java.lang.String separator) Set the separator to use for this location.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath)

Initialises an new AttributeLocation with an XPath to the attribute.

Parameters:

attributeXpath - the XPath to the attribute.

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         java.lang.Boolean enabled)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

enabled - a boolean to enable or disable attribute splitting at this location

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode,
                         java.lang.Boolean enabled)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

enabled - a boolean to enable or disable attribute splitting at this location

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode,
                         java.lang.String separator)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

separator - a string containing one or more separator characters. The attribute value is split at each point in the string that a separator character is encountered.

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode,
                         java.lang.String separator,
                         java.lang.Boolean enabled)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

separator - a string containing one or more separator characters. The attribute value is split at each point in the string that a separator character is encountered.

enabled - a boolean to enable or disable attribute splitting at this location

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode,
                         java.lang.String separator,
                         java.lang.String outputTokenSeparator)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

separator - a string containing one or more separator characters. The attribute value is split at each point in the string that a separator character is encountered.

outputTokenSeparator - a string used to separate tokens in the output

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode,
                         java.lang.String separator,
                         java.lang.String outputTokenSeparator,
                         java.lang.Boolean enabled)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

separator - a string containing one or more separator characters. The attribute value is split at each point in the string that a separator character is encountered.

outputTokenSeparator - a string used to separate tokens in the output

enabled - a boolean to enable or disable attribute splitting at this location

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode,
                         java.lang.String separator,
                         java.lang.String outputTokenSeparator,
                         java.lang.String regex)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

separator - a string containing one or more separator characters. The attribute value is split at each point in the string that a separator character is encountered.

outputTokenSeparator - a string used to separate tokens in the output

regex - this is used to tokenise the attribute value using regular expression syntax.

Throws:

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

AttributeLocation

public AttributeLocation(java.lang.String attributeXpath,
                         AttributeSplittingMode mode,
                         java.lang.String separator,
                         java.lang.String outputTokenSeparator,
                         java.lang.String regex,
                         java.lang.Boolean enabled)

Initialises an AttributeLocation with the given parameters.

Parameters:

attributeXpath - The attribute XPath

mode - an AttributeSplittingMode to use for this location

separator - a string containing one or more separator characters. The attribute value is split at each point in the string that a separator character is encountered.

outputTokenSeparator - a string used to separate tokens in the output

regex - this is used to tokenise the attribute value using regular expression syntax

enabled - a boolean to enable or disable attribute splitting at this location.

Throws:

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

Method Detail

getAttributeXPath

public java.lang.String getAttributeXPath()

Return the XPath to the attribute.

Returns:

string containing the attributes XPath

setAttributeXPath

public void setAttributeXPath(java.lang.String xPath)

Change the attribute XPath.

Parameters:

xPath - string containing the new attribute XPath to use

Throws:

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

getAttributeSplittingMode

public AttributeSplittingMode getAttributeSplittingMode()

Get the AttributeSplittingMode used for this location.

Returns:

an AttributeSplittingMode enum value

setAttributeSplittingMode

public void setAttributeSplittingMode(AttributeSplittingMode mode)

Set the AttributeSplittingMode used for this location.

Parameters:

mode - an AttributeSplittingMode enum value

getSeparator

public java.lang.String getSeparator()

Get the string of separators for this location.

Returns:

a string of separator characters

setSeparator

public void setSeparator(java.lang.String separator)

Set the separator to use for this location.

Parameters:

separator - a string containing one or more separator characters. The attribute value is split at each point in the string that a separator character is encountered.

getRegex

public java.lang.String getRegex()

Get the regular expression to use for this location.

Returns:

a string containing a regular expression. This is used to tokenise the attribute value.

setRegex

public void setRegex(java.lang.String regex)

Set the regular expression to use for this location.

Parameters:

regex - a string containing a regular expression. This is used to tokenise the attribute value.

getOutputTokenSeparator

public java.lang.String getOutputTokenSeparator()

Get the output token separator to use for this location.

Returns:

a string used to separate tokens in the output

setOutputTokenSeparator

public void setOutputTokenSeparator(java.lang.String outputTokenSeparator)

Set the output token separator to use for this location.

Parameters:

outputTokenSeparator - string used to separate tokens in the output

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Set whether Attribute Splitting is enabled at this location only. This will take priority over AttributeSplittingConfig enabled value

Parameters:

enabled - boolean to determine if Attribute Splitting is enabled at this location

getEnabled

public java.lang.Boolean getEnabled()

Get whether Attribute Splitting is enabled at this location.

Returns:

boolean to determine if Attribute Splitting is enabled at this location