Google

Xerces 3.1.1 API: Class TextSerializer
Overview  Package   Class  Tree  Deprecated  Index  Help 
Xerces 3.1.1
FRAMES    NO FRAMES
DETAIL:  FIELD | CONSTR | METHOD


Class TextSerializer

java.lang.Object
  |
        |

Implements a text serializer supporting both DOM and SAX

If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.

The serializer supports both DOM and SAX. DOM serializing is done SAX events and using the serializer as a document handler.

If an I/O exception occurs while serializing, the serializer will not throw an exception directly, but only throw it

Version:
$Revision: 1.7 $ $Date: 2000/08/30 18:59:22 $

 
          Constructs a new serializer.
Constructor Summary
  int start, int length)
          Receive notification of character data. boolean unescaped)
            int start, int length)
          Report an XML comment anywhere in the document.
           
          Receive notification of the end of an element. java.lang.String localName, java.lang.String rawName)
          Receive notification of the end of an element.
          Returns the suitable entity reference for this character value, or null if no such entity exists. java.lang.String code)
          Receive notification of a processing instruction.
          Called to serialize a DOM element.
          Serialize the DOM node.
          Specifies an output format for this serializer.
          Called to serialize the document's DOCTYPE by the root element.
          Receive notification of the beginning of an element. java.lang.String localName, java.lang.String rawName,
          Receive notification of the beginning of an element.
Method Summary
 void
protected  void
 void
 void

          Must be called by a method about to print any type of content.
 void
 void
protected  java.lang.String
 void
protected  void
protected  void
 void
protected  void
 void
 void
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextSerializer

public TextSerializer()
Constructs a new serializer. The serializer cannot be used without first.
Method Detail
setOutputFormat 


Specifies an output format for this serializer. It the
 serializer has already been associated with an output format,
 it will switch to the new format. This method should not be
 called while the serializer is in the process of serializing
 a document.






Parameters:
format - The output format to use








startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,



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
 (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. 
 
  2. the local name; and
    3. 
 
  3. the qualified (prefixed) name.
    4. 
 


 
Any or all of these may be provided, depending on the
 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
 property is true (it is false by default, and support for a 



Parameters:
uri - The Namespace URI, or the empty string if the
        element has no Namespace URI or if Namespace
        processing is not being performed.
localName - The local name (without prefix), or the
        empty string if Namespace processing is not being
        performed.
qName - The qualified name (with prefix), or the
        empty string if qualified names are not available.
atts - The attributes attached to the element.  If
        there are no attributes, it shall be an empty









endElement


public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)




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
 event (even when the element is empty).





Parameters:
uri - The Namespace URI, or the empty string if the
        element has no Namespace URI or if Namespace
        processing is not being performed.
localName - The local name (without prefix), or the
        empty string if Namespace processing is not being
        performed.
qName - The qualified XML 1.0 name (with prefix), or the
            wrapping another exception.








startElement

public void startElement(java.lang.String tagName,



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











endElement


public void endElement(java.lang.String tagName)




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


            wrapping another exception.










processingInstruction


public void processingInstruction(java.lang.String target,
                                  java.lang.String 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 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.






Parameters:
target - The processing instruction target.
data - The processing instruction data, or null if
        none was supplied.  The data does not include any
            wrapping another exception.










comment


public void comment(java.lang.String text)














comment


public void comment(char[] chars,
                    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).














characters


public void characters(char[] chars,
                       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 in element
 method rather than this one (validating parsers must 
 do so).














characters


protected void characters(java.lang.String text,
                          boolean unescaped)










startDocument


protected void startDocument(java.lang.String rootTagName)




Called to serialize the document's DOCTYPE by the root element.
 

 will serialize the document type declaration, and will serialize all
 pre-root comments and PIs that were accumulated in the document
 this is not the first root element of the document.






serializeElement


protected void serializeElement(Element elem)



 inbetween, but better optimized.






Parameters:
elem - The element to serialize










serializeNode


protected void serializeNode(Node node)




Serialize the DOM node. This method is unique to the Text serializer.






Parameters:
node - The node to serialize










content




Must be called by a method about to print any type of content.
 If the element was just opened, the opening tag is closed and
 will be matched to a closing tag. Returns the current element
 state with empty and afterElement set to false.






Returns:
The current element state










getEntityRef


protected java.lang.String getEntityRef(char ch)




Returns the suitable entity reference for this character value,
 or null if no such entity exists. Calling this method with '&'
 will return "&".






Parameters:
ch - Character value
Returns:
Character entity name, or null



















  

      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  





Xerces 3.1.1








  FRAMES   
 NO FRAMES






DETAIL:  FIELD | CONSTR | METHOD