net.sf.saxon.event
Class ProxyReceiver

java.lang.Object
  extended by net.sf.saxon.event.ProxyReceiver
All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
AnnotationRemover, CDATAFilter, CharacterMapExpander, CommentStripper, HTMLIndenter, NamePoolConverter, NamespaceReducer, PIGrabber, SequenceChecker, Stripper, TransformerReceiver, XMLIndenter

public abstract class ProxyReceiver
extends Object
implements Receiver

A ProxyReceiver is an Receiver that filters data before passing it to another underlying Receiver.


Field Summary
protected  Receiver baseReceiver
           
protected  NamePool namePool
           
protected  String systemId
           
 
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
 
Constructor Summary
ProxyReceiver()
           
 
Method Summary
 void attribute(int nameCode, int typeCode, CharSequence value, int properties)
          Notify an attribute.
 void characters(CharSequence chars, int properties)
          Character data
 void comment(CharSequence chars, int properties)
          Output a comment
 void endDocument()
          End of document
 void endElement()
          End of element
 NamePool getNamePool()
          Get the namePool in which all name codes can be found
 String getSystemId()
           
 Receiver getUnderlyingReceiver()
          Get the underlying Receiver (that is, the next one in the pipeline)
 void namespace(int namespaceCode, int properties)
          Notify a namespace.
 void processingInstruction(String target, CharSequence data, int properties)
          Processing Instruction
 void setDocumentLocator(Locator locator)
          Set the Document Locator
 void setNamePool(NamePool pool)
          Set the name pool to be used for all name codes
 void setSystemId(String systemId)
          Set the System ID of the destination tree
 void setUnderlyingReceiver(Receiver receiver)
          Set the underlying receiver.
 void setUnparsedEntity(String name, String uri, String publicId)
          Set the URI for an unparsed entity in the document.
 void startContent()
          Notify the start of the content, that is, the completion of all attributes and namespaces.
 void startDocument()
          Start of document
 void startElement(int nameCode, int typeCode, int properties)
          Notify the start of an element
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

baseReceiver

protected Receiver baseReceiver

namePool

protected NamePool namePool

systemId

protected String systemId
Constructor Detail

ProxyReceiver

public ProxyReceiver()
Method Detail

setSystemId

public void setSystemId(String systemId)
Description copied from interface: Receiver
Set the System ID of the destination tree

Specified by:
setSystemId in interface Result
Specified by:
setSystemId in interface Receiver

getSystemId

public String getSystemId()
Specified by:
getSystemId in interface Result

setUnderlyingReceiver

public void setUnderlyingReceiver(Receiver receiver)
Set the underlying receiver. This call is mandatory before using the Receiver.


getUnderlyingReceiver

public Receiver getUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline)


setNamePool

public void setNamePool(NamePool pool)
Set the name pool to be used for all name codes

Specified by:
setNamePool in interface Receiver

getNamePool

public NamePool getNamePool()
Description copied from interface: Receiver
Get the namePool in which all name codes can be found

Specified by:
getNamePool in interface Receiver

startDocument

public void startDocument()
                   throws TransformerException
Start of document

Specified by:
startDocument in interface Receiver
Throws:
TransformerException

endDocument

public void endDocument()
                 throws TransformerException
End of document

Specified by:
endDocument in interface Receiver
Throws:
TransformerException

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws TransformerException
Notify the start of an element

Specified by:
startElement in interface Receiver
Parameters:
nameCode - integer code identifying the name of the element within the name pool.
typeCode - integer code identifying the element's type within the name pool.
properties: - for future use. Should be set to zero.
Throws:
TransformerException

namespace

public void namespace(int namespaceCode,
                      int properties)
               throws TransformerException
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
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.
Throws:
IllegalStateException: - attempt to output a namespace when there is no open element start tag
TransformerException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      CharSequence value,
                      int properties)
               throws TransformerException
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
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
Throws:
IllegalStateException: - attempt to output an attribute when there is no open element start tag
TransformerException

startContent

public void startContent()
                  throws TransformerException
Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Specified by:
startContent in interface Receiver
Throws:
TransformerException

endElement

public void endElement()
                throws TransformerException
End of element

Specified by:
endElement in interface Receiver
Throws:
TransformerException

characters

public void characters(CharSequence chars,
                       int properties)
                throws TransformerException
Character data

Specified by:
characters in interface Receiver
Parameters:
chars - The characters
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this text node
USE_CDATA
Output as a CDATA section
NO_SPECIAL_CHARACTERS
Value contains no special characters
WHITESPACE
Text is all whitespace
Throws:
TransformerException

processingInstruction

public void processingInstruction(String target,
                                  CharSequence data,
                                  int properties)
                           throws TransformerException
Processing Instruction

Specified by:
processingInstruction in interface Receiver
Parameters:
target - The PI name. This must be a legal name (it will not be checked).
data - 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

Specified by:
comment in interface Receiver
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

setUnparsedEntity

public void setUnparsedEntity(String name,
                              String uri,
                              String publicId)
                       throws TransformerException
Set the URI for an unparsed entity in the document.

Specified by:
setUnparsedEntity in interface Receiver
Parameters:
name - The name of the unparsed entity
uri - The system identifier of the unparsed entity
publicId - The public identifier of the unparsed entity
Throws:
TransformerException

setDocumentLocator

public void setDocumentLocator(Locator locator)
                        throws TransformerException
Set the Document Locator

Specified by:
setDocumentLocator in interface Receiver
Throws:
TransformerException