Package org.dom4j.rule
Interface Pattern
-
- All Superinterfaces:
NodeFilter
- All Known Implementing Classes:
DefaultPattern
,NodeTypePattern
,XPathPattern
public interface Pattern extends NodeFilter
Pattern
defines the behaviour for pattern in the XSLT processing model.
-
-
Field Summary
Fields Modifier and Type Field Description static short
ANY_NODE
Matches any nodestatic double
DEFAULT_PRIORITY
According to the spec we should return 0.5 if we cannot determine the prioritystatic short
NONE
Matches no nodesstatic short
NUMBER_OF_TYPES
Count of the number of node types
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.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.short
getMatchType()
DOCUMENT ME!double
getPriority()
Returns the default resolution policy of the pattern according to the XSLT conflict resolution spec .Pattern[]
getUnionPatterns()
If this pattern is a union pattern then this method should return an array of patterns which describe the union pattern, which should contain more than one pattern.boolean
matches(Node node)
DOCUMENT ME!
-
-
-
Field Detail
-
ANY_NODE
static final short ANY_NODE
Matches any node- See Also:
- Constant Field Values
-
NONE
static final short NONE
Matches no nodes- See Also:
- Constant Field Values
-
NUMBER_OF_TYPES
static final short NUMBER_OF_TYPES
Count of the number of node types- See Also:
- Constant Field Values
-
DEFAULT_PRIORITY
static final double DEFAULT_PRIORITY
According to the spec we should return 0.5 if we cannot determine the priority- See Also:
- Constant Field Values
-
-
Method Detail
-
matches
boolean matches(Node node)
DOCUMENT ME!- Specified by:
matches
in interfaceNodeFilter
- Parameters:
node
- DOCUMENT ME!- Returns:
- true if the pattern matches the given DOM4J node.
-
getPriority
double getPriority()
Returns the default resolution policy of the pattern according to the XSLT conflict resolution spec .- Returns:
- DOCUMENT ME!
-
getUnionPatterns
Pattern[] getUnionPatterns()
If this pattern is a union pattern then this method should return an array of patterns which describe the union pattern, which should contain more than one pattern. Otherwise this method should return null.- Returns:
- an array of the patterns which make up this union pattern or null if this pattern is not a union pattern
-
getMatchType
short getMatchType()
DOCUMENT ME!- Returns:
- the type of node the pattern matches which by default should return ANY_NODE if it can match any kind of node.
-
getMatchesNodeName
java.lang.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:
- the name of the element or attribute this pattern matches or null if this pattern matches any or more than one name.
-
-