Xerces-J API: Class XPathMatcher

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.xerces.validators.schema.identity
Class XPathMatcher

    java.lang.Object
      |
      +--org.apache.xerces.validators.schema.identity.XPathMatcher

Direct Known Subclasses:
  Field.Matcher, Selector.Matcher

public class XPathMatcher
extends java.lang.Object

XPath matcher.

Version:
  $Id: XPathMatcher.java,v 1.14 2001/05/15 22:18:12 neilg Exp $
Author:
  Andy Clark, IBM

Field Summary
`protected static boolean` | `DEBUG_ALL` Compile to true to debug everything.
`protected static boolean` | `DEBUG_ANY` Don't touch this value unless you add more debug constants.
`protected static boolean` | `DEBUG_MATCH` Compile to true to debug match.
`protected static boolean` | `DEBUG_METHODS` Compile to true to debug method callbacks.
`protected static boolean` | `DEBUG_METHODS2` Compile to true to debug important method callbacks.
`protected static boolean` | `DEBUG_METHODS3` Compile to true to debug the really important methods.
`protected static boolean` | `DEBUG_STACK` Compile to true to debug step index stack.
`protected IdentityConstraint` | `fIDConstraint`
`protected NamespacesScope` | `fNamespacesScope` Namespace scope.
`protected StringPool` | `fStringPool` String pool.

Constructor Summary
`XPathMatcher(XPath xpath)` Constructs an XPath matcher that implements a document fragment handler.
`XPathMatcher(XPath xpath, boolean shouldBufferContent, IdentityConstraint idConstraint)` Constructs an XPath matcher that implements a document fragment handler.

Method Summary
`void` | `characters(char[] ch, int offset, int length)` Character content.
`void` | `endDocumentFragment()` The end of the document fragment.
`void` | `endElement(QName element, int eIndex, SchemaGrammar grammar)` The end of an element.
`IdentityConstraint` | `getIDConstraint()`
`boolean` | `getIsSelector()`
`java.lang.String` | `getMatchedString()` Returns the matched string.
`boolean` | `isMatched()` Returns true if XPath has been matched.
`protected void` | `matched(java.lang.String content, DatatypeValidator val, boolean isNil)` This method is called when the XPath handler matches the XPath expression.
`void` | `startDocumentFragment(StringPool stringPool)` The start of the document fragment.
`void` | `startElement(QName element, XMLAttrList attributes, int handle, int eIndex, SchemaGrammar grammar)` The start of an element.
`java.lang.String` | `toString()` Returns a string representation of this object.

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

Field Detail

### DEBUG_ALL

    protected static final boolean DEBUG_ALL

  Compile to true to debug everything.

### DEBUG_METHODS

    protected static final boolean DEBUG_METHODS

  Compile to true to debug method callbacks.

### DEBUG_METHODS2

    protected static final boolean DEBUG_METHODS2

  Compile to true to debug important method callbacks.

### DEBUG_METHODS3

    protected static final boolean DEBUG_METHODS3

  Compile to true to debug the really important methods.

### DEBUG_MATCH

    protected static final boolean DEBUG_MATCH

  Compile to true to debug match.

### DEBUG_STACK

    protected static final boolean DEBUG_STACK

  Compile to true to debug step index stack.

### DEBUG_ANY

    protected static final boolean DEBUG_ANY

  Don't touch this value unless you add more debug constants.

### fStringPool

    protected StringPool fStringPool

  String pool.

### fNamespacesScope

    protected NamespacesScope fNamespacesScope

  Namespace scope.

### fIDConstraint

    protected IdentityConstraint fIDConstraint

Constructor Detail

### XPathMatcher

    public XPathMatcher(XPath xpath)

  Constructs an XPath matcher that implements a document fragment handler.
  Parameters:
    `xpath` - The xpath.

### XPathMatcher

    public XPathMatcher(XPath xpath,
                        boolean shouldBufferContent,
                        IdentityConstraint idConstraint)

  Constructs an XPath matcher that implements a document fragment handler.
  Parameters:
    `xpath` - The xpath.
    `shouldBufferContent` - True if the matcher should buffer the matched content.
    `idConstraint:` - the identity constraint we're matching for; null unless it's a Selector.

Method Detail

### isMatched

    public boolean isMatched()

  Returns true if XPath has been matched.

### getIsSelector

    public boolean getIsSelector()

### getIDConstraint

    public IdentityConstraint getIDConstraint()

### getMatchedString

    public java.lang.String getMatchedString()

  Returns the matched string.

### matched

    protected void matched(java.lang.String content,
                           DatatypeValidator val,
                           boolean isNil)
                    throws java.lang.Exception

  This method is called when the XPath handler matches the XPath expression. Subclasses can override this method to provide default handling upon a match.

### startDocumentFragment

    public void startDocumentFragment(StringPool stringPool)
                               throws java.lang.Exception

  The start of the document fragment.
  Parameters:
    `namespaceScope` - The namespace scope in effect at the start of this document fragment.
    `grammar:` - the schema grammar we're validating against.
  Throws:
    SAXException - Thrown by handler to signal an error.

### startElement

    public void startElement(QName element,
                             XMLAttrList attributes,
                             int handle,
                             int eIndex,
                             SchemaGrammar grammar)
                      throws java.lang.Exception

  The start of an element. If the document specifies the start element by using an empty tag, then the startElement method will immediately be followed by the endElement method, with no intervening methods.
  Parameters:
    `element` - The name of the element.
    `attributes` - The element attributes.
    `eIndex:` - the element index of the current element
    `grammar:` - the currently-active Schema Grammar
  Throws:
    SAXException - Thrown by handler to signal an error.

### characters

    public void characters(char[] ch,
                           int offset,
                           int length)
                    throws java.lang.Exception

  Character content.

### endElement

    public void endElement(QName element,
                           int eIndex,
                           SchemaGrammar grammar)
                    throws java.lang.Exception

  The end of an element.
  Parameters:
    `element` - The name of the element.
    `eIndex:` - the elementDeclIndex of the current element; needed so that we can look up its datatypeValidator.
  Throws:
    SAXException - Thrown by handler to signal an error.

### endDocumentFragment

    public void endDocumentFragment()
                             throws java.lang.Exception

  The end of the document fragment.
  Throws:
    SAXException - Thrown by handler to signal an error.

### toString

    public java.lang.String toString()

  Returns a string representation of this object.
  Overrides:
    toString in class java.lang.Object

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2001 Apache XML Project. All Rights Reserved.