|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SerializationHandler
This interface is the one that a serializer implements. It is a group of other interfaces, such as ExtendedContentHandler, ExtendedLexicalHandler etc. In addition there are other methods, such as reset(). This class is public only because it is used in another package, it is not a public API.
Field Summary | |
---|---|
static int |
HTML_ATTREMPTY
|
static int |
HTML_ATTRURL
|
static int |
NO_BAD_CHARS
|
Method Summary | |
---|---|
void |
addAttribute(java.lang.String qName,
java.lang.String value)
Add an attribute to the current element. |
void |
addAttribute(java.lang.String uri,
java.lang.String localName,
java.lang.String rawName,
java.lang.String type,
java.lang.String value)
Add at attribute to the current element, not from an xsl:attribute element. |
void |
addAttribute(java.lang.String uri,
java.lang.String localName,
java.lang.String rawName,
java.lang.String type,
java.lang.String value,
boolean XSLAttribute)
Add at attribute to the current element |
void |
addAttributes(org.xml.sax.Attributes atts)
Add attributes to the current element |
void |
addUniqueAttribute(java.lang.String qName,
java.lang.String value,
int flags)
Add a unique attribute to the current element. |
void |
addXSLAttribute(java.lang.String qName,
java.lang.String value,
java.lang.String uri)
Add an attribute from an xsl:attribute element. |
void |
characters(org.w3c.dom.Node node)
This method is used to notify of a character event, but passing the data as a DOM Node rather than the standard character array. |
void |
characters(java.lang.String chars)
This method is used to notify of a character event, but passing the data as a character String rather than the standard character array. |
void |
close()
|
void |
comment(java.lang.String comment)
This method is used to notify of a comment |
void |
endElement(java.lang.String elemName)
This method is used to notify that an element has ended. |
void |
entityReference(java.lang.String entityName)
Notify of an entity reference. |
void |
flushPending()
Flush any pending events currently queued up in the serializer. |
java.lang.String |
getDoctypePublic()
Returns the previously set value of the value to be used as the public identifier in the document type declaration (DTD). |
java.lang.String |
getDoctypeSystem()
Returns the previously set value of the value to be used as the system identifier in the document type declaration (DTD). |
java.lang.String |
getEncoding()
|
boolean |
getIndent()
|
int |
getIndentAmount()
|
java.lang.String |
getMediaType()
|
NamespaceMappings |
getNamespaceMappings()
This method returns an object that has the current namespace mappings in effect. |
java.lang.String |
getNamespaceURI(java.lang.String name,
boolean isElement)
This method gets the prefix associated with a current element or attribute name. |
java.lang.String |
getNamespaceURIFromPrefix(java.lang.String prefix)
This method returns the namespace URI currently associated with the prefix. |
boolean |
getOmitXMLDeclaration()
|
java.lang.String |
getPrefix(java.lang.String uri)
This method returns the prefix that currently maps to the given namespace URI. |
java.lang.String |
getStandalone()
|
javax.xml.transform.Transformer |
getTransformer()
Get the transformer associated with the serializer. |
java.lang.String |
getVersion()
|
void |
namespaceAfterStartElement(java.lang.String uri,
java.lang.String prefix)
This method is used to notify that a prefix mapping is to start, but after an element is started. |
void |
serialize(org.w3c.dom.Node node)
Notify that the serializer should take this DOM node as input to be serialized. |
void |
setCdataSectionElements(java.util.Vector URI_and_localNames)
Sets the value coming from the xsl:output cdata-section-elements stylesheet property. |
void |
setContentHandler(org.xml.sax.ContentHandler ch)
Set the SAX Content handler that the serializer sends its output to. |
void |
setDoctype(java.lang.String system,
java.lang.String pub)
Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties |
void |
setDoctypePublic(java.lang.String doctype)
Set the value coming from the xsl:output doctype-public stylesheet attribute. |
void |
setDoctypeSystem(java.lang.String doctype)
Set the value coming from the xsl:output doctype-system stylesheet attribute. |
void |
setDTDEntityExpansion(boolean expand)
Default behavior is to expand DTD entities, that is the initall default value is true. |
void |
setEncoding(java.lang.String encoding)
Sets the character encoding coming from the xsl:output encoding stylesheet attribute. |
boolean |
setEscaping(boolean escape)
Turns special character escaping on/off. |
void |
setIndent(boolean indent)
Sets the value coming from the xsl:output indent stylesheet attribute. |
void |
setIndentAmount(int spaces)
Set the number of spaces to indent for each indentation level. |
void |
setMediaType(java.lang.String mediatype)
Sets the value coming from the xsl:output media-type stylesheet attribute. |
void |
setNamespaceMappings(NamespaceMappings mappings)
Used only by TransformerSnapshotImpl to restore the serialization to a previous state. |
void |
setOmitXMLDeclaration(boolean b)
Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute |
void |
setSourceLocator(javax.xml.transform.SourceLocator locator)
This method is used to set the source locator, which might be used to generated an error message. |
void |
setStandalone(java.lang.String standalone)
Sets the value coming from the xsl:output standalone stylesheet attribute. |
void |
setTransformer(javax.xml.transform.Transformer transformer)
Set the transformer associated with the serializer. |
void |
setVersion(java.lang.String version)
Sets the value coming from the xsl:output version attribute. |
void |
startElement(java.lang.String qName)
This method is used to notify of the start of an element |
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
This method is used to notify that an element is starting. |
boolean |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri,
boolean shouldFlush)
This method is used to notify that a prefix maping is to start, which can be for the current element, or for the one to come. |
Methods inherited from interface org.xml.sax.ContentHandler |
---|
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping |
Methods inherited from interface org.xml.sax.ext.LexicalHandler |
---|
comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity |
Methods inherited from interface org.xml.sax.ext.DeclHandler |
---|
attributeDecl, elementDecl, externalEntityDecl, internalEntityDecl |
Methods inherited from interface org.xml.sax.DTDHandler |
---|
notationDecl, unparsedEntityDecl |
Methods inherited from interface org.xml.sax.ErrorHandler |
---|
error, fatalError, warning |
Methods inherited from interface org.ajax4jsf.xml.serializer.Serializer |
---|
asContentHandler, asDOMSerializer, getOutputFormat, getOutputStream, getWriter, reset, setOutputFormat, setOutputStream, setWriter |
Field Detail |
---|
static final int NO_BAD_CHARS
static final int HTML_ATTREMPTY
static final int HTML_ATTRURL
Method Detail |
---|
void setContentHandler(org.xml.sax.ContentHandler ch)
Serializer.asContentHandler()
,
ToSAXHandler
void close()
void serialize(org.w3c.dom.Node node) throws java.io.IOException
serialize
in interface DOMSerializer
node
- the DOM node to be serialized.
java.io.IOException
boolean setEscaping(boolean escape) throws org.xml.sax.SAXException
escape
- true if escaping is to be set on.
org.xml.sax.SAXException
void setIndentAmount(int spaces)
spaces
- the number of spaces to indent for each indentation level.void setTransformer(javax.xml.transform.Transformer transformer)
transformer
- the transformer associated with the serializer.javax.xml.transform.Transformer getTransformer()
void setNamespaceMappings(NamespaceMappings mappings)
mappings
- NamespaceMappingsvoid flushPending() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void setDTDEntityExpansion(boolean expand)
expand
- true if DTD entities are to be expanded,
false if they are to be left as DTD entity references.void addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value, boolean XSLAttribute) throws org.xml.sax.SAXException
uri
- the namespace URI of the attribute namelocalName
- the local name of the attribute (without prefix)rawName
- the qualified name of the attributetype
- the attribute type typically character data (CDATA)value
- the value of the attributeXSLAttribute
- true if the added attribute is coming from an xsl:attribute element
org.xml.sax.SAXException
void addAttributes(org.xml.sax.Attributes atts) throws org.xml.sax.SAXException
atts
- the attributes to add.
org.xml.sax.SAXException
void addAttribute(java.lang.String qName, java.lang.String value)
qName
- value
- void characters(java.lang.String chars) throws org.xml.sax.SAXException
chars
- the character data
org.xml.sax.SAXException
void characters(org.w3c.dom.Node node) throws org.xml.sax.SAXException
node
- a DOM Node containing text.
org.xml.sax.SAXException
void endElement(java.lang.String elemName) throws org.xml.sax.SAXException
endElement(namespaceURI,localName,qName)only the last parameter is passed. If needed the serializer can derive the localName from the qualified name and derive the namespaceURI from its implementation.
elemName
- the fully qualified element name.
org.xml.sax.SAXException
void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
startElement(uri,localName,qname,atts)but without the attributes.
uri
- the namespace URI of the elementlocalName
- the local name (without prefix) of the elementqName
- the qualified name of the element
org.xml.sax.SAXException
void startElement(java.lang.String qName) throws org.xml.sax.SAXException
qName
- the fully qualified name of the element
org.xml.sax.SAXException
void namespaceAfterStartElement(java.lang.String uri, java.lang.String prefix) throws org.xml.sax.SAXException
startPrefixMapping(prefix,uri)is used just before an element starts and applies to the element to come, not to the current element. This method applies to the current element. For example one could make the calls in this order:
startElement("prfx8:elem9") namespaceAfterStartElement("http://namespace8","prfx8")
uri
- the namespace URI being declaredprefix
- the prefix that maps to the given namespace
org.xml.sax.SAXException
boolean startPrefixMapping(java.lang.String prefix, java.lang.String uri, boolean shouldFlush) throws org.xml.sax.SAXException
prefix
- the prefix that maps to the given URIuri
- the namespace URI of the given prefixshouldFlush
- if true this call is like the SAX
startPrefixMapping(prefix,uri) call and the mapping applies to the
element to come. If false the mapping applies to the current element.
org.xml.sax.SAXException
void entityReference(java.lang.String entityName) throws org.xml.sax.SAXException
entityName
- the name of the entity
org.xml.sax.SAXException
NamespaceMappings getNamespaceMappings()
java.lang.String getPrefix(java.lang.String uri)
uri
- the namespace URI
java.lang.String getNamespaceURI(java.lang.String name, boolean isElement)
name
- the qualified name of an element, or attributeisElement
- true if it is an element name, false if it is an
atttribute name
java.lang.String getNamespaceURIFromPrefix(java.lang.String prefix)
prefix
- a prefix of an element or attribute.
void setSourceLocator(javax.xml.transform.SourceLocator locator)
locator
- the source locatorvoid addUniqueAttribute(java.lang.String qName, java.lang.String value, int flags) throws org.xml.sax.SAXException
qName
- the fully qualified attribute name.value
- the attribute valueflags
- a bitwise flag
org.xml.sax.SAXException
void addXSLAttribute(java.lang.String qName, java.lang.String value, java.lang.String uri)
qName
- the qualified attribute name (prefix:localName)value
- the attributes valueuri
- the uri that the prefix of the qName is mapped to.void addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value) throws org.xml.sax.SAXException
uri
- the namespace URI of the attribute namelocalName
- the local name of the attribute (without prefix)rawName
- the qualified name of the attributetype
- the attribute type typically character data (CDATA)value
- the value of the attribute
org.xml.sax.SAXException
void comment(java.lang.String comment) throws org.xml.sax.SAXException
comment
- the comment, but unlike the SAX comment() method this
method takes a String rather than a character array.
org.xml.sax.SAXException
java.lang.String getDoctypePublic()
java.lang.String getDoctypeSystem()
java.lang.String getEncoding()
boolean getIndent()
int getIndentAmount()
java.lang.String getMediaType()
boolean getOmitXMLDeclaration()
java.lang.String getStandalone()
standalone
delaration is to
be included in the output document.java.lang.String getVersion()
void setCdataSectionElements(java.util.Vector URI_and_localNames)
URI_and_localNames
- pairs of namespace URI and local names that
identify elements whose text elements are to be output as CDATA sections.
The namespace of the local element must be the given URI to match. The
qName is not given because the prefix does not matter, only the namespace
URI to which that prefix would map matters, so the prefix itself is not
relevant in specifying which elements have their text to be output as
CDATA sections.void setDoctype(java.lang.String system, java.lang.String pub)
system
- the system identifier to be used in the DOCTYPE declaration
in the output document.pub
- the public identifier to be used in the DOCTYPE declaration in
the output document.void setDoctypePublic(java.lang.String doctype)
doctype
- the public identifier to be used in the DOCTYPE
declaration in the output document.void setDoctypeSystem(java.lang.String doctype)
doctype
- the system identifier to be used in the DOCTYPE
declaration in the output document.void setEncoding(java.lang.String encoding)
encoding
- the character encodingvoid setIndent(boolean indent)
indent
- true if the output document should be indented to visually
indicate its structure.void setMediaType(java.lang.String mediatype)
mediatype
- the media-type or MIME type associated with the output
document.void setOmitXMLDeclaration(boolean b)
b
- true if the XML declaration is to be omitted from the output
document.void setStandalone(java.lang.String standalone)
standalone
- a value of "yes" indicates that the
standalone
delaration is to be included in the output
document.void setVersion(java.lang.String version)
version
- the version of the output format.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |