org.xmldiff.core.config

Class NodeRules

java.lang.Object

org.xmldiff.core.config.NodeRules

public class NodeRules
extends java.lang.Object

Represents node rules.

Since:

0.1

Constructor Summary

Constructors

Constructor and Description
NodeRules()

Method Summary

Modifier and Type	Method and Description
Rule	createNodeRule(java.lang.String ruleID) Create a node rule for a rule id.
Rule	createNodeRule(java.lang.String ruleID, java.lang.String nodeName) Create a node rule for a rule id and a node name.
char	getDefaultComparisonMode() Return the default comparison mode.
Rule	getDefaultRule() Return the default rule.
Rule	getRule(org.mdiutil.xml.tree.XMLNode node) Return the rule associated with an XML node.
Rule	getRuleByID(java.lang.String id) Return the rule for a specified id.
java.util.Map<java.lang.String,Rule>	getRulesByID() Return the map of rules by their rule id.
java.util.Map<java.lang.String,Rule>	getRulesByNodeName() Return the map of rules by node names.
char	getStatus(org.mdiutil.xml.tree.XMLNode leftNode, org.mdiutil.xml.tree.XMLNode rightNode) Return the comparison status between two XML nodes.
boolean	hasRuleByID(java.lang.String id) Return true if there is a rule for a specified id.
boolean	isDescriptionAttribute(java.lang.String nodeName, java.lang.String attrName) Return true if an attribute for a node is considered a description attribute.
void	removeCDATANewLines(boolean removeCDATANewLines) Set the default way CDATA new lines are considered.
void	setCompareCDATA(boolean compareCDATA) Set if by default CDATA content is compared.
void	setDefaultComparisonMode(char defaultComparisonMode) Set the default comparison mode.
void	setNodeNames(Rule rule, java.util.Set<java.lang.String> nodeNames) Sets the node names for a rule.
void	setOrderIsSignificant(boolean orderIsSignificant) Set if by default the ordering of nodes is significant.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeRules

public NodeRules()

Method Detail

getDefaultComparisonMode

public char getDefaultComparisonMode()

Return the default comparison mode.

Returns:

the default comparison mode

See Also:

NodeComparisonMode

getDefaultRule

public Rule getDefaultRule()

Return the default rule. Note that it always exist, even if no defauklt rule has been defined in the configuration XML file.

Returns:

the default rule

getRule

public Rule getRule(org.mdiutil.xml.tree.XMLNode node)

Return the rule associated with an XML node.

Parameters:

node - the XML node

Returns:

the rule

getStatus

public char getStatus(org.mdiutil.xml.tree.XMLNode leftNode,
                      org.mdiutil.xml.tree.XMLNode rightNode)

Return the comparison status between two XML nodes. The status can be:

• Rule.STATUS_IDENTICAL if the nodes are considered identical
• Rule.STATUS_DIFFERENT if the nodes are considered two different nodes
• Rule.STATUS_UPDATED if the nodes are considered to be the same node but their content is updated

Parameters:

leftNode - the left XML node

rightNode - the right XML node

Returns:

the comparison status

setDefaultComparisonMode

public void setDefaultComparisonMode(char defaultComparisonMode)

Set the default comparison mode.

Parameters:

defaultComparisonMode - the default comparison mode

See Also:

NodeComparisonMode

removeCDATANewLines

public void removeCDATANewLines(boolean removeCDATANewLines)

Set the default way CDATA new lines are considered. If true, new lines at the end of CDATA will be removed.

Parameters:

removeCDATANewLines - true if new lines at the end of CDATA will be removed

setCompareCDATA

public void setCompareCDATA(boolean compareCDATA)

Set if by default CDATA content is compared.

Parameters:

compareCDATA - true if CDATA content is compared

setOrderIsSignificant

public void setOrderIsSignificant(boolean orderIsSignificant)

Set if by default the ordering of nodes is significant.

Parameters:

orderIsSignificant - true if the ordering of nodes is significant

getRulesByNodeName

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

Return the map of rules by node names.

Returns:

the map of rules by node names

getRulesByID

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

Return the map of rules by their rule id.

Returns:

the map of rules by their rule id

hasRuleByID

public boolean hasRuleByID(java.lang.String id)

Return true if there is a rule for a specified id.

Parameters:

id - the rule id

Returns:

true if there is a rule for the specified id

getRuleByID

public Rule getRuleByID(java.lang.String id)

Return the rule for a specified id.

Parameters:

id - the rule id

Returns:

the rule

isDescriptionAttribute

public boolean isDescriptionAttribute(java.lang.String nodeName,
                                      java.lang.String attrName)

Return true if an attribute for a node is considered a description attribute.

Parameters:

nodeName - the node name

attrName - the ttribute name

Returns:

true if the attribute is considered a description attribute

setNodeNames

public void setNodeNames(Rule rule,
                         java.util.Set<java.lang.String> nodeNames)

Sets the node names for a rule.

Parameters:

rule - the rule

nodeNames - the node names

createNodeRule

public Rule createNodeRule(java.lang.String ruleID,
                           java.lang.String nodeName)

Create a node rule for a rule id and a node name.

Parameters:

ruleID - the rule id

nodeName - the node name

Returns:

the rule

createNodeRule

public Rule createNodeRule(java.lang.String ruleID)

Create a node rule for a rule id.

Parameters:

ruleID - the rule id

Returns:

the rule