DefaultPattern (dom4j 1.6.1 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.dom4j.rule.pattern
Class DefaultPattern

    java.lang.Object
      org.dom4j.rule.pattern.DefaultPattern

All Implemented Interfaces:
  NodeFilter, Pattern

public class DefaultPattern
extends Object
implements Pattern

`DefaultPattern` a default implementation of Pattern which can take any XPath implementation or NodeFilter for defining the pattern. WARNING this implementation causes a worst case, brute force XSLT rule evaluation to be performed. Wherever possible the methods `getPriority()`, `getMatchType()`and `getMatchesNodeName()`should be overloaded to allow more rule filtering to occur.

Version:
  $Revision: 1.6 $
Author:
  James Strachan

Field Summary

Fields inherited from interface org.dom4j.rule.Pattern
`ANY_NODE, DEFAULT_PRIORITY, NONE, NUMBER_OF_TYPES`

Constructor Summary
`DefaultPattern(NodeFilter filter)`

Method Summary
`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!

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

Constructor Detail

### DefaultPattern

    public DefaultPattern(NodeFilter filter)

Method Detail

### matches

    public boolean matches(Node node)

  Description copied from interface: `Pattern`
  DOCUMENT ME!

  Specified by:
    `matches` in interface `Pattern`
  Parameters:
    `node` - DOCUMENT ME!
  Returns:
    true if the pattern matches the given DOM4J node.

### getPriority

    public double getPriority()

  Description copied from interface: `Pattern`
  Returns the default resolution policy of the pattern according to the XSLT conflict resolution spec .

  Specified by:
    `getPriority` in interface `Pattern`
  Returns:
    DOCUMENT ME!

### getUnionPatterns

    public Pattern[] getUnionPatterns()

  Description copied from interface: `Pattern`
  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.

  Specified by:
    `getUnionPatterns` in interface `Pattern`
  Returns:
    an array of the patterns which make up this union pattern or null if this pattern is not a union pattern

### getMatchType

    public short getMatchType()

  Description copied from interface: `Pattern`
  DOCUMENT ME!

  Specified by:
    `getMatchType` in interface `Pattern`
  Returns:
    the type of node the pattern matches which by default should return ANY_NODE if it can match any kind of node.

### getMatchesNodeName

    public String getMatchesNodeName()

  Description copied from interface: `Pattern`
  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.

  Specified by:
    `getMatchesNodeName` in interface `Pattern`
  Returns:
    the name of the element or attribute this pattern matches or null if this pattern matches any or more than one name.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2005 MetaStuff Ltd.. All Rights Reserved.