org.apache.cayenne.configuration.xml

## Class QueryDescriptorHandler

- java.lang.Object
- - org.xml.sax.helpers.DefaultHandler
  - - org.apache.cayenne.configuration.xml.SAXNestedTagHandler
    - - org.apache.cayenne.configuration.xml.NamespaceAwareNestedTagHandler
      - - org.apache.cayenne.configuration.xml.QueryDescriptorHandler

- All Implemented Interfaces:
    ContentHandler, DTDHandler, EntityResolver, ErrorHandler

      public class QueryDescriptorHandler
      extends NamespaceAwareNestedTagHandler

  Since:
    4.1

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `PROPERTY_TAG`

    - ### Fields inherited from class org.apache.cayenne.configuration.xml.NamespaceAwareNestedTagHandler

      `allowAllNamespaces, targetNamespace`

    - ### Fields inherited from class org.apache.cayenne.configuration.xml.SAXNestedTagHandler

      `loaderContext, locator, parentHandler`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `QueryDescriptorHandler(NamespaceAwareNestedTagHandler parentHandler, DataMap map)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `beforeScopeEnd()` Callback method that is called before this handler pushed out of parsers stack.
    `QueryDescriptor` | `getQueryDescriptor()`
    `protected void` | `processCharData(String localName, String data)`
    `protected boolean` | `processElement(String namespaceURI, String localName, Attributes attributes)` Main method to process XML content.

    - ### Methods inherited from class org.apache.cayenne.configuration.xml.NamespaceAwareNestedTagHandler

      `characters, createChildTagHandler, endElement, setAllowAllNamespaces, setTargetNamespace, startElement`

    - ### Methods inherited from class org.apache.cayenne.configuration.xml.SAXNestedTagHandler

      `getParentHandler, setDocumentLocator, stop, unexpectedTagMessage`

    - ### Methods inherited from class org.xml.sax.helpers.DefaultHandler

      `endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### PROPERTY_TAG

          public static final String PROPERTY_TAG

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### QueryDescriptorHandler

          public QueryDescriptorHandler(NamespaceAwareNestedTagHandler parentHandler,
                                        DataMap map)

  - ### Method Detail

    - #### processElement

          protected boolean processElement(String namespaceURI,
                                           String localName,
                                           Attributes attributes)
                                    throws SAXException

      Description copied from class: `SAXNestedTagHandler`
      Main method to process XML content. Should be override in subclasses, by default do nothing. Return value should be true if tag was fully processed and shouldn't be passed down to child handler.
      Specified by:
        `processElement` in class `NamespaceAwareNestedTagHandler`
      Parameters:
        `namespaceURI` - namespace for tag
        `localName` - tag local name (i.e. w/o namespace prefix)
        `attributes` - tag attributes
      Returns:
        true if tag was processed
      Throws:
        `SAXException` - can be thrown to abort parsing
      See Also:
        `SAXNestedTagHandler.createChildTagHandler(String, String, String, Attributes)`

    - #### processCharData

          protected void processCharData(String localName,
                                         String data)

      Overrides:
        `processCharData` in class `NamespaceAwareNestedTagHandler`

    - #### beforeScopeEnd

          protected void beforeScopeEnd()

      Description copied from class: `SAXNestedTagHandler`
      Callback method that is called before this handler pushed out of parsers stack. Can be used to flush some aggregate state.
      Overrides:
        `beforeScopeEnd` in class `SAXNestedTagHandler`

    - #### getQueryDescriptor

          public QueryDescriptor getQueryDescriptor()

Copyright © 2001–2021 Apache Cayenne. All rights reserved.