Save This Page
Home » openjdk-7 » com.sun.xml.internal » xsom » impl » parser » state » [javadoc | source]
com.sun.xml.internal.xsom.impl.parser.state
public class: NGCCRuntime [javadoc | source]
java.lang.Object
   com.sun.xml.internal.xsom.impl.parser.state.NGCCRuntime

All Implemented Interfaces:
    ContentHandler, NGCCEventSource

Direct Known Subclasses:
    NGCCRuntimeEx

Runtime Engine for RELAXNGCC execution. This class has the following functionalities:
  1. Managing a stack of NGCCHandler objects and switching between them appropriately.
  2. Keep track of all Attributes.
  3. manage mapping between namespace URIs and prefixes.
  4. TODO: provide support for interleaving.
      author: Kohsuke - Kawaguchi (kk@kohsuke.org)
    Field Summary
    static final  String IMPOSSIBLE    Impossible token. This value can never be a valid XML name. 
    Constructor:
     public NGCCRuntime() 
    Method from com.sun.xml.internal.xsom.impl.parser.state.NGCCRuntime Summary:
    characters,   consumeAttribute,   endDocument,   endElement,   endPrefixMapping,   getAttributeIndex,   getCurrentAttributes,   getLocator,   ignorableWhitespace,   onEnterElementConsumed,   onLeaveElementConsumed,   processList,   processingInstruction,   redirectSubtree,   replace,   reset,   resolveNamespacePrefix,   sendEnterAttribute,   sendEnterElement,   sendLeaveAttribute,   sendLeaveElement,   sendText,   setDocumentLocator,   setRootHandler,   skippedEntity,   startDocument,   startElement,   startPrefixMapping,   trace,   traceln,   unexpectedX
    Methods from java.lang.Object:
    equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
    Method from com.sun.xml.internal.xsom.impl.parser.state.NGCCRuntime Detail:
     public  void characters(char[] ch,
        int start,
        int length) throws SAXException 
     public  void consumeAttribute(int index) throws SAXException 
     public  void endDocument() throws SAXException 
     public  void endElement(String uri,
        String localname,
        String qname) throws SAXException 
     public  void endPrefixMapping(String prefix) throws SAXException 
     public int getAttributeIndex(String uri,
        String localname) 
     public Attributes getCurrentAttributes() 
      Attributes that belong to the current element.

      It's generally not recommended for applications to use this method. RelaxNGCC internally removes processed attributes, so this doesn't correctly reflect all the attributes an element carries.

     public Locator getLocator() 
      Gets the source location of the current event.

      One can call this method from RelaxNGCC handlers to access the line number information. Note that to

     public  void ignorableWhitespace(char[] ch,
        int start,
        int length) throws SAXException 
     public  void onEnterElementConsumed(String uri,
        String localName,
        String qname,
        Attributes atts) throws SAXException 
      Called by the generated handler code when an enter element event is consumed.

      Pushes a new attribute set.

      Note that attributes are NOT pushed at the startElement method, because the processing of the enterElement event can trigger other attribute events and etc.

      This method will be called from one of handlers when it truely consumes the enterElement event.

     public  void onLeaveElementConsumed(String uri,
        String localName,
        String qname) throws SAXException 
     public  void processList(String str) throws SAXException 
     public  void processingInstruction(String target,
        String data) throws SAXException 
     public  void redirectSubtree(ContentHandler child,
        String uri,
        String local,
        String qname) throws SAXException 
      This method can be called only from the enterElement handler. The sub-tree rooted at the new element will be redirected to the specified ContentHandler.

      Currently active NGCCHandler will only receive the leaveElement event of the newly started element.

     public int replace(NGCCEventReceiver o,
        NGCCEventReceiver n) 
     public  void reset() 
      Cleans up all the data structure so that the object can be reused later. Normally, applications do not need to call this method directly, as the runtime resets itself after the endDocument method.
     public String resolveNamespacePrefix(String prefix) 
     public  void sendEnterAttribute(int threadId,
        String uri,
        String local,
        String qname) throws SAXException 
     public  void sendEnterElement(int threadId,
        String uri,
        String local,
        String qname,
        Attributes atts) throws SAXException 
     public  void sendLeaveAttribute(int threadId,
        String uri,
        String local,
        String qname) throws SAXException 
     public  void sendLeaveElement(int threadId,
        String uri,
        String local,
        String qname) throws SAXException 
     public  void sendText(int threadId,
        String value) throws SAXException 
     public  void setDocumentLocator(Locator _loc) 
     public  void setRootHandler(NGCCHandler rootHandler) 
      Sets the root handler, which will be used to parse the root element.

      This method can be called right after the object is created or the reset method is called. You can't replace the root handler while parsing is in progress.

      Usually a generated class that corresponds to the <start> pattern will be used as the root handler, but any NGCCHandler can be a root handler.

     public  void skippedEntity(String name) throws SAXException 
     public  void startDocument() 
     public  void startElement(String uri,
        String localname,
        String qname,
        Attributes atts) throws SAXException 
     public  void startPrefixMapping(String prefix,
        String uri) throws SAXException 
     public  void trace(String s) 
     public  void traceln(String s) 
     protected  void unexpectedX(String token) throws SAXException