Package com.sun.tools.xjc.reader.internalizer

Class DOMForest

java.lang.Object
com.sun.tools.xjc.reader.internalizer.DOMForest
public final class DOMForest extends Object
Builds a DOM forest and maintains association from system IDs to DOM trees.

A forest is a transitive reflexive closure of referenced documents. IOW, if a document is in a forest, all the documents referenced from it is in a forest, too. To support this semantics, DOMForest uses InternalizationLogic to find referenced documents.

Some documents are marked as "root"s, meaning those documents were put into a forest explicitly, not because it is referenced from another document. (However, a root document can be referenced from other documents, too.)

Author:
Kohsuke Kawaguchi ([email protected])

  • Field Details

    • locatorTable

      public final LocatorTable locatorTable
      Stores location information for all the trees in this forest.

    • outerMostBindings

      public final Set<Element> outerMostBindings
      Stores all the outer-most <jaxb:bindings> customizations.

    • logic

      protected final InternalizationLogic logic
      Schema language dependent part of the processing.

  • Constructor Details

  • Method Details

    • get

      public Document get(String systemId)
      Gets the DOM tree associated with the specified system ID, or null if none is found.

    • getRootDocuments

      public Set<String> getRootDocuments()
      Returns a read-only set of root document system IDs.

    • getOneDocument

      public Document getOneDocument()
      Picks one document at random and returns it.

    • checkSchemaCorrectness

      public boolean checkSchemaCorrectness(ErrorReceiver errorHandler)
      Checks the correctness of the XML Schema documents and return true if it's OK.

      This method performs a weaker version of the tests where error messages are provided without line number information. So whenever possible use SchemaConstraintChecker.

      See Also:

    • getSystemId

      public String getSystemId(Document dom)
      Gets the system ID from which the given DOM is parsed.

      Poor-man's base URI.

    • parse

      public Document parse(InputSource source, boolean root) throws SAXException
      Throws:
      SAXException

    • parse

      public Document parse(String systemId, boolean root) throws SAXException, IOException
      Parses an XML at the given location ( and XMLs referenced by it) into DOM trees and stores them to this forest.
      Returns:
      the parsed DOM document object.
      Throws:
      SAXException
      IOException

    • getParserHandler

      public DOMForest.Handler getParserHandler(String systemId, boolean root)
      Returns a ContentHandler to feed SAX events into.

      The client of this class can feed SAX events into the handler to parse a document into this DOM forest.

    • parse

      public Document parse(String systemId, InputSource inputSource, boolean root) throws SAXException
      Parses the given document and add it to the DOM forest.
      Returns:
      null if there was a parse error. otherwise non-null.
      Throws:
      SAXException

    • parse

      public Document parse(String systemId, XMLStreamReader parser, boolean root) throws XMLStreamException
      Throws:
      XMLStreamException

    • transform

      public SCDBasedBindingSet transform(boolean enableSCD)
      Performs internalization. This method should be called only once, only after all the schemas are parsed.
      Returns:
      the returned bindings need to be applied after schema components are built.

    • weakSchemaCorrectnessCheck

      public void weakSchemaCorrectnessCheck(SchemaFactory sf)
      Performs the schema correctness check by using JAXP 1.3.

      This is "weak", because SchemaFactory.newSchema(Source[]) doesn't handle inclusions very correctly (it ends up parsing it from its original source, not in this tree), and because it doesn't handle two documents for the same namespace very well.

      We should eventually fix JAXP (and Xerces), but meanwhile this weaker and potentially wrong correctness check is still better than nothing when used inside JAX-WS (JAXB CLI and Ant does a better job of checking this.)

      To receive errors, use SchemaFactory.setErrorHandler(ErrorHandler).

    • createSAXSource

      @NotNull public SAXSource createSAXSource(String systemId)
      Creates a SAXSource that, when parsed, reads from this (instead of parsing the original source identified by the system ID.)

    • createParser

      public XMLParser createParser()
      Creates XMLParser for XSOM which reads documents from this DOMForest rather than doing a fresh parse. The net effect is that XSOM will read transformed XML Schemas instead of the original documents.

    • getEntityResolver

      public EntityResolver getEntityResolver()

    • setEntityResolver

      public void setEntityResolver(EntityResolver entityResolver)

    • getErrorHandler

      public ErrorReceiver getErrorHandler()

    • setErrorHandler

      public void setErrorHandler(ErrorReceiver errorHandler)

    • listDocuments

      public Document[] listDocuments()
      Gets all the parsed documents.

    • listSystemIDs

      public String[] listSystemIDs()
      Gets all the system IDs of the documents.

    • dump

      public void dump(OutputStream out) throws IOException
      Dumps the contents of the forest to the specified stream. This is a debug method. As such, error handling is sloppy.
      Throws:
      IOException