JAXB OSGI 4.0.9 · com.sun.tools.xjc.reader.internalizer.DOMForest

Modifier and Type	Class and Description
public static interface	DOMForest.Handler
private abstract static class	DOMForest.HandlerImpl

Field Summary

Modifier and Type	Field and Description
private final Map<String, Document>	core actual data storage `map<SystemId,Document>`.
private final DocumentBuilder	documentBuilder
private EntityResolver	entityResolver Used to resolve references to other schema documents.
private ErrorReceiver	errorReceiver Errors encountered during the parsing will be sent to this object.
public final LocatorTable	locatorTable Stores location information for all the trees in this forest.
protected final InternalizationLogic	logic Schema language dependent part of the processing.
private final Options	options
public final Set<Element>	outerMostBindings Stores all the outer-most `<jaxb:bindings>` customizations.
private final SAXParserFactory	parserFactory
private final Set<String>	rootDocuments To correctly feed documents to a schema parser, we need to remember which documents (of the forest) were given as the root documents, and which of them are read as included/imported documents.

Constructor Summary

Access	Constructor and Description
public	DOMForest(SAXParserFactory parserFactory, DocumentBuilder documentBuilder, InternalizationLogic logic)
public	DOMForest(InternalizationLogic logic, Options opt)

Method Summary

Modifier and Type	Method and Description
public boolean	checkSchemaCorrectness(ErrorReceiver errorHandler) Checks the correctness of the XML Schema documents and return true if it's OK.
public XMLParser	createParser() Creates `XMLParser` for XSOM which reads documents from this DOMForest rather than doing a fresh parse.
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.)
public void	dump(OutputStream out) Dumps the contents of the forest to the specified stream.
public Document	get(String systemId) Gets the DOM tree associated with the specified system ID, or null if none is found.
public EntityResolver	getEntityResolver()
public ErrorReceiver	getErrorHandler()
public Document	getOneDocument() Picks one document at random and returns it.
private ContentHandler	getParserHandler(Document dom) Returns a `ContentHandler` to feed SAX events into.
public DOMForest.Handler	getParserHandler(String systemId, boolean root) Returns a `ContentHandler` to feed SAX events into.
private String	getPath(String key) Strips off the leading 'file:///' portion from an URL.
public Set<String>	getRootDocuments() Returns a read-only set of root document system IDs.
public String	getSystemId(Document dom) Gets the system ID from which the given DOM is parsed.
public Document[]	listDocuments() Gets all the parsed documents.
public String[]	listSystemIDs() Gets all the system IDs of the documents.
public Document	parse(InputSource source, boolean root)
public Document	Returns: the parsed DOM document object. parse(String systemId, boolean root) Parses an XML at the given location ( and XMLs referenced by it) into DOM trees and stores them to this forest.
public Document	Returns: null if there was a parse error. otherwise non-null. parse(String systemId, InputSource inputSource, boolean root) Parses the given document and add it to the DOM forest.
public Document	parse(String systemId, XMLStreamReader parser, boolean root)
public void	setEntityResolver(EntityResolver entityResolver)
public void	setErrorHandler(ErrorReceiver errorHandler)
public SCDBasedBindingSet	Returns: the returned bindings need to be applied after schema components are built. transform(boolean enableSCD) Performs internalization.
public void	weakSchemaCorrectnessCheck(SchemaFactory sf) Performs the schema correctness check by using JAXP 1.3.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

core	back to summary
private final Map<String, Document> core actual data storage `map<SystemId,Document>`.

documentBuilder	back to summary
private final DocumentBuilder documentBuilder

entityResolver	back to summary
private EntityResolver entityResolver Used to resolve references to other schema documents.

errorReceiver	back to summary
private ErrorReceiver errorReceiver Errors encountered during the parsing will be sent to this object.

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

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

options	back to summary
private final Options options

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

parserFactory	back to summary
private final SAXParserFactory parserFactory

rootDocuments	back to summary
private final Set<String> rootDocuments To correctly feed documents to a schema parser, we need to remember which documents (of the forest) were given as the root documents, and which of them are read as included/imported documents. Set of system ids as strings.

rootDocuments

back to summary

private final Set<String> rootDocuments

To correctly feed documents to a schema parser, we need to remember which documents (of the forest) were given as the root documents, and which of them are read as included/imported documents.

Set of system ids as strings.

Constructor Detail

DOMForest	back to summary
public DOMForest(SAXParserFactory parserFactory, DocumentBuilder documentBuilder, InternalizationLogic logic)

DOMForest	back to summary
public DOMForest(InternalizationLogic logic, Options opt)

Method Detail

checkSchemaCorrectness back to summary

checkSchemaCorrectness	back to summary
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 `SchemaConstraintChecker`

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: SchemaConstraintChecker

createParser	back to summary
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.

createSAXSource back to summary

createSAXSource	back to summary
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.) Annotations @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.)

Annotations

@NotNull

dump	back to summary
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.

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

getEntityResolver	back to summary
public EntityResolver getEntityResolver()

getErrorHandler	back to summary
public ErrorReceiver getErrorHandler()

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

getParserHandler back to summary

getParserHandler	back to summary
private ContentHandler getParserHandler(Document dom) 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. This version requires that the DOM object to be created and registered to the map beforehand.

private ContentHandler getParserHandler(Document dom)

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. This version requires that the DOM object to be created and registered to the map beforehand.

getParserHandler back to summary

getParserHandler	back to summary
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.

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.

getPath	back to summary
private String getPath(String key) Strips off the leading 'file:///' portion from an URL.

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

getSystemId	back to summary
public String getSystemId(Document dom) Gets the system ID from which the given DOM is parsed. Poor-man's base URI.

getSystemId

back to summary

public String getSystemId(Document dom)

Gets the system ID from which the given DOM is parsed.

Poor-man's base URI.

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

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

parse	back to summary
public Document parse(InputSource source, boolean root) throws SAXException

parse	back to summary
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:Document the parsed DOM document object.

parse

back to summary

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:Document: the parsed DOM document object.

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

parse

back to summary

public Document parse(String systemId, InputSource inputSource, boolean root) throws SAXException

Parses the given document and add it to the DOM forest.

Returns:Document: null if there was a parse error. otherwise non-null.

parse	back to summary
public Document parse(String systemId, XMLStreamReader parser, boolean root) throws XMLStreamException

setEntityResolver	back to summary
public void setEntityResolver(EntityResolver entityResolver)

setErrorHandler	back to summary
public void setErrorHandler(ErrorReceiver errorHandler)

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

transform

back to summary

public SCDBasedBindingSet transform(boolean enableSCD)

Performs internalization. This method should be called only once, only after all the schemas are parsed.

Returns:SCDBasedBindingSet: the returned bindings need to be applied after schema components are built.

weakSchemaCorrectnessCheck back to summary

weakSchemaCorrectnessCheck	back to summary
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)`.

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).

public final Class DOMForest

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface DOMForest.Handler

Method Summary

Method Detail

private abstract Class DOMForest.HandlerImpl

Constructor Summary

Method Summary

Constructor Detail