Java Doc for DOMBuilder.java in  » XML » xalan » org » apache » xml » utils » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » xalan » org.apache.xml.utils 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.xml.utils.DOMBuilder

DOMBuilder
public class DOMBuilder implements ContentHandler,LexicalHandler(Code)
This class takes SAX events (in addition to some extra events that SAX doesn't handle yet) and adds the result to a document or document fragment.


Field Summary
protected  Nodem_currentNode
    
public  Documentm_doc
    
public  DocumentFragmentm_docFrag
    
protected  Stackm_elemStack
    
protected  booleanm_inCData
    
protected  Nodem_nextSibling
    
protected  Nodem_root
    

Constructor Summary
public  DOMBuilder(Document doc, Node node)
     DOMBuilder instance constructor...
public  DOMBuilder(Document doc, DocumentFragment docFrag)
     DOMBuilder instance constructor...
public  DOMBuilder(Document doc)
     DOMBuilder instance constructor...

Method Summary
protected  voidappend(Node newNode)
     Append a node to the current container.
public  voidcdata(char ch, int start, int length)
     Receive notification of cdata.

The Parser will call this method to report each chunk of character data.

public  voidcharacters(char ch, int start, int length)
     Receive notification of character data.

The Parser will call this method to report each chunk of character data.

public  voidcharactersRaw(char ch, int start, int length)
     If available, when the disable-output-escaping attribute is used, output raw text without escaping.
public  voidcomment(char ch, int start, int length)
     Report an XML comment anywhere in the document.
public  voidendCDATA()
     Report the end of a CDATA section.
public  voidendDTD()
     Report the end of DTD declarations.
public  voidendDocument()
     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.

public  voidendElement(String ns, String localName, String name)
     Receive notification of the end of an element.
public  voidendEntity(String name)
     Report the end of an entity.
public  voidendPrefixMapping(String prefix)
     End the scope of a prefix-URI mapping.

See startPrefixMapping for details.

public  voidentityReference(String name)
     Receive notivication of a entityReference.
public  NodegetCurrentNode()
     Get the node currently being processed.
public  NodegetNextSibling()
     Return the next sibling node.
public  NodegetRootDocument()
     Get the root document or DocumentFragment of the DOM being created.
public  NodegetRootNode()
     Get the root node of the DOM tree.
public  java.io.WritergetWriter()
     Return null since there is no Writer for this class.
public  voidignorableWhitespace(char ch, int start, int length)
     Receive notification of ignorable whitespace in element content.
public  voidprocessingInstruction(String target, String data)
     Receive notification of a processing instruction.
public  voidsetDocumentLocator(Locator locator)
     Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error.

public  voidsetIDAttribute(String id, Element elem)
     Set an ID string to node association in the ID table.
public  voidsetNextSibling(Node nextSibling)
     Set the next sibling node, which is where the result nodes should be inserted before.
public  voidskippedEntity(String name)
     Receive notification of a skipped entity.

The Parser will invoke this method once for each entity skipped.

public  voidstartCDATA()
     Report the start of a CDATA section.
public  voidstartDTD(String name, String publicId, String systemId)
     Report the start of DTD declarations, if any.
public  voidstartDocument()
     Receive notification of the beginning of a document.
public  voidstartElement(String ns, String localName, String name, Attributes atts)
     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() event for every startElement() event (even when the element is empty).

public  voidstartEntity(String name)
     Report the beginning of an entity. The start and end of the document entity are not reported. The start and end of the external DTD subset are reported using the pseudo-name "[dtd]".
public  voidstartPrefixMapping(String prefix, String uri)
     Begin the scope of a prefix-URI Namespace mapping.

Field Detail
m_currentNode
protected Node m_currentNode(Code)
Current node



m_doc
public Document m_doc(Code)
Root document



m_docFrag
public DocumentFragment m_docFrag(Code)
First node of document fragment or null if not a DocumentFragment



m_elemStack
protected Stack m_elemStack(Code)
Vector of element nodes



m_inCData
protected boolean m_inCData(Code)
Flag indicating that we are processing a CData section



m_nextSibling
protected Node m_nextSibling(Code)
The next sibling node



m_root
protected Node m_root(Code)
The root node




Constructor Detail
DOMBuilder
public DOMBuilder(Document doc, Node node)(Code)
DOMBuilder instance constructor... it will add the DOM nodes to the document fragment.
Parameters:
  doc - Root document
Parameters:
  node - Current node



DOMBuilder
public DOMBuilder(Document doc, DocumentFragment docFrag)(Code)
DOMBuilder instance constructor... it will add the DOM nodes to the document fragment.
Parameters:
  doc - Root document
Parameters:
  docFrag - Document fragment



DOMBuilder
public DOMBuilder(Document doc)(Code)
DOMBuilder instance constructor... it will add the DOM nodes to the document.
Parameters:
  doc - Root document




Method Detail
append
protected void append(Node newNode) throws org.xml.sax.SAXException(Code)
Append a node to the current container.
Parameters:
  newNode - New node to append



cdata
public void cdata(char ch, int start, int length) throws org.xml.sax.SAXException(Code)
Receive notification of cdata.

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 using the ignorableWhitespace() method rather than this one (validating parsers must do so).


Parameters:
  ch - The characters from the XML document.
Parameters:
  start - The start position in the array.
Parameters:
  length - The number of characters to read from the array.
See Also:   DOMBuilder.ignorableWhitespace
See Also:   org.xml.sax.Locator



characters
public void characters(char ch, int start, int length) throws org.xml.sax.SAXException(Code)
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 using the ignorableWhitespace() method rather than this one (validating parsers must do so).


Parameters:
  ch - The characters from the XML document.
Parameters:
  start - The start position in the array.
Parameters:
  length - The number of characters to read from the array.
See Also:   DOMBuilder.ignorableWhitespace
See Also:   org.xml.sax.Locator



charactersRaw
public void charactersRaw(char ch, int start, int length) throws org.xml.sax.SAXException(Code)
If available, when the disable-output-escaping attribute is used, output raw text without escaping. A PI will be inserted in front of the node with the name "lotusxsl-next-is-raw" and a value of "formatter-to-dom".
Parameters:
  ch - Array containing the characters
Parameters:
  start - Index to start of characters in the array
Parameters:
  length - Number of characters in the array



comment
public void comment(char ch, int start, int length) throws org.xml.sax.SAXException(Code)
Report an XML comment anywhere in the document. This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).
Parameters:
  ch - An array holding the characters in the comment.
