public class ICEXMLSerializer extends Object implements ContentHandler, DeclHandler
Copyright 2004 SAP AG
ICEItem
Constructor and Description |
---|
ICEXMLSerializer(OutputStream output)
Create a new ICEXMLSerializer.
|
Modifier and Type | Method and Description |
---|---|
void |
attributeDecl(String eName,
String aName,
String type,
String valueDefault,
String value)
Report an attribute type declaration.
|
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data.
|
void |
elementDecl(String name,
String model)
Report an element type declaration.
|
void |
endDocument()
Receive notification of the end of a document.
|
void |
endElement(String namespaceURI,
String localName,
String qName)
Receive notification of the end of an element.
|
void |
endPrefixMapping(String prefix)
End the scope of a prefix-URI mapping.
|
void |
externalEntityDecl(String name,
String publicId,
String systemId)
Report a parsed external entity declaration.
|
ICEBase64Encoder |
getBase64Output()
Get a Base64 OutputStream that shortcuts the XML serializer.
|
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content.
|
void |
internalEntityDecl(String name,
String value)
Report an internal entity declaration.
|
void |
processingInstruction(String target,
String data)
Receive notification of a processing instruction.
|
void |
setDocumentLocator(Locator locator)
Receive an object for locating the origin of SAX document events.
|
void |
skippedEntity(String name)
Receive notification of a skipped entity.
|
void |
startDocument()
Receive notification of the beginning of a document.
|
void |
startElement(String namespaceURI,
String localName,
String qName,
Attributes atts)
Receive notification of the beginning of an element.
|
void |
startPrefixMapping(String prefix,
String uri)
Begin the scope of a prefix-URI Namespace mapping.
|
public ICEXMLSerializer(OutputStream output) throws IOException
output
- The OutputStream to serialize the XML data toIOException
- Exception raised in failure situationIOException
- If an I/O error occurspublic void setDocumentLocator(Locator locator)
SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.
The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.
Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.
setDocumentLocator
in interface ContentHandler
locator
- An object that can return the location of any SAX document event.Locator
public ICEBase64Encoder getBase64Output() throws SAXException
SAXException
- on errorpublic void startDocument() throws SAXException
The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler
(except for setDocumentLocator
).
startDocument
in interface ContentHandler
SAXException
- Exception raised in failure situationendDocument()
public void endDocument() throws SAXException
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
endDocument
in interface ContentHandler
SAXException
- Exception raised in failure situationstartDocument()
public void startPrefixMapping(String prefix, String uri) throws SAXException
The information from this event is not necessary for normal Namespace processing: the SAX XML reader will
automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces
feature is true (the default).
There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.
Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each-other: all
startPrefixMapping events will occur before the corresponding startElement
event, and all
endPrefixMapping
events will occur after the corresponding endElement
event, but their order is not otherwise guaranteed.
There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.
startPrefixMapping
in interface ContentHandler
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.SAXException
- Exception raised in failure situationendPrefixMapping(java.lang.String)
,
startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void endPrefixMapping(String prefix) throws SAXException
See startPrefixMapping
for details. This event will always occur after the
corresponding endElement
event, but the order of endPrefixMapping
events is not otherwise guaranteed.
endPrefixMapping
in interface ContentHandler
prefix
- The prefix that was being mapping.SAXException
- Exception raised in failure situationstartPrefixMapping(java.lang.String, java.lang.String)
,
endElement(java.lang.String, java.lang.String, java.lang.String)
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException
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.
This event allows up to three name components for each element:
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
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
(xmlns* attributes) only if the http://xml.org/sax/features/namespace-prefixes
property is true (it is
false by default, and support for a true value is optional).
startElement
in interface ContentHandler
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 Attributes object.namespaceURI
- namespaceURISAXException
- Exception raised in failure situationendElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void endElement(String namespaceURI, String localName, String qName) throws SAXException
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).
For information on the names, see startElement.
endElement
in interface ContentHandler
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 empty string if qualified
names are not available.namespaceURI
- namespaceURISAXException
- Exception raised in failure situationpublic void characters(char[] ch, int start, int length) throws SAXException
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 content using the ignorableWhitespace
method rather than this one (validating parsers must do so).
characters
in interface ContentHandler
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.SAXException
- Exception raised in failure situationignorableWhitespace(char[], int, int)
,
Locator
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace 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.
ignorableWhitespace
in interface ContentHandler
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.SAXException
- Exception raised in failure situationcharacters(char[], int, int)
public void processingInstruction(String target, String data) throws SAXException
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.
processingInstruction
in interface ContentHandler
target
- The processing instruction target.data
- The processing instruction data, or null if none was supplied. The data does
not include any whitespace separating it from the target.SAXException
- Exception raised in failure situationpublic void skippedEntity(String name) throws SAXException
The Parser will invoke this method once for each entity skipped. Non-validating processors may skip entities if
they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All
processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities
and the http://xml.org/sax/features/external-parameter-entities
properties.
skippedEntity
in interface ContentHandler
name
- The name of the skipped entity. If it is a parameter entity, the name will
begin with '%', and if it is the external DTD subset, it will be the string "[dtd]".SAXException
- Exception raised in failure situationpublic void elementDecl(String name, String model) throws SAXException
The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all parameter entities are fully resolved and all whitespace is removed,and will include the enclosing parentheses. Other normalization (such as removing redundant parentheses or simplifying occurrence indicators) is at the discretion of the parser.
elementDecl
in interface DeclHandler
name
- The element type name.model
- The content model as a normalized string.SAXException
- The application may raise an exception.public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException
Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", a parenthesized token group with the separator "|" and all whitespace removed, or the word "NOTATION" followed by a space followed by a parenthesized token group with all whitespace removed.
Any parameter entities in the attribute value will be expanded, but general entities will not.
attributeDecl
in interface DeclHandler
eName
- The name of the associated element.aName
- The name of the attribute.type
- A string representing the attribute type.valueDefault
- A string representing the attribute default ("#IMPLIED", "#REQUIRED", or "#FIXED") or null
if none of these applies.value
- A string representing the attribute's default value, or null if there is none.SAXException
- The application may raise an exception.public void internalEntityDecl(String name, String value) throws SAXException
Only the effective (first) declaration for each entity will be reported. All parameter entities in the value will be expanded, but general entities will not.
internalEntityDecl
in interface DeclHandler
name
- The name of the entity. If it is a parameter entity, the name will begin with '%'.value
- The replacement text of the entity.SAXException
- The application may raise an exception.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
,
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException
Only the effective (first) declaration for each entity will be reported.
externalEntityDecl
in interface DeclHandler
name
- The name of the entity. If it is a parameter entity, the name will begin with '%'.publicId
- The declared public identifier of the entity, or null if none was declared.systemId
- The declared system identifier of the entity.SAXException
- The application may raise an exception.internalEntityDecl(java.lang.String, java.lang.String)
,
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice