Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.xml.serializer.SerializerBase
public abstract class SerializerBase
extends java.lang.Object
implements SerializationHandler, org.apache.xml.serializer.SerializerConstants
Field Summary | |
static String |
|
static String |
|
Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler | |
HTML_ATTREMPTY , HTML_ATTRURL , NO_BAD_CHARS |
Fields inherited from interface org.apache.xml.serializer.SerializerConstants | |
CDATA_CONTINUE , CDATA_DELIMITER_CLOSE , CDATA_DELIMITER_OPEN , DEFAULT_SAX_SERIALIZER , EMPTYSTRING , ENTITY_AMP , ENTITY_CRLF , ENTITY_GT , ENTITY_LT , ENTITY_QUOT , XMLNS_PREFIX , XMLNS_URI , XMLVERSION10 , XMLVERSION11 , XML_PREFIX |
Method Summary | |
void |
|
void |
|
void |
|
boolean |
|
void |
|
void |
|
ContentHandler |
|
Object |
|
DOMSerializer |
|
void |
|
void |
|
void |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
String |
|
String |
|
boolean | |
int | |
String |
|
NamespaceMappings |
|
String |
|
String |
|
boolean | |
String |
|
String |
|
String |
|
String |
|
String |
|
Transformer |
|
String |
|
void |
|
void |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public static final String PKG_NAME
The name of the package that this class is in. Not a public API.
public static final String PKG_PATH
The same as the name of the package that this class is in except that '.' are replaced with '/'. Not a public API.
public void addAttribute(String name, String value)
Adds the given attribute to the set of collected attributes, but only if there is a currently open element.
- Specified by:
- addAttribute in interface ExtendedContentHandler
- Parameters:
name
- the attribute's qualified namevalue
- the value of the attribute
public void addAttribute(String uri, String localName, String rawName, String type, String value) throws SAXException
This method adds an attribute the the current element, but should not be used for an xsl:attribute child.
- Specified by:
- addAttribute in interface ExtendedContentHandler
- See Also:
ExtendedContentHandler.addAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void addAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute) throws SAXException
Adds the given attribute to the set of collected attributes , but only if there is a currently open element. An element is currently open if a startElement() notification has occured but the start of the element has not yet been written to the output. In the stream case this means that we have not yet been forced to close the elements opening tag by another notification, such as a character notification.
- Specified by:
- addAttribute in interface ExtendedContentHandler
- Parameters:
uri
- the URI of the attributelocalName
- the local name of the attributerawName
- the qualified name of the attributetype
- the type of the attribute (probably CDATA)value
- the value of the attributeXSLAttribute
- true if this attribute is coming from an xsl:attriute element
public boolean addAttributeAlways(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute)
Adds the given attribute to the set of attributes, even if there is no currently open element. This is useful if a SAX startPrefixMapping() should need to add an attribute before the element name is seen.
- Parameters:
uri
- the URI of the attributelocalName
- the local name of the attributerawName
- the qualified name of the attributetype
- the type of the attribute (probably CDATA)value
- the value of the attributeXSLAttribute
- true if this attribute is coming from an xsl:attribute element
- Returns:
- true if the attribute was added, false if an existing value was replaced.
public void addAttributes(Attributes atts) throws SAXException
Add the given attributes to the currently collected ones. These attributes are always added, regardless of whether on not an element is currently open.
- Parameters:
atts
- List of attributes to add to this list
public void addXSLAttribute(String name, String value, String uri)
Adds the given xsl:attribute to the set of collected attributes, but only if there is a currently open element.
- Specified by:
- addXSLAttribute in interface ExtendedContentHandler
- Parameters:
name
- the attribute's qualified name (prefix:localName)value
- the value of the attributeuri
- the URI that the prefix of the name points to
public ContentHandler asContentHandler() throws IOException
Return aContentHandler
interface into this serializer. If the serializer does not support theContentHandler
interface, it should return null.
- Specified by:
- asContentHandler in interface Serializer
- Returns:
- A
ContentHandler
interface into this serializer, or null if the serializer is not SAX 2 capable
public Object asDOM3Serializer() throws IOException
Return aDOM3Serializer
interface into this serializer. If the serializer does not support theDOM3Serializer
interface, it should return null.
- Specified by:
- asDOM3Serializer in interface Serializer
- Returns:
- A
DOM3Serializer
interface into this serializer, or null if the serializer is not DOM capable
- See Also:
Serializer.asDOM3Serializer()
public DOMSerializer asDOMSerializer() throws IOException
Return aDOMSerializer
interface into this serializer. If the serializer does not support theDOMSerializer
interface, it should return null.
- Specified by:
- asDOMSerializer in interface Serializer
- Returns:
- A
DOMSerializer
interface into this serializer, or null if the serializer is not DOM capable
- See Also:
Serializer.asDOMSerializer()
public void characters(org.w3c.dom.Node node) throws SAXException
This method gets the nodes value as a String and uses that String as if it were an input character notification.
- Specified by:
- characters in interface ExtendedContentHandler
- Parameters:
node
- the Node to serialize
public void close()
Flush and close the underlying java.io.Writer. This method applies to ToStream serializers, not ToSAXHandler serializers.
- Specified by:
- close in interface SerializationHandler
- See Also:
ToStream
public void comment(String data) throws SAXException
Receive notification of a comment.
- Specified by:
- comment in interface ExtendedLexicalHandler
public boolean documentIsEmpty()
Return true if nothing has been sent to this result tree yet. This is not a public API.
public void endEntity(String name) throws SAXException
Report the end of an entity.
- Parameters:
name
- The name of the entity that is ending.
- See Also:
SerializerBase
public void entityReference(String name) throws SAXException
Entity reference event.
- Specified by:
- entityReference in interface ExtendedContentHandler
- Parameters:
name
- Name of entity
public void error(SAXParseException exc) throws SAXException
- See Also:
org.xml.sax.ErrorHandler.error(SAXParseException)
public void fatalError(SAXParseException exc) throws SAXException
- See Also:
org.xml.sax.ErrorHandler.fatalError(SAXParseException)
public void fireEndEntity(String name) throws SAXException
To fire off end entity trace event
- Parameters:
name
- Name of entity
public String getDoctypePublic()
Returns the previously set value of the value to be used as the public identifier in the document type declaration (DTD).
- Specified by:
- getDoctypePublic in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- the public identifier to be used in the DOCTYPE declaration in the output document.
public String getDoctypeSystem()
Returns the previously set value of the value to be used as the system identifier in the document type declaration (DTD).
- Specified by:
- getDoctypeSystem in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- the system identifier to be used in the DOCTYPE declaration in the output document.
public String getEncoding()
Returns the character encoding to be used in the output document.
- Specified by:
- getEncoding in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- the character encoding to be used in the output document.
public boolean getIndent()
- Specified by:
- getIndent in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- true if the output document should be indented to visually indicate its structure.
public int getIndentAmount()
- Specified by:
- getIndentAmount in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- the number of spaces to indent for each indentation level.
public String getMediaType()
Gets the mediatype the media-type or MIME type associated with the output document.
- Specified by:
- getMediaType in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- the mediatype the media-type or MIME type associated with the output document.
public NamespaceMappings getNamespaceMappings()
Some users of the serializer may need the current namespace mappings
- Specified by:
- getNamespaceMappings in interface ExtendedContentHandler
- Returns:
- the current namespace mappings (prefix/uri)
public String getNamespaceURI(String qname, boolean isElement)
Returns the URI of an element or attribute. Note that default namespaces do not apply directly to attributes.
- Specified by:
- getNamespaceURI in interface ExtendedContentHandler
- Parameters:
qname
- a qualified nameisElement
- true if the qualified name is the name of an element.
- Returns:
- returns the namespace URI associated with the qualified name.
public String getNamespaceURIFromPrefix(String prefix)
Returns the URI of prefix (if any)
- Specified by:
- getNamespaceURIFromPrefix in interface ExtendedContentHandler
- Parameters:
prefix
- the prefix whose URI is searched for
- Returns:
- the namespace URI currently associated with the prefix, null if the prefix is undefined.
public boolean getOmitXMLDeclaration()
- Specified by:
- getOmitXMLDeclaration in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- true if the XML declaration is to be omitted from the output document.
public String getOutputProperty(String name)
Get the value of an output property, the explicit value, if any, otherwise the default value, if any, otherwise null.
- Specified by:
- getOutputProperty in interface org.apache.xml.serializer.XSLOutputAttributes
public String getOutputPropertyDefault(String name)
Get the default value of an xsl:output property, which would be null only if no default value exists for the property.
- Specified by:
- getOutputPropertyDefault in interface org.apache.xml.serializer.XSLOutputAttributes
public String getOutputPropertyNonDefault(String name)
Get the value of an output property, not the default value. If there is a default value, but no non-default value this method will return null.
public String getPrefix(String namespaceURI)
Returns the prefix currently pointing to the given URI (if any).
- Specified by:
- getPrefix in interface ExtendedContentHandler
- Parameters:
namespaceURI
- the uri of the namespace in question
- Returns:
- a prefix pointing to the given URI (if any).
public String getStandalone()
Gets the XSL standalone attribute
- Specified by:
- getStandalone in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- a value of "yes" if the
standalone
delaration is to be included in the output document.
- See Also:
XSLOutputAttributes.getStandalone()
public Transformer getTransformer()
Gets the transformer associated with this serializer
- Specified by:
- getTransformer in interface SerializationHandler
- Returns:
- returns the transformer associated with this serializer.
public String getVersion()
Gets the version of the output format.
- Specified by:
- getVersion in interface org.apache.xml.serializer.XSLOutputAttributes
- Returns:
- the version of the output format.
public void namespaceAfterStartElement(String uri, String prefix) throws SAXException
This method is used when a prefix/uri namespace mapping is indicated after the element was started with a startElement() and before and endElement(). startPrefixMapping(prefix,uri) would be used before the startElement() call.
- Specified by:
- namespaceAfterStartElement in interface ExtendedContentHandler
- Parameters:
uri
- the URI of the namespaceprefix
- the prefix associated with the given URI.
public void notationDecl(String arg0, String arg1, String arg2) throws SAXException
- See Also:
org.xml.sax.DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
public void setDTDEntityExpansion(boolean expand)
If set to false the serializer does not expand DTD entities, but leaves them as is, the default value is true.
- Specified by:
- setDTDEntityExpansion in interface SerializationHandler
public void setDoctype(String doctypeSystem, String doctypePublic)
Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties
- Specified by:
- setDoctype in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
doctypeSystem
- the system identifier to be used in the DOCTYPE declaration in the output document.doctypePublic
- the public identifier to be used in the DOCTYPE declaration in the output document.
public void setDoctypePublic(String doctypePublic)
Set the value coming from the xsl:output doctype-public stylesheet attribute.
- Specified by:
- setDoctypePublic in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
doctypePublic
- the public identifier to be used in the DOCTYPE declaration in the output document.
public void setDoctypeSystem(String doctypeSystem)
Set the value coming from the xsl:output doctype-system stylesheet attribute.
- Specified by:
- setDoctypeSystem in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
doctypeSystem
- the system identifier to be used in the DOCTYPE declaration in the output document.
public void setDocumentLocator(Locator locator)
Receive an object for locating the origin of SAX document events.
- Parameters:
locator
- An object that can return the location of any SAX document event. Receive an object for locating the origin of SAX document events. 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 DocumentHandler 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.
public void setEncoding(String encoding)
Sets the character encoding coming from the xsl:output encoding stylesheet attribute.
- Specified by:
- setEncoding in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
public void setIndent(boolean doIndent)
Sets the value coming from the xsl:output indent stylesheet attribute.
- Specified by:
- setIndent in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
doIndent
- true if the output document should be indented to visually indicate its structure.
- See Also:
XSLOutputAttributes.setIndent(boolean)
public void setIndentAmount(int m_indentAmount)
Sets the indentation amount.
- Specified by:
- setIndentAmount in interface SerializationHandler
- Parameters:
m_indentAmount
- The m_indentAmount to set
public void setMediaType(String mediaType)
Sets the value coming from the xsl:output media-type stylesheet attribute.
- Specified by:
- setMediaType in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
mediaType
- the non-null media-type or MIME type associated with the output document.
- See Also:
javax.xml.transform.OutputKeys.MEDIA_TYPE
,SerializationHandler.setMediaType(String)
public void setNamespaceMappings(NamespaceMappings mappings)
Used only by TransformerSnapshotImpl to restore the serialization to a previous state.
- Specified by:
- setNamespaceMappings in interface SerializationHandler
- Parameters:
mappings
- NamespaceMappings
public void setOmitXMLDeclaration(boolean b)
Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute
- Specified by:
- setOmitXMLDeclaration in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
b
- true if the XML declaration is to be omitted from the output document.
public void setOutputProperty(String name, String val)
Set the value for the output property, typically from an xsl:output element, but this does not change what the default value is.
- Specified by:
- setOutputProperty in interface org.apache.xml.serializer.XSLOutputAttributes
public void setOutputPropertyDefault(String name, String val)
Set the default value for an output property, but this does not impact any explicitly set value.
- Specified by:
- setOutputPropertyDefault in interface org.apache.xml.serializer.XSLOutputAttributes
public void setSourceLocator(SourceLocator locator)
This method is used to set the source locator, which might be used to generated an error message.
- Specified by:
- setSourceLocator in interface ExtendedContentHandler
- Parameters:
locator
- the source locator
- See Also:
ExtendedContentHandler.setSourceLocator(javax.xml.transform.SourceLocator)
public void setStandalone(String standalone)
Sets the value coming from the xsl:output standalone stylesheet attribute.
- Specified by:
- setStandalone in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
standalone
- a value of "yes" indicates that thestandalone
delaration is to be included in the output document. This method remembers if the value was explicitly set using this method, verses if the value is the default value.
public void setTransformer(Transformer t)
Sets the transformer associated with this serializer
- Specified by:
- setTransformer in interface SerializationHandler
- Parameters:
t
- the transformer associated with this serializer.
public void setVersion(String version)
Sets the value coming from the xsl:output version attribute.
- Specified by:
- setVersion in interface org.apache.xml.serializer.XSLOutputAttributes
- Parameters:
version
- the version of the output format.
- See Also:
SerializationHandler.setVersion(String)
public void startDocument() throws SAXException
Receive notification of the beginning of a document. This method is never a self generated call, but only called externally. The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).
public void unparsedEntityDecl(String arg0, String arg1, String arg2, String arg3) throws SAXException
- See Also:
org.xml.sax.DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void warning(SAXParseException exc) throws SAXException
- See Also:
org.xml.sax.ErrorHandler.warning(SAXParseException)