Parameters:
  start - The starting position in the array.
Parameters:
  length - The number of characters to use from the array.



endCDATA
public void endCDATA() throws org.xml.sax.SAXException(Code)
Report the end of a CDATA section.
See Also:   DOMBuilder.startCDATA



endDTD
public void endDTD() throws org.xml.sax.SAXException(Code)
Report the end of DTD declarations.
See Also:   DOMBuilder.startDTD



endDocument
public void endDocument() throws org.xml.sax.SAXException(Code)
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.




endElement
public void endElement(String ns, String localName, String name) throws org.xml.sax.SAXException(Code)
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() event for every endElement() event (even when the element is empty).

If the element name has a namespace prefix, the prefix will still be attached to the name.


Parameters:
  ns - the namespace of the element
Parameters:
  localName - The local part of the qualified name of the element
Parameters:
  name - The element name



endEntity
public void endEntity(String name) throws org.xml.sax.SAXException(Code)
Report the end of an entity.
Parameters:
  name - The name of the entity that is ending.
See Also:   DOMBuilder.startEntity



endPrefixMapping
public void endPrefixMapping(String prefix) throws org.xml.sax.SAXException(Code)
End the scope of a prefix-URI mapping.

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


Parameters:
  prefix - The prefix that was being mapping.
See Also:   DOMBuilder.startPrefixMapping
See Also:   DOMBuilder.endElement



entityReference
public void entityReference(String name) throws org.xml.sax.SAXException(Code)
Receive notivication of a entityReference.
Parameters:
  name - name of the entity reference



