dom4j 2.1.4 · org.dom4j.rule.Rule

Modifier and Type	Field and Description
private Action	action Holds value of property action.
private int	appearenceCount Holds value of property appearenceCount.
private int	importPrecedence Holds value of property importPrecedence.
private String	mode Holds value of property mode.
private Pattern	pattern Holds value of property pattern.
private double	priority Holds value of property priority.

Access	Constructor and Description
public	Rule()
public	Rule(Pattern pattern)
public	Rule(Pattern pattern, Action action)
public	Rule(Rule DOCUMENT ME! that, Pattern DOCUMENT ME! pattern) Constructs a new Rule with the same instance data as the given rule but a different pattern.

Method Summary

Modifier and Type	Method and Description
private static int	compareInt(int value1, int value2)
public int	Returns: DOCUMENT ME! compareTo(Rule DOCUMENT ME! that) Implements java.lang.Comparable.compareTo. Compares two rules in XSLT processing model order assuming that the modes are equal.
public boolean	equals(Object the reference object with which to compare. that) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Action	Returns: Value of property action. getAction() Getter for property action.
public int	Returns: Value of property appearenceCount. getAppearenceCount() Getter for property appearenceCount.
public int	Returns: Value of property importPrecedence. getImportPrecedence() Getter for property importPrecedence.
public final String	Returns: the name of the element or attribute this pattern matches or null if this pattern matches any or more than one name. getMatchesNodeName() For patterns which only match an ATTRIBUTE_NODE or an ELEMENT_NODE then this pattern may return the name of the element or attribute it matches.
public final short	Returns: the type of node the pattern matches which by default should return ANY_NODE if it can match any kind of node. getMatchType() DOCUMENT ME!
public String	Returns: Value of property mode. getMode() Getter for property mode.
public Pattern	Returns: Value of property pattern. getPattern() Getter for property pattern.
public double	Returns: Value of property priority. getPriority() Getter for property priority.
public Rule[]	Returns: an array of the rules which make up this union rule or null if this rule is not a union rule getUnionRules() If this rule contains a union pattern then this method should return an array of Rules which describe the union rule, which should contain more than one rule.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public final boolean	Returns: true if the pattern matches the given DOM4J node. matches(Node DOCUMENT ME! node) DOCUMENT ME!
public void	setAction(Action New value of property action. action) Setter for property action.
public void	setAppearenceCount(int New value of property appearenceCount. appearenceCount) Setter for property appearenceCount.
public void	setImportPrecedence(int New value of property importPrecedence. importPrecedence) Setter for property importPrecedence.
public void	setMode(String New value of property mode. mode) Setter for property mode.
public void	setPattern(Pattern New value of property pattern. pattern) Setter for property pattern.
public void	setPriority(double New value of property priority. priority) Setter for property priority.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

action	back to summary
private Action action Holds value of property action.

appearenceCount	back to summary
private int appearenceCount Holds value of property appearenceCount.

importPrecedence	back to summary
private int importPrecedence Holds value of property importPrecedence.

mode	back to summary
private String mode Holds value of property mode.

pattern	back to summary
private Pattern pattern Holds value of property pattern.

priority	back to summary
private double priority Holds value of property priority.

Rule	back to summary
public Rule()

Rule	back to summary
public Rule(Pattern pattern)

Rule	back to summary
public Rule(Pattern pattern, Action action)

Rule	back to summary
public Rule(Rule that, Pattern pattern) Constructs a new Rule with the same instance data as the given rule but a different pattern. Parameters that:Rule DOCUMENT ME! pattern:Pattern DOCUMENT ME!

Method Detail

compareInt	back to summary
private static int compareInt(int value1, int value2)

compareTo	back to summary
public int compareTo(Rule that) Implements java.lang.Comparable.compareTo. Compares two rules in XSLT processing model order assuming that the modes are equal. Parameters that:Rule DOCUMENT ME! Returns:int DOCUMENT ME!

compareTo

back to summary

public int compareTo(Rule that)

Implements java.lang.Comparable.compareTo.

Compares two rules in XSLT processing model order assuming that the modes are equal.

Parameters

that:Rule: DOCUMENT ME!

Returns:int

DOCUMENT ME!

equals back to summary

equals	back to summary
public boolean equals(Object that) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters that:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object that)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

that:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getAction	back to summary
public Action getAction() Getter for property action. Returns:Action Value of property action.

getAction

back to summary

public Action getAction()

Getter for property action.

Returns:Action: Value of property action.

getAppearenceCount	back to summary
public int getAppearenceCount() Getter for property appearenceCount. Returns:int Value of property appearenceCount.

getAppearenceCount

back to summary

public int getAppearenceCount()

Getter for property appearenceCount.

Returns:int: Value of property appearenceCount.

