FileDocCategorySizeDatePackage
DOMBuilder.javaAPI DocJava SE 6 API24083Tue Jun 10 00:23:10 BST 2008com.sun.org.apache.xml.internal.utils

DOMBuilder

public class DOMBuilder extends Object implements LexicalHandler, ContentHandler
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.
xsl.usage
general

Fields Summary
public Document
m_doc
Root document
protected Node
m_currentNode
Current node
protected Node
m_root
The root node
protected Node
m_nextSibling
The next sibling node
public DocumentFragment
m_docFrag
First node of document fragment or null if not a DocumentFragment
protected Stack
m_elemStack
Vector of element nodes
protected boolean
m_inCData
Flag indicating that we are processing a CData section
Constructors Summary
public DOMBuilder(Document doc, Node node)
DOMBuilder instance constructor... it will add the DOM nodes to the document fragment.

param
doc Root document
param
node Current node


                          
      
  
    m_doc = doc;
    m_currentNode = m_root = node;
    
    if (node instanceof Element)
      m_elemStack.push(node);
  
public DOMBuilder(Document doc, DocumentFragment docFrag)
DOMBuilder instance constructor... it will add the DOM nodes to the document fragment.

param
doc Root document
param
docFrag Document fragment

    m_doc = doc;
    m_docFrag = docFrag;
  
public DOMBuilder(Document doc)
DOMBuilder instance constructor... it will add the DOM nodes to the document.

param
doc Root document

    m_doc = doc;
  
Methods Summary
protected voidappend(org.w3c.dom.Node newNode)
Append a node to the current container.

param
newNode New node to append


    Node currentNode = m_currentNode;

    if (null != currentNode)
    {
      if (currentNode == m_root && m_nextSibling != null)
        currentNode.insertBefore(newNode, m_nextSibling);
      else
        currentNode.appendChild(newNode);

      // System.out.println(newNode.getNodeName());
    }
    else if (null != m_docFrag)
    {
      if (m_nextSibling != null)
        m_docFrag.insertBefore(newNode, m_nextSibling);
      else
        m_docFrag.appendChild(newNode);
    }
    else
    {
      boolean ok = true;
      short type = newNode.getNodeType();

      if (type == Node.TEXT_NODE)
      {
        String data = newNode.getNodeValue();

        if ((null != data) && (data.trim().length() > 0))
        {
          throw new org.xml.sax.SAXException(
            XMLMessages.createXMLMessage(
              XMLErrorResources.ER_CANT_OUTPUT_TEXT_BEFORE_DOC, null));  //"Warning: can't output text before document element!  Ignoring...");
        }

        ok = false;
      }
      else if (type == Node.ELEMENT_NODE)
      {
        if (m_doc.getDocumentElement() != null)
        {
          ok = false;
          
          throw new org.xml.sax.SAXException(
            XMLMessages.createXMLMessage(
              XMLErrorResources.ER_CANT_HAVE_MORE_THAN_ONE_ROOT, null));  //"Can't have more than one root on a DOM!");
        }
      }

      if (ok)
      {
        if (m_nextSibling != null)
          m_doc.insertBefore(newNode, m_nextSibling);
        else
          m_doc.appendChild(newNode);
      }
    }
  
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. 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).

param
ch The characters from the XML document.
param
start The start position in the array.
param
length The number of characters to read from the array.
see
#ignorableWhitespace
see
org.xml.sax.Locator

    if(isOutsideDocElem()
       && com.sun.org.apache.xml.internal.utils.XMLCharacterRecognizer.isWhiteSpace(ch, start, length))
      return;  // avoid DOM006 Hierarchy request error

    String s = new String(ch, start, length);

    CDATASection section  =(CDATASection) m_currentNode.getLastChild();
    section.appendData(s);
  
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. 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).

param
ch The characters from the XML document.
param
start The start position in the array.
param
length The number of characters to read from the array.
see
#ignorableWhitespace
see
org.xml.sax.Locator

    if(isOutsideDocElem()
       && com.sun.org.apache.xml.internal.utils.XMLCharacterRecognizer.isWhiteSpace(ch, start, length))
      return;  // avoid DOM006 Hierarchy request error

    if (m_inCData)
    {
      cdata(ch, start, length);

      return;
    }

    String s = new String(ch, start, length);
    Node childNode;
    childNode =  m_currentNode != null ? m_currentNode.getLastChild(): null;
    if( childNode != null && childNode.getNodeType() == Node.TEXT_NODE ){
       ((Text)childNode).appendData(s);
    }
    else{
       Text text = m_doc.createTextNode(s);
       append(text);
    }
  