getCurrentNode
public Node getCurrentNode()(Code)
Get the node currently being processed. the current node being processed



getNextSibling
public Node getNextSibling()(Code)
Return the next sibling node. the next sibling node.



getRootDocument
public Node getRootDocument()(Code)
Get the root document or DocumentFragment of the DOM being created. The root document or document fragment if not null



getRootNode
public Node getRootNode()(Code)
Get the root node of the DOM tree.



getWriter
public java.io.Writer getWriter()(Code)
Return null since there is no Writer for this class. null



ignorableWhitespace
public void ignorableWhitespace(char ch, int start, int length) throws org.xml.sax.SAXException(Code)
Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (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.


Parameters:
  ch - The characters from the XML document.
Parameters:
  start - The start position in the array.
Parameters:
  length - The number of characters to read from the array.
See Also:   DOMBuilder.characters



processingInstruction
public void processingInstruction(String target, String data) throws org.xml.sax.SAXException(Code)
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 should 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.


Parameters:
  target - The processing instruction target.
Parameters:
  data - The processing instruction data, or null ifnone was supplied.



setDocumentLocator
public void setDocumentLocator(Locator locator)(Code)
Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.


Parameters:
  locator - An object that can return the location ofany SAX document event.
See Also:   org.xml.sax.Locator



setIDAttribute
public void setIDAttribute(String id, Element elem)(Code)
Set an ID string to node association in the ID table.
Parameters:
  id - The ID string.
Parameters:
  elem - The associated ID.



setNextSibling
public void setNextSibling(Node nextSibling)(Code)
Set the next sibling node, which is where the result nodes should be inserted before.
Parameters:
  nextSibling - the next sibling node.



skippedEntity
public void skippedEntity(String name) throws org.xml.sax.SAXException(Code)
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.


Parameters:
  name - The name of the skipped entity. If it is aparameter entity, the name will begin with '%'.



startCDATA
public void startCDATA() throws org.xml.sax.SAXException(Code)
Report the start of a CDATA section.
See Also:   DOMBuilder.endCDATA



startDTD
public void startDTD(String name, String publicId, String systemId) throws org.xml.sax.SAXException(Code)
Report the start of DTD declarations, if any. Any declarations are assumed to be in the internal subset unless otherwise indicated.
Parameters:
  name - The document type name.
Parameters:
  publicId - The declared public identifier for theexternal DTD subset, or null if none was declared.
Parameters:
  systemId - The declared system identifier for theexternal DTD subset, or null if none was declared.
See Also:   DOMBuilder.endDTD
See Also:   DOMBuilder.startEntity



startDocument
public void startDocument() throws org.xml.sax.SAXException(Code)
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).




startElement
public void startElement(String ns, String localName, String name, Attributes atts) throws org.xml.sax.SAXException(Code)
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() 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.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.


Parameters:
  ns - The namespace of the node
Parameters:
  localName - The local part of the qualified name
Parameters:
  name - The element name.
Parameters:
  atts - The attributes attached to the element, if any.
See Also:   DOMBuilder.endElement
See Also:   org.xml.sax.Attributes



startEntity
public void startEntity(String name) throws org.xml.sax.SAXException(Code)
Report the beginning of an entity. The start and end of the document entity are not reported. The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.
Parameters:
  name - The name of the entity. If it is a parameterentity, the name will begin with '%'.
See Also:   DOMBuilder.endEntity
See Also:   org.xml.sax.ext.DeclHandler.internalEntityDecl
See Also:   org.xml.sax.ext.DeclHandler.externalEntityDecl



startPrefixMapping
public void startPrefixMapping(String prefix, String uri) throws org.xml.sax.SAXException(Code)
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 event, and all endPrefixMapping events will occur after the corresponding endElement event, but their order is not guaranteed.


Parameters:
  prefix - The Namespace prefix being declared.
Parameters:
  uri - The Namespace URI the prefix is mapped to.
See Also:   DOMBuilder.endPrefixMapping
See Also:   DOMBuilder.startElement



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.