com.deltaxml.cores9api.config.attributeSplitting

Class AttributeSplittingConfig

java.lang.Object

com.deltaxml.cores9api.config.attributeSplitting.AttributeSplittingConfig

public class AttributeSplittingConfig
extends java.lang.Object

This class specifies configuration options for Attribute Splitting.

Constructor Summary

Constructors

Constructor and Description
AttributeSplittingConfig() Initialises a new empty AttributeSplittingConfig with default AttributeSplittingMode NARRATIVE_TEXT.
AttributeSplittingConfig(boolean enabled) Initialises a new AttributeSplittingConfig setting whether Attribute Splitting is enabled.
AttributeSplittingConfig(boolean enabled, AttributeSplittingMode defaultMode) Initialises a new AttributeSplittingConfig setting whether Attribute Splitting is enabled and its default AttributeSplittingMode.

Method Summary

Modifier and Type	Method and Description
void	addLocation(AttributeLocation attributeLocation) Add a new AttributeLocation to the current list of locations.
AttributeSplittingMode	getDefaultMode() Return the current default AttributeSplittingMode.
java.util.List<AttributeLocation>	getLocations() Returns a List of AttributeLocation's.
boolean	isEnabled() Determines whether Attribute Splitting is enabled.
void	setDefaultMode(AttributeSplittingMode defaultMode) Set the default AttributeSplittingMode.
void	setEnabled(boolean enabled) Sets whether Attribute Splitting is enabled for all attributes.
void	setLocations(java.util.List<AttributeLocation> attributeLocations) Set the List of AttributeLocation instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeSplittingConfig

public AttributeSplittingConfig()

Initialises a new empty AttributeSplittingConfig with default AttributeSplittingMode NARRATIVE_TEXT. Using this constructor will split all attributes in the document using the default settings.

AttributeSplittingConfig

public AttributeSplittingConfig(boolean enabled)

Initialises a new AttributeSplittingConfig setting whether Attribute Splitting is enabled.

Parameters:

enabled - a boolean value to enable or disable Attribute Splitting.

AttributeSplittingConfig

public AttributeSplittingConfig(boolean enabled,
                                AttributeSplittingMode defaultMode)

Initialises a new AttributeSplittingConfig setting whether Attribute Splitting is enabled and its default AttributeSplittingMode.

Parameters:

enabled - a boolean value to enable or disable Attribute Splitting.

defaultMode - a AttributeSplittingMode to use by default.

Throws:

java.lang.IllegalArgumentException - if passed AttributeSplittingMode is null.

Method Detail

getLocations

public java.util.List<AttributeLocation> getLocations()

Returns a List of AttributeLocation's.

Returns:

a List of AttributeLocation's.

setLocations

public void setLocations(java.util.List<AttributeLocation> attributeLocations)

Set the List of AttributeLocation instances.

Parameters:

attributeLocations - a List of AttributeLocation instances.

Throws:

java.lang.IllegalArgumentException - if passed List of AttributeLocation's is invalid.

addLocation

public void addLocation(AttributeLocation attributeLocation)

Add a new AttributeLocation to the current list of locations.

Parameters:

attributeLocation - an AttributeLocation.

Throws:

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

isEnabled

public boolean isEnabled()

Determines whether Attribute Splitting is enabled. This is True by default.

Returns:

a boolean showing whether Attribute Splitting is enabled.

setEnabled

public void setEnabled(boolean enabled)

Sets whether Attribute Splitting is enabled for all attributes. Individual AttributeLocation's may still enable/disable Attribute Splitting for their specified XPaths.

Parameters:

enabled - a boolean value to enable or disable Attribute Splitting.

getDefaultMode

public AttributeSplittingMode getDefaultMode()

Return the current default AttributeSplittingMode.

Returns:

the current default AttributeSplittingMode.

setDefaultMode

public void setDefaultMode(AttributeSplittingMode defaultMode)

Set the default AttributeSplittingMode.

Parameters:

defaultMode - an AttributeSplittingMode value

Throws:

java.lang.IllegalArgumentException - if passed AttributeSplittingMode is null.