public voidcharactersRaw(char[] ch, int start, int length)
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".

param
ch Array containing the characters
param
start Index to start of characters in the array
param
length Number of characters in the array

    if(isOutsideDocElem()
       && com.sun.org.apache.xml.internal.utils.XMLCharacterRecognizer.isWhiteSpace(ch, start, length))
      return;  // avoid DOM006 Hierarchy request error


    String s = new String(ch, start, length);

    append(m_doc.createProcessingInstruction("xslt-next-is-raw",
                                             "formatter-to-dom"));
    append(m_doc.createTextNode(s));
  
public voidcomment(char[] ch, int start, int length)
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).

param
ch An array holding the characters in the comment.
param
start The starting position in the array.
param
length The number of characters to use from the array.

    append(m_doc.createComment(new String(ch, start, length)));
  
public voidendCDATA()
Report the end of a CDATA section.

see
#startCDATA

    m_inCData = false;
  
public voidendDTD()
Report the end of DTD declarations.

see
#startDTD


    // Do nothing for now.
  
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. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.


    // No action for the moment.
  
public voidendElement(java.lang.String ns, java.lang.String localName, java.lang.String name)
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.

param
ns the namespace of the element
param
localName The local part of the qualified name of the element
param
name The element name

    m_elemStack.pop();
    m_currentNode = m_elemStack.isEmpty() ? null : (Node)m_elemStack.peek();
  
public voidendEntity(java.lang.String name)
Report the end of an entity.

param
name The name of the entity that is ending.
see
#startEntity

public voidendPrefixMapping(java.lang.String prefix)
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.

param
prefix The prefix that was being mapping.
see
#startPrefixMapping
see
#endElement

public voidentityReference(java.lang.String name)
Receive notivication of a entityReference.

param
name name of the entity reference

    append(m_doc.createEntityReference(name));
  
public org.w3c.dom.NodegetCurrentNode()
Get the node currently being processed.

return
the current node being processed

    return m_currentNode;
  
public org.w3c.dom.NodegetNextSibling()
Return the next sibling node.

return
the next sibling node.

    return m_nextSibling;
  
public org.w3c.dom.NodegetRootDocument()
Get the root document or DocumentFragment of the DOM being created.

return
The root document or document fragment if not null

    return (null != m_docFrag) ? (Node) m_docFrag : (Node) m_doc;
  
public org.w3c.dom.NodegetRootNode()
Get the root node of the DOM tree.

    return m_root;
  
public java.io.WritergetWriter()
Return null since there is no Writer for this class.

return
null

    return null;
  
public voidignorableWhitespace(char[] ch, int start, int length)
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.

param
ch The characters from the XML document.
param
start The start position in the array.
param
length The number of characters to read from the array.
see
#characters

    if(isOutsideDocElem())
      return;  // avoid DOM006 Hierarchy request error

    String s = new String(ch, start, length);

    append(m_doc.createTextNode(s));
  
private booleanisOutsideDocElem()
Tell if the current node is outside the document element.

return
true if the current node is outside the document element.

      return (null == m_docFrag) && m_elemStack.size() == 0 && (null == m_currentNode || m_currentNode.getNodeType() == Node.DOCUMENT_NODE);
   
public voidprocessingInstruction(java.lang.String target, java.lang.String data)
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.

param
target The processing instruction target.
param
data The processing instruction data, or null if none was supplied.

    append(m_doc.createProcessingInstruction(target, data));
  
