|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Receiver
Receiver: This interface represents a recipient of XML tree-walking events. It is based on SAX2's ContentHandler, but adapted to handle additional events, and to use Saxon's name pool. Namespaces and Attributes are handled by separate events following the startElement event. Schema types can be defined for elements and attributes. This interface is designed as an eventual replacement for the old Emitter class, as well as the Outputter interface. The name change from "Emitter" to "Receiver" reflects that the essence of the interface is that all implementations receive notification of these events; they do very different things with the events once recieved.
Field Summary |
---|
Fields inherited from interface javax.xml.transform.Result |
---|
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
Method Summary | |
---|---|
void |
attribute(int nameCode,
int typeCode,
CharSequence value,
int properties)
Notify an attribute. |
void |
characters(CharSequence chars,
int properties)
Notify character data. |
void |
comment(CharSequence content,
int properties)
Notify a comment. |
void |
endDocument()
Notify the end of the document |
void |
endElement()
Notify the end of an element. |
NamePool |
getNamePool()
Get the namePool in which all name codes can be found |
void |
namespace(int namespaceCode,
int properties)
Notify a namespace. |
void |
processingInstruction(String name,
CharSequence data,
int properties)
Output a processing instruction |
void |
setDocumentLocator(Locator locator)
Set locator, to identify position in the document. |
void |
setNamePool(NamePool namePool)
Set the namePool in which all name codes can be found |
void |
setSystemId(String systemId)
Set the System ID of the destination tree |
void |
setUnparsedEntity(String name,
String systemID,
String publicID)
Notify an unparsed entity URI. |
void |
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces. |
void |
startDocument()
Notify the start of the document |
void |
startElement(int nameCode,
int typeCode,
int properties)
Notify the start of an element |
Methods inherited from interface javax.xml.transform.Result |
---|
getSystemId |
Method Detail |
---|
void setNamePool(NamePool namePool)
NamePool getNamePool()
void setSystemId(String systemId)
setSystemId
in interface Result
void setDocumentLocator(Locator locator) throws TransformerException
TransformerException
void startDocument() throws TransformerException
TransformerException
void setUnparsedEntity(String name, String systemID, String publicID) throws TransformerException
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity
TransformerException
void startElement(int nameCode, int typeCode, int properties) throws TransformerException
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.
TransformerException
void namespace(int namespaceCode, int properties) throws TransformerException
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.
IllegalStateException:
- attempt to output a namespace when there is no open element
start tag
TransformerException
void attribute(int nameCode, int typeCode, CharSequence value, int properties) throws TransformerException
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:
IllegalStateException:
- attempt to output an attribute when there is no open element
start tag
TransformerException
void startContent() throws TransformerException
TransformerException
void endElement() throws TransformerException
TransformerException
void characters(CharSequence chars, int properties) throws TransformerException
chars
- The charactersproperties
- Bit significant value. The following bits are defined:
TransformerException
void processingInstruction(String name, CharSequence data, int properties) throws TransformerException
name
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionproperties
- Additional information about the PI. The following bits are
defined:
IllegalArgumentException:
- the content is invalid for an XML processing instruction
TransformerException
void comment(CharSequence content, int properties) throws TransformerException
content
- The content of the commentproperties
- Additional information about the comment. The following bits are
defined:
IllegalArgumentException:
- the content is invalid for an XML comment
TransformerException
void endDocument() throws TransformerException
TransformerException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |