public abstract class ProxyReceiver extends SequenceReceiver
| Modifier and Type | Field and Description |
|---|---|
protected Receiver |
nextReceiver |
pipelineConfiguration, previousAtomic, systemIdPI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING| Constructor and Description |
|---|
ProxyReceiver(Receiver nextReceiver) |
| Modifier and Type | Method and Description |
|---|---|
void |
append(Item item,
int locationId,
int copyNamespaces)
Append an arbitrary item (node or atomic value) to the output
|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
CharSequence value,
int locationId,
int properties)
Notify an attribute.
|
void |
characters(CharSequence chars,
int locationId,
int properties)
Character data
|
void |
close()
End of output.
|
void |
comment(CharSequence chars,
int locationId,
int properties)
Output a comment
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
End of element
|
NamePool |
getNamePool()
Get the namepool for this configuration
|
Receiver |
getUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline)
|
void |
namespace(NamespaceBinding namespaceBinding,
int properties)
Notify a namespace.
|
void |
open()
Start of event stream
|
void |
processingInstruction(String target,
CharSequence data,
int locationId,
int properties)
Processing Instruction
|
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration
|
void |
setSystemId(String systemId)
Set the system ID
|
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(int properties)
Start of a document node.
|
void |
startElement(NodeName elemName,
SchemaType typeCode,
int locationId,
int properties)
Notify the start of an element
|
boolean |
usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events
|
append, getConfiguration, getPipelineConfiguration, getSystemIdprotected Receiver nextReceiver
public ProxyReceiver(Receiver nextReceiver)
public void setSystemId(String systemId)
SequenceReceiversetSystemId in interface ResultsetSystemId in interface ReceiversetSystemId in class SequenceReceiversystemId - the URI used to identify the tree being passed across this interfacepublic void setUnderlyingReceiver(Receiver receiver)
receiver - the underlying receiver, the one that is to receive events after processing
by this filter.public Receiver getUnderlyingReceiver()
public void setPipelineConfiguration(PipelineConfiguration pipe)
ReceiversetPipelineConfiguration in interface ReceiversetPipelineConfiguration in class SequenceReceiverpipe - the pipeline configurationpublic NamePool getNamePool()
getNamePool in class SequenceReceiverpublic void open()
throws XPathException
open in interface Receiveropen in class SequenceReceiverXPathException - if an error occurspublic void close()
throws XPathException
XPathException - if an error occurspublic void startDocument(int properties)
throws XPathException
properties - bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptionsXPathException - if an error occurspublic void endDocument()
throws XPathException
XPathException - if an error occurspublic void startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties) throws XPathException
elemName - 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 - properties of the element nodelocationId - an integer which can be interpreted using a LocationProvider to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.XPathException - if an error occurspublic void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
namespaceBinding - the prefix/uri pair representing the namespace bindingproperties - any special properties to be passed on this callIllegalStateException: - attempt to output a namespace when there is no open element
start tagXPathException - if an error occurspublic void attribute(NodeName nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
nameCode - The name of the attribute, as held in the name pooltypeCode - The type of the attribute, as held in the name poolproperties - Bit significant value. The following bits are defined:
value - the string value of the attributelocationId - an integer which can be interpreted using a LocationProvider to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.IllegalStateException: - attempt to output an attribute when there is no open element
start tagXPathException - if an error occurspublic void startContent()
throws XPathException
XPathException - if an error occurspublic void endElement()
throws XPathException
XPathException - if an error occurspublic void characters(CharSequence chars, int locationId, int properties) throws XPathException
chars - The characterslocationId - an integer which can be interpreted using a LocationProvider
to return information such as line number and system ID. If no location information is available,
the value zero is supplied.properties - Bit significant value. The following bits are defined:
XPathException - if an error occurspublic void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException
target - The PI name. This must be a legal name (it will not be checked).data - The data portion of the processing instructionlocationId - an integer which can be interpreted using a LocationProvider to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties - Additional information about the PI.XPathException - if an error occurspublic void comment(CharSequence chars, int locationId, int properties) throws XPathException
chars - The content of the commentlocationId - an integer which can be interpreted using a LocationProvider to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties - Additional information about the comment.XPathException - if an error occurspublic void setUnparsedEntity(String name, String uri, String publicId) throws XPathException
setUnparsedEntity in interface ReceiversetUnparsedEntity in class SequenceReceivername - The name of the unparsed entityuri - The system identifier of the unparsed entitypublicId - The public identifier of the unparsed entityXPathException - if an error occurspublic void append(Item item, int locationId, int copyNamespaces) throws XPathException
append in class SequenceReceiveritem - the item to be appendedlocationId - the location of the calling instruction, for diagnosticscopyNamespaces - if the item is an element node, this indicates whether its namespaces
need to be copied. Values are NodeInfo.ALL_NAMESPACES,
NodeInfo.LOCAL_NAMESPACES, NodeInfo.NO_NAMESPACESXPathException - if the operation failspublic boolean usesTypeAnnotations()
Copyright (c) 2004-2013 Saxonica Limited. All rights reserved.