public voidsetDocumentLocator(org.xml.sax.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. 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.

param
locator An object that can return the location of any SAX document event.
see
org.xml.sax.Locator


    // No action for the moment.
  
public voidsetIDAttribute(java.lang.String id, org.w3c.dom.Element elem)
Set an ID string to node association in the ID table.

param
id The ID string.
param
elem The associated ID.


    // Do nothing. This method is meant to be overiden.
  
public voidsetNextSibling(org.w3c.dom.Node nextSibling)
Set the next sibling node, which is where the result nodes should be inserted before.

param
nextSibling the next sibling node.

    m_nextSibling = nextSibling;
  
public voidskippedEntity(java.lang.String name)
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.

param
name The name of the skipped entity. If it is a parameter entity, the name will begin with '%'.

public voidstartCDATA()
Report the start of a CDATA section.

see
#endCDATA


              
      
  
    m_inCData = true;
    append(m_doc.createCDATASection(""));
  
public voidstartDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
Report the start of DTD declarations, if any. Any declarations are assumed to be in the internal subset unless otherwise indicated.

param
name The document type name.
param
publicId The declared public identifier for the external DTD subset, or null if none was declared.
param
systemId The declared system identifier for the external DTD subset, or null if none was declared.
see
#endDTD
see
#startEntity


    // Do nothing for now.
  
public voidstartDocument()
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).


    // No action for the moment.
  
public voidstartElement(java.lang.String ns, java.lang.String localName, java.lang.String name, org.xml.sax.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). 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.

param
ns The namespace of the node
param
localName The local part of the qualified name
param
name The element name.
param
atts The attributes attached to the element, if any.
see
#endElement
see
org.xml.sax.Attributes


    Element elem;

	// Note that the namespace-aware call must be used to correctly
	// construct a Level 2 DOM, even for non-namespaced nodes.
    if ((null == ns) || (ns.length() == 0))
      elem = m_doc.createElementNS(null,name);
    else
      elem = m_doc.createElementNS(ns, name);

    append(elem);

    try
    {
      int nAtts = atts.getLength();

      if (0 != nAtts)
      {
        for (int i = 0; i < nAtts; i++)
        {

          //System.out.println("type " + atts.getType(i) + " name " + atts.getLocalName(i) );
          // First handle a possible ID attribute
          if (atts.getType(i).equalsIgnoreCase("ID"))
            setIDAttribute(atts.getValue(i), elem);

          String attrNS = atts.getURI(i);

          if("".equals(attrNS))
            attrNS = null; // DOM represents no-namespace as null

          // System.out.println("attrNS: "+attrNS+", localName: "+atts.getQName(i)
          //                   +", qname: "+atts.getQName(i)+", value: "+atts.getValue(i));
          // Crimson won't let us set an xmlns: attribute on the DOM.
          String attrQName = atts.getQName(i);

          // In SAX, xmlns[:] attributes have an empty namespace, while in DOM they 
          // should have the xmlns namespace
          if (attrQName.startsWith("xmlns:") || attrQName.equals("xmlns")) {
            attrNS = "http://www.w3.org/2000/xmlns/";
          }

          // ALWAYS use the DOM Level 2 call!
          elem.setAttributeNS(attrNS,attrQName, atts.getValue(i));
        }
      }

      // append(elem);

      m_elemStack.push(elem);

      m_currentNode = elem;

      // append(elem);
    }
    catch(java.lang.Exception de)
    {
      // de.printStackTrace();
      throw new org.xml.sax.SAXException(de);
    }

  
public voidstartEntity(java.lang.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]". All other events must be properly nested within start/end entity events.

param
name The name of the entity. If it is a parameter entity, the name will begin with '%'.
see
#endEntity
see
org.xml.sax.ext.DeclHandler#internalEntityDecl
see
org.xml.sax.ext.DeclHandler#externalEntityDecl


    // Almost certainly the wrong behavior...
    // entityReference(name);
  
public voidstartPrefixMapping(java.lang.String prefix, java.lang.String uri)
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.

param
prefix The Namespace prefix being declared.
param
uri The Namespace URI the prefix is mapped to.
see
#endPrefixMapping
see
#startElement


    /*
    // Not sure if this is needed or wanted
    // Also, it fails in the stree.
    if((null != m_currentNode)
       && (m_currentNode.getNodeType() == Node.ELEMENT_NODE))
    {
      String qname;
      if(((null != prefix) && (prefix.length() == 0))
         || (null == prefix))
        qname = "xmlns";
      else
        qname = "xmlns:"+prefix;

      Element elem = (Element)m_currentNode;
      String val = elem.getAttribute(qname); // Obsolete, should be DOM2...?
      if(val == null)
      {
        elem.setAttributeNS("http://www.w3.org/XML/1998/namespace",
                            qname, uri);
      }
    }
    */