Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> ws >> jaxme >> [ util overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.ws.jaxme.util
Class DOMBuilder  

java.lang.Object
  org.apache.ws.jaxme.util.DOMBuilder

All Implemented Interfaces:

org.xml.sax.ContentHandler

---

public class DOMBuilder

extends java.lang.Object

implements org.xml.sax.ContentHandler

Converts a stream of SAX events into a DOM node.

Version:

$Id: DOMBuilder.java,v 1.4 2004/04/18 19:15:30 jochen Exp $

---

Field Summary
private  org.w3c.dom.Node	currentNode
private  org.w3c.dom.Document	document
private  org.xml.sax.Locator	locator
private  java.util.List	prefixes
private  boolean	prefixMappingIsAttribute
private  org.w3c.dom.Node	target

 

Constructor Summary

DOMBuilder()

 

Method Summary
void	characters(char[] ch, int start, int length)           Receive notification of character data.
void	endDocument()           Receive notification of the end of a document.
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)           Receive notification of the end of an element.
void	endPrefixMapping(java.lang.String prefix)           End the scope of a prefix-URI mapping.
org.w3c.dom.Document	getDocument()           Returns the document being used as object factory.
org.xml.sax.Locator	getDocumentLocator()           Returns the Locator.
org.w3c.dom.Node	getTarget()           Returns the target node.
void	ignorableWhitespace(char[] ch, int start, int length)           Receive notification of ignorable whitespace in element content.
boolean	isPrefixMappingIsAttribute()           Sets whether the event startPrefixMapping(java.lang.String, java.lang.String) 55 shall create an xmlns attribute.
void	processingInstruction(java.lang.String pTarget, java.lang.String pData)           Receive notification of a processing instruction.
void	setDocument(org.w3c.dom.Document pDocument)           Sets the document being used as object factory.
void	setDocumentLocator(org.xml.sax.Locator pLocator)           Sets the Locator.
void	setPrefixMappingIsAttribute(boolean pPrefixMappingIsAttribute)           Returns whether the event startPrefixMapping(java.lang.String, java.lang.String) 55 shall create an xmlns attribute.
void	setTarget(org.w3c.dom.Node pNode)           Sets the target node.
void	skippedEntity(java.lang.String pName)           Receive notification of a skipped entity.
void	startDocument()           Receive notification of the beginning of a document.
void	startElement(java.lang.String pNamespaceURI, java.lang.String pLocalName, java.lang.String pQName, org.xml.sax.Attributes pAttr)           Receive notification of the beginning of an element.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)           Begin the scope of a prefix-URI Namespace mapping.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

document

private org.w3c.dom.Document document

---

target

private org.w3c.dom.Node target

---

currentNode

private org.w3c.dom.Node currentNode

---

locator

private org.xml.sax.Locator locator

---

prefixMappingIsAttribute

private boolean prefixMappingIsAttribute

---

prefixes

private java.util.List prefixes

Constructor Detail

DOMBuilder

public DOMBuilder()

Method Detail

isPrefixMappingIsAttribute

public boolean isPrefixMappingIsAttribute()

Sets whether the event startPrefixMapping(java.lang.String, java.lang.String) 55 shall create an xmlns attribute. Defaults to false.

---

setPrefixMappingIsAttribute

public void setPrefixMappingIsAttribute(boolean pPrefixMappingIsAttribute)

Returns whether the event startPrefixMapping(java.lang.String, java.lang.String) 55 shall create an xmlns attribute. Defaults to false.

---

setDocument

public void setDocument(org.w3c.dom.Document pDocument)

Sets the document being used as object factory.

---

getDocument

public org.w3c.dom.Document getDocument()

Returns the document being used as object factory.

---

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator pLocator)

Sets the Locator.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

---

getDocumentLocator

public org.xml.sax.Locator getDocumentLocator()

Returns the Locator.

---

setTarget

public void setTarget(org.w3c.dom.Node pNode)

Sets the target node. The document is built as a fragment in the target node.

---

getTarget

public org.w3c.dom.Node getTarget()

Returns the target node. The document is built as a fragment in the target node.

---

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator 55 ).

Specified by:

startDocument in interface org.xml.sax.ContentHandler

---

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

---

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Begin the scope of a prefix-URI Namespace mapping.

The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces feature is true (the default).

There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.

Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each-other: all startPrefixMapping events will occur before the corresponding startElement 55 event, and all endPrefixMapping 55 events will occur after the corresponding endElement 55 event, but their order is not otherwise guaranteed.

There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

---

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

End the scope of a prefix-URI mapping.

See startPrefixMapping 55 for details. This event will always occur after the corresponding endElement 55 event, but the order of endPrefixMapping 55 events is not otherwise guaranteed.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

---

startElement

public void startElement(java.lang.String pNamespaceURI,
                         java.lang.String pLocalName,
                         java.lang.String pQName,
                         org.xml.sax.Attributes pAttr)
                  throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement 55 event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.

This event allows up to three name components for each element:

1. the Namespace URI;
2. the local name; and
3. the qualified (prefixed) name.

Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:

• the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be);
• the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the http://xml.org/sax/features/namespace-prefixes property is true (it is false by default, and support for a true value is optional).

Specified by:

startElement in interface org.xml.sax.ContentHandler

---

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement 55 event for every endElement event (even when the element is empty).

For information on the names, see startElement.

Specified by:

endElement in interface org.xml.sax.ContentHandler

---

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace in element content using the ignorableWhitespace 55 method rather than this one (validating parsers must do so).

Specified by:

characters in interface org.xml.sax.ContentHandler

---

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

---

processingInstruction

public void processingInstruction(java.lang.String pTarget,
                                  java.lang.String pData)
                           throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

---

skippedEntity

public void skippedEntity(java.lang.String pName)
                   throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of a skipped entity.

The Parser will invoke this method once for each entity skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities and the http://xml.org/sax/features/external-parameter-entities properties.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> ws >> jaxme >> [ util overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---