getImportPrecedence	back to summary
public int getImportPrecedence() Getter for property importPrecedence. Returns:int Value of property importPrecedence.

getImportPrecedence

back to summary

public int getImportPrecedence()

Getter for property importPrecedence.

Returns:int: Value of property importPrecedence.

getMatchesNodeName	back to summary
public final String getMatchesNodeName() For patterns which only match an ATTRIBUTE_NODE or an ELEMENT_NODE then this pattern may return the name of the element or attribute it matches. This allows a more efficient rule matching algorithm to be performed, rather than a brute force approach of evaluating every pattern for a given Node. Returns:String the name of the element or attribute this pattern matches or null if this pattern matches any or more than one name.

getMatchesNodeName

back to summary

public final String getMatchesNodeName()

For patterns which only match an ATTRIBUTE_NODE or an ELEMENT_NODE then this pattern may return the name of the element or attribute it matches. This allows a more efficient rule matching algorithm to be performed, rather than a brute force approach of evaluating every pattern for a given Node.

Returns:String: the name of the element or attribute this pattern matches or null if this pattern matches any or more than one name.

getMatchType	back to summary
public final short getMatchType() DOCUMENT ME! Returns:short the type of node the pattern matches which by default should return ANY_NODE if it can match any kind of node.

getMatchType

back to summary

public final short getMatchType()

DOCUMENT ME!

Returns:short: the type of node the pattern matches which by default should return ANY_NODE if it can match any kind of node.

getMode	back to summary
public String getMode() Getter for property mode. Returns:String Value of property mode.

getMode

back to summary

public String getMode()

Getter for property mode.

Returns:String: Value of property mode.

getPattern	back to summary
public Pattern getPattern() Getter for property pattern. Returns:Pattern Value of property pattern.

getPattern

back to summary

public Pattern getPattern()

Getter for property pattern.

Returns:Pattern: Value of property pattern.

getPriority	back to summary
public double getPriority() Getter for property priority. Returns:double Value of property priority.

getPriority

back to summary

public double getPriority()

Getter for property priority.

Returns:double: Value of property priority.

getUnionRules	back to summary
public Rule[] getUnionRules() If this rule contains a union pattern then this method should return an array of Rules which describe the union rule, which should contain more than one rule. Otherwise this method should return null. Returns:Rule[] an array of the rules which make up this union rule or null if this rule is not a union rule

getUnionRules

back to summary

public Rule[] getUnionRules()

If this rule contains a union pattern then this method should return an array of Rules which describe the union rule, which should contain more than one rule. Otherwise this method should return null.

Returns:Rule[]: an array of the rules which make up this union rule or null if this rule is not a union rule

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object.

matches	back to summary
public final boolean matches(Node node) DOCUMENT ME! Parameters node:Node DOCUMENT ME! Returns:boolean true if the pattern matches the given DOM4J node.

matches

back to summary

public final boolean matches(Node node)

DOCUMENT ME!

Parameters

node:Node: DOCUMENT ME!

Returns:boolean

true if the pattern matches the given DOM4J node.

setAction	back to summary
public void setAction(Action action) Setter for property action. Parameters action:Action New value of property action.

setAction

back to summary

public void setAction(Action action)

Setter for property action.

Parameters

action:Action: New value of property action.

setAppearenceCount	back to summary
public void setAppearenceCount(int appearenceCount) Setter for property appearenceCount. Parameters appearenceCount:int New value of property appearenceCount.

setAppearenceCount

back to summary

public void setAppearenceCount(int appearenceCount)

Setter for property appearenceCount.

Parameters

appearenceCount:int: New value of property appearenceCount.

setImportPrecedence	back to summary
public void setImportPrecedence(int importPrecedence) Setter for property importPrecedence. Parameters importPrecedence:int New value of property importPrecedence.

setImportPrecedence

back to summary

public void setImportPrecedence(int importPrecedence)

Setter for property importPrecedence.

Parameters

importPrecedence:int: New value of property importPrecedence.

setMode	back to summary
public void setMode(String mode) Setter for property mode. Parameters mode:String New value of property mode.

setMode

back to summary

public void setMode(String mode)

Setter for property mode.

Parameters

mode:String: New value of property mode.

setPattern	back to summary
public void setPattern(Pattern pattern) Setter for property pattern. Parameters pattern:Pattern New value of property pattern.

setPattern

back to summary

public void setPattern(Pattern pattern)

Setter for property pattern.

Parameters

pattern:Pattern: New value of property pattern.

setPriority	back to summary
public void setPriority(double priority) Setter for property priority. Parameters priority:double New value of property priority.

setPriority

back to summary

public void setPriority(double priority)

Setter for property priority.

Parameters

priority:double: New value of property priority.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

public Class Rule

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail