Rule (xmldiff tool)

java.lang.Object
- org.xmldiff.core.config.Rule

public class Rule
extends java.lang.Object

Represents one node rule.

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`STATUS_DIFFERENT` Identifies the fact that the left and right nodes are different.
`static char`	`STATUS_IDENTICAL` Identifies the fact that the left and right nodes are identical.
`static char`	`STATUS_UPDATED` Identifies the fact that the left and right nodes are updated.

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDescriptionAttribute(java.lang.String attrName)` Add an attribute which is considered as a description attribute for this rule.
`void`	`addExcludedAttribute(java.lang.String attrName)` Add an attribute which is excluded by this rule.
`void`	`addIdentificationAttribute(java.lang.String attrName)` Add an attribute which is managed by this rule.
`RuleRegexReplace`	`createRuleCDATARegexReplace()` Create the regex replacement rule for the CDATA content.
`RuleRegexReplace`	`createRuleDescriptionRegexReplace()` Create the regex replacement rule for the description attributes.
`boolean`	`equals(org.mdiutil.xml.tree.XMLNode node1, org.mdiutil.xml.tree.XMLNode node2)` Return true if two nodes are considered equal.
`char`	`getCDATATrimType()` Return the type of trim on on CDATA content.
`char`	`getComparisonMode()` Return the comparison mode.
`java.util.Set<java.lang.String>`	`getDescriptionAttributes()` Return the attributes which are considered as description attributes by this rule.
`char`	`getDescriptionTrimType()` Return the type of trim on description attributes.
`java.util.Set<java.lang.String>`	`getExcludedAttributes()` Return the attributes which are excluded by this rule.
`java.lang.String`	`getID()` Return the rule id.
`java.util.Set<java.lang.String>`	`getIdentificationAttributes()` Return the attributes which are managed by this rule.
`RuleRegexReplace`	`getRuleCDATARegexReplace()` Return the regex replacement rule for the CDATA content.
`RuleRegexReplace`	`getRuleDescriptionRegexReplace()` Return the regex replacement rule for the description attributes.
`char`	`getStatus(org.mdiutil.xml.tree.XMLNode leftNode, org.mdiutil.xml.tree.XMLNode rightNode)` Return the status of attributes comparisons for this rule.
`boolean`	`hasRuleCDATARegexReplace()` Return true if there is the regex replacement rule for the CDATA content.
`boolean`	`hasRuleDescriptionRegexReplace()` Return true if there is the regex replacement rule for the description attributes.
`boolean`	`isComparingCDATA()` Return true if CDATA content is compared.
`boolean`	`isDescriptionAttribute(java.lang.String attrName)` Return true if an attribute is considered as a description attribute for this rule.
`boolean`	`isKeepingCDATANewLines()` Return true if new lines at the end of CDATA will be kept.
`boolean`	`isOrderSignificant()` Return true if the ordering of nodes is significant.
`boolean`	`isRemovingDescriptionNewLines()` Return true if new lines at the end of description attributes will be removed.
`void`	`removeCDATANewLines(boolean keepCDATANewLines)` Set the way CDATA new lines are considered.
`void`	`removeDescriptionNewLines(boolean removeDescriptionNewLines)` Set the way CDATA new lines are considered.
`void`	`setCDATATrimType(char trimType)` Set the type of trim on CDATA content.
`void`	`setCompareCDATA(boolean compareCDATA)` Set if CDATA content is compared.
`void`	`setComparisonMode(char comparisonMode)` Set the comparison mode.
`void`	`setDescriptionTrimType(char trimType)` Set the type of trim on description attributes.
`void`	`setID(java.lang.String id)` Set the rule id.
`void`	`setOrderIsSignificant(boolean orderIsSignificant)` Set if the ordering of nodes is significant.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATUS_IDENTICAL
```
public static final char STATUS_IDENTICAL
```
    Identifies the fact that the left and right nodes are identical.
    
    See Also:
    
    Constant Field Values
  - STATUS_DIFFERENT
```
public static final char STATUS_DIFFERENT
```
    Identifies the fact that the left and right nodes are different.
    
    See Also:
    
    Constant Field Values
  - STATUS_UPDATED
```
public static final char STATUS_UPDATED
```
    Identifies the fact that the left and right nodes are updated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setID
```
public void setID(java.lang.String id)
```
    Set the rule id.
    
    Parameters:
    
    id - the id
  - getID
```
public java.lang.String getID()
```
    Return the rule id.
    
    Returns:
    
    the id
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setCompareCDATA
```
public void setCompareCDATA(boolean compareCDATA)
```
    Set if CDATA content is compared.
    
    Parameters:
    
    compareCDATA - true if CDATA content is compared
  - isComparingCDATA
```
public boolean isComparingCDATA()
```
    Return true if CDATA content is compared.
    
    Returns:
    
    true if CDATA content is compared
  - setOrderIsSignificant
```
public void setOrderIsSignificant(boolean orderIsSignificant)
```
    Set if the ordering of nodes is significant.
    
    Parameters:
    
    orderIsSignificant - true if the ordering of nodes is significant
  - isOrderSignificant
```
public boolean isOrderSignificant()
```
    Return true if the ordering of nodes is significant.
    
    Returns:
    
    true if the ordering of nodes is significant
  - removeCDATANewLines
```
public void removeCDATANewLines(boolean keepCDATANewLines)
```
    Set the way CDATA new lines are considered. If true, new lines at the end of CDATA will be kept.
    
    Parameters:
    
    keepCDATANewLines - true if new lines at the end of CDATA will be kept
  - isKeepingCDATANewLines
```
public boolean isKeepingCDATANewLines()
```
    Return true if new lines at the end of CDATA will be kept.
    
    Returns:
    
    true if new lines at the end of CDATA will be kept
  - removeDescriptionNewLines
```
public void removeDescriptionNewLines(boolean removeDescriptionNewLines)
```
    Set the way CDATA new lines are considered. If true, new lines at the end of description attributes will be removed.
    
    Parameters:
    
    removeDescriptionNewLines - true if new lines at the end of description attributes will be removed
  - isRemovingDescriptionNewLines
```
public boolean isRemovingDescriptionNewLines()
```
    Return true if new lines at the end of description attributes will be removed.
    
    Returns:
    
    true if new lines at the end of description attributes will be removed
  - setDescriptionTrimType
```
public void setDescriptionTrimType(char trimType)
```
    Set the type of trim on description attributes.
    
    Parameters:
    
    trimType - the type of trim
  - getDescriptionTrimType
```
public char getDescriptionTrimType()
```
    Return the type of trim on description attributes.
    
    Returns:
    
    the type of trim
  - setCDATATrimType
```
public void setCDATATrimType(char trimType)
```
    Set the type of trim on CDATA content.
    
    Parameters:
    
    trimType - the type of trim
  - getCDATATrimType
```
public char getCDATATrimType()
```
    Return the type of trim on on CDATA content.
    
    Returns:
    
    the type of trim
  - setComparisonMode
```
public void setComparisonMode(char comparisonMode)
```
    Set the comparison mode.
    
    Parameters:
    
    comparisonMode - the comparison mode
    
    See Also:
    
    NodeComparisonMode
  - getComparisonMode
```
public char getComparisonMode()
```
    Return the comparison mode.
    
    Returns:
    
    the comparison mode
    
    See Also:
    
    NodeComparisonMode
  - getIdentificationAttributes
```
public java.util.Set<java.lang.String> getIdentificationAttributes()
```
    Return the attributes which are managed by this rule.
    
    Returns:
    
    the attributes names
  - addIdentificationAttribute
```
public void addIdentificationAttribute(java.lang.String attrName)
```
    Add an attribute which is managed by this rule.
    
    Parameters:
    
    attrName - the attribute name
  - getExcludedAttributes
```
public java.util.Set<java.lang.String> getExcludedAttributes()
```
    Return the attributes which are excluded by this rule.
    
    Returns:
    
    the attributes names
  - addExcludedAttribute
```
public void addExcludedAttribute(java.lang.String attrName)
```
    Add an attribute which is excluded by this rule.
    
    Parameters:
    
    attrName - the attribute name
  - addDescriptionAttribute
```
public void addDescriptionAttribute(java.lang.String attrName)
```
    Add an attribute which is considered as a description attribute for this rule.
    
    Parameters:
    
    attrName - the attribute name
  - getDescriptionAttributes
```
public java.util.Set<java.lang.String> getDescriptionAttributes()
```
    Return the attributes which are considered as description attributes by this rule.
    
    Returns:
    
    the attributes names
  - isDescriptionAttribute
```
public boolean isDescriptionAttribute(java.lang.String attrName)
```
    Return true if an attribute is considered as a description attribute for this rule.
    
    Parameters:
    
    attrName - the attribute name
    
    Returns:
    
    rue if an attribute is considered as a description attribute
  - getStatus
```
public char getStatus(org.mdiutil.xml.tree.XMLNode leftNode,
                      org.mdiutil.xml.tree.XMLNode rightNode)
