net.sf.saxon.event
Class TEXTEmitter

java.lang.Object
  extended by net.sf.saxon.event.Emitter
      extended by net.sf.saxon.event.XMLEmitter
          extended by net.sf.saxon.event.TEXTEmitter
All Implemented Interfaces:
Result, Receiver

public class TEXTEmitter
extends XMLEmitter

This class generates TEXT output

Author:
Field Summary
 
Fields inherited from class net.sf.saxon.event.XMLEmitter
declarationIsWritten, elementCode, elementStack, empty, escaping, openStartTag, preferHex, specialInAtt, specialInText, undeclareNamespaces
 
Fields inherited from class net.sf.saxon.event.Emitter
characterSet, locator, namePool, outputProperties, outputStream, streamResult, systemId, writer
 
Constructor Summary
TEXTEmitter()
           
 
Method Summary
 void attribute(int nameCode, int typeCode, CharSequence value, int properties)
          Notify an attribute.
 void characters(CharSequence chars, int properties)
          Produce output using the current Writer.
 void comment(CharSequence chars, int properties)
          Output a comment.
 void endElement()
          Output an element end tag.
 void namespace(int namespaceCode, int properties)
          Notify a namespace.
 void processingInstruction(String name, CharSequence value, int properties)
          Output a processing instruction.
 void startDocument()
          Start of the document.
 void startElement(int nameCode, int typeCode, int properties)
          Output an element start tag.
 
Methods inherited from class net.sf.saxon.event.XMLEmitter
closeStartTag, emptyElementTagCloser, endDocument, openDocument, outputCharacterReference, setDocumentLocator, setUnparsedEntity, startContent, testCharacters, writeAttribute, writeDeclaration, writeDocType, writeEscape
 
Methods inherited from class net.sf.saxon.event.Emitter
getNamePool, getOutputProperties, getOutputStream, getSystemId, getWriter, makeEmitter, makeWriter, setNamePool, setOutputProperties, setOutputStream, setStreamResult, setSystemId, setUnparsedEntity, setWriter, usesWriter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TEXTEmitter

public TEXTEmitter()
Method Detail

startDocument

public void startDocument()
                   throws TransformerException
Start of the document.

Specified by:
startDocument in interface Receiver
Overrides:
startDocument in class XMLEmitter
Throws:
TransformerException

characters

public void characters(CharSequence chars,
                       int properties)
                throws TransformerException
Produce output using the current Writer.
Special characters are not escaped.

Specified by:
characters in interface Receiver
Overrides:
characters in class XMLEmitter
Parameters:
chars - Character sequence to be output
properties - bit fields holding special properties of the characters
Throws:
TransformerException - for any failure

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
Output an element start tag.
Does nothing with this output method.

Specified by:
startElement in interface Receiver
Overrides:
startElement in class XMLEmitter
Parameters:
nameCode - The element name (tag)
typeCode - The type annotation
properties - Bit fields holding any special properties of the element

namespace

public void namespace(int namespaceCode,
                      int properties)
Description copied from interface: Receiver
Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:
namespace in interface Receiver
Overrides:
namespace in class XMLEmitter
Parameters:
namespaceCode - an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.

attribute

public void attribute(int nameCode,
                      int typeCode,
                      CharSequence value,
                      int properties)
Description copied from interface: Receiver
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Specified by:
attribute in interface Receiver
Overrides:
attribute in class XMLEmitter
Parameters:
nameCode - The name of the attribute, as held in the name pool
typeCode - The type of the attribute, as held in the name pool
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this attribute
NO_SPECIAL_CHARACTERS
Attribute value contains no special characters

endElement

public void endElement()
Output an element end tag.
Does nothing with this output method.

Specified by:
endElement in interface Receiver
Overrides:
endElement in class XMLEmitter

processingInstruction

public void processingInstruction(String name,
                                  CharSequence value,
                                  int properties)
                           throws TransformerException
Output a processing instruction.
Does nothing with this output method.

Specified by:
processingInstruction in interface Receiver
Overrides:
processingInstruction in class XMLEmitter
Parameters:
name - The PI name. This must be a legal name (it will not be checked).
value - The data portion of the processing instruction
properties - Additional information about the PI. The following bits are defined:
CHECKED
Data is known to be legal (e.g. doesn't contain "?>")
Throws:
TransformerException

comment

public void comment(CharSequence chars,
                    int properties)
             throws TransformerException
Output a comment.
Does nothing with this output method.

Specified by:
comment in interface Receiver
Overrides:
comment in class XMLEmitter
Parameters:
chars - The content of the comment
properties - Additional information about the comment. The following bits are defined:
CHECKED
Comment is known to be legal (e.g. doesn't contain "--")
Throws:
TransformerException