com.deltaxml.cores9api.config.moves

Class MoveDetectionConfig

java.lang.Object

com.deltaxml.cores9api.config.moves.MoveDetectionConfig

public class MoveDetectionConfig
extends java.lang.Object

This class configures move detection.

Constructor Summary

Constructors

Constructor and Description
MoveDetectionConfig() Initialise a MoveDetectionConfig without params.
MoveDetectionConfig(java.util.List<MoveCandidate> moveCandidates) Initialises an unrestricted MoveDetectionConfig with a list of move candidates.
MoveDetectionConfig(MoveDetectionType moveDetectionType, java.util.List<MoveCandidate> moveCandidates) Initialises a MoveDetectionConfig for given parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultNamespace() Get the default namespace in use.
java.util.List<MoveCandidate>	getMoveCandidates() Gets the list of MoveCandidates
MoveDetectionType	getMoveDetectionType() Gets the MoveDetectionType value
boolean	getShowMoveSource() Gets the value for showMoveSource
java.util.Map<java.lang.String,java.lang.String>	getUserNamespaces() Get the user namespaces that are currently set.
boolean	isEnabled() Query if move processing is enabled.
void	setDefaultNamespace(java.lang.String defaultNamespace) Set the default namespace if the input XML files have a default namespace definition.
void	setEnabled(boolean enabled) Enable or disable move processing.
void	setMoveCandidates(java.util.List<MoveCandidate> moveCandidates) Sets the list of MoveCandidates
void	setMoveDetectionType(MoveDetectionType moveDetectionType) Sets the moveDetectionType
void	setShowMoveSource(boolean showMoveSource) Sets showMoveSource
void	setUserNamespaces(java.util.Map<java.lang.String,java.lang.String> userNamespaces) Set any user namespaces required by the input XML files.

Methods inherited from class java.lang.Object

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

Constructor Detail

MoveDetectionConfig

public MoveDetectionConfig()

Initialise a MoveDetectionConfig without params. Will default to unrestricted move detection and an empty list of move candidates.

MoveDetectionConfig

public MoveDetectionConfig(java.util.List<MoveCandidate> moveCandidates)

Initialises an unrestricted MoveDetectionConfig with a list of move candidates.

Parameters:

moveCandidates - A list of MoveCandidate objects.

MoveDetectionConfig

public MoveDetectionConfig(MoveDetectionType moveDetectionType,
                           java.util.List<MoveCandidate> moveCandidates)

Initialises a MoveDetectionConfig for given parameters.

Parameters:

moveDetectionType - Move detection type as defined in the MoveDetectionType enum.

moveCandidates - A list of MoveCandidate objects.

Method Detail

isEnabled

public boolean isEnabled()

Query if move processing is enabled.

Returns:

a boolean where true represents enabled, false represents disabled.

setEnabled

public void setEnabled(boolean enabled)

Enable or disable move processing.

Parameters:

enabled - Set to true to enable and false to disable moves processing.

getMoveCandidates

public java.util.List<MoveCandidate> getMoveCandidates()

Gets the list of MoveCandidates

Returns:

List of MoveCandidates.

setMoveCandidates

public void setMoveCandidates(java.util.List<MoveCandidate> moveCandidates)

Sets the list of MoveCandidates

Parameters:

moveCandidates - The List of MoveCandidates to be set.

getShowMoveSource

public boolean getShowMoveSource()

Gets the value for showMoveSource

Returns:

showMoveSource boolean value.

setShowMoveSource

public void setShowMoveSource(boolean showMoveSource)

Sets showMoveSource

Parameters:

showMoveSource - Boolean value to be set to showMoveSource.

getMoveDetectionType

public MoveDetectionType getMoveDetectionType()

Gets the MoveDetectionType value

Returns:

Move detection type as defined the MoveDetectionType enumeration.

setMoveDetectionType

public void setMoveDetectionType(MoveDetectionType moveDetectionType)

Sets the moveDetectionType

Parameters:

moveDetectionType - Move detection type as defined the MoveDetectionType enumeration.

getDefaultNamespace

public java.lang.String getDefaultNamespace()

Get the default namespace in use.

Returns:

the default namespace if it has been set, else an empty string.

setDefaultNamespace

public void setDefaultNamespace(java.lang.String defaultNamespace)

Set the default namespace if the input XML files have a default namespace definition.

Parameters:

defaultNamespace - A default namespace

getUserNamespaces

public java.util.Map<java.lang.String,java.lang.String> getUserNamespaces()

Get the user namespaces that are currently set.

Returns:

a Map<String, String> that contains pairs of namespace prefix and URL.

setUserNamespaces

public void setUserNamespaces(java.util.Map<java.lang.String,java.lang.String> userNamespaces)

Set any user namespaces required by the input XML files.

Parameters:

userNamespaces - a Map<String, String> containing pairs of namespace prefix and URL definitions. If your inputs contain user namespace definitions then they should be added here to allow any XPaths set in MoveCandidates that refer to elements in namespaces to be validated and work as expected.