```
    Return the status of attributes comparisons for this rule. The status can be:
    - STATUS_IDENTICAL if the nodes are considered identical
    - STATUS_DIFFERENT if the nodes are considered two different nodes
    - 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 status
  - equals
```
public boolean equals(org.mdiutil.xml.tree.XMLNode node1,
                      org.mdiutil.xml.tree.XMLNode node2)
```
    Return true if two nodes are considered equal.
    
    Parameters:
    
    node1 - the first node
    
    node2 - the second node
    
    Returns:
    
    true if the two nodes are considered equal
  - createRuleDescriptionRegexReplace
```
public RuleRegexReplace createRuleDescriptionRegexReplace()
```
    Create the regex replacement rule for the description attributes. It will only create it if it does not exist.
    
    Returns:
    
    the regex replacement rule
  - getRuleDescriptionRegexReplace
```
public RuleRegexReplace getRuleDescriptionRegexReplace()
```
    Return the regex replacement rule for the description attributes.
    
    Returns:
    
    the regex replacement rule
  - hasRuleDescriptionRegexReplace
```
public boolean hasRuleDescriptionRegexReplace()
```
    Return true if there is the regex replacement rule for the description attributes.
    
    Returns:
    
    true if there is the regex replacement
  - createRuleCDATARegexReplace
```
public RuleRegexReplace createRuleCDATARegexReplace()
```
    Create the regex replacement rule for the CDATA content. It will only create it if it does not exist.
    
    Returns:
    
    the regex replacement rule
  - getRuleCDATARegexReplace
```
public RuleRegexReplace getRuleCDATARegexReplace()
```
    Return the regex replacement rule for the CDATA content.
    
    Returns:
    
    the regex replacement rule
  - hasRuleCDATARegexReplace
```
public boolean hasRuleCDATARegexReplace()
```
    Return true if there is the regex replacement rule for the CDATA content.
    
    Returns:
    
    true if there is the regex replacement

Class Rule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_IDENTICAL

STATUS_DIFFERENT

STATUS_UPDATED

Constructor Detail

Rule

Method Detail

setID

getID

toString

setCompareCDATA

isComparingCDATA

setOrderIsSignificant

isOrderSignificant

removeCDATANewLines

isKeepingCDATANewLines

removeDescriptionNewLines

isRemovingDescriptionNewLines

setDescriptionTrimType

getDescriptionTrimType

setCDATATrimType

getCDATATrimType

setComparisonMode

getComparisonMode

getIdentificationAttributes

addIdentificationAttribute

getExcludedAttributes

addExcludedAttribute

addDescriptionAttribute

getDescriptionAttributes

isDescriptionAttribute

getStatus

equals

createRuleDescriptionRegexReplace

getRuleDescriptionRegexReplace

hasRuleDescriptionRegexReplace

createRuleCDATARegexReplace

getRuleCDATARegexReplace

hasRuleCDATARegexReplace