FileDocCategorySizeDatePackage
SerializerBase.javaAPI DocJava SE 5 API40569Fri Aug 26 14:56:02 BST 2005com.sun.org.apache.xml.internal.serializer

SerializerBase

public abstract class SerializerBase extends Object implements DOM2DTM$CharacterNodeHandler, SerializerConstants, SerializationHandler
This class acts as a base class for the XML "serializers" and the stream serializers. It contains a number of common fields and methods.
author
Santiago Pericas-Geertsen
author
G. Todd Miller

Fields Summary
protected boolean
m_needToCallStartDocument
true if we still need to call startDocumentInternal()
protected boolean
m_cdataTagOpen
True if a trailing "]]>" still needs to be written to be written out. Used to merge adjacent CDATA sections
protected AttributesImplSerializer
m_attributes
All the attributes of the current element, collected from startPrefixMapping() calls, or addAddtribute() calls, or from the SAX attributes in a startElement() call.
protected boolean
m_inEntityRef
Tells if we're in an EntityRef event.
protected boolean
m_inExternalDTD
This flag is set while receiving events from the external DTD
private String
m_doctypeSystem
The System ID for the doc type.
private String
m_doctypePublic
The public ID for the doc type.
boolean
m_needToOutputDocTypeDecl
Flag to tell that we need to add the doctype decl, which we can't do until the first element is encountered.
private String
m_encoding
The character encoding. Must match the encoding used for the printWriter.
private boolean
m_shouldNotWriteXMLHeader
Tells if we should write the XML declaration.
private String
m_standalone
The standalone value for the doctype.
protected boolean
m_standaloneWasSpecified
True if standalone was specified.
protected boolean
m_doIndent
Flag to tell if indenting (pretty-printing) is on.
protected int
m_indentAmount
Amount to indent.
private String
m_version
Tells the XML version, for writing out to the XML decl.
private String
m_mediatype
The mediatype. Not used right now.
private Transformer
m_transformer
The transformer that was around when this output handler was created (if any).
protected Vector
m_cdataSectionElements
Pairs of local names and corresponding URIs of CDATA sections. This list comes from the cdata-section-elements attribute. Every second one is a local name, and every other second one is the URI for the local name.
protected NamespaceMappings
m_prefixMap
Namespace support, that keeps track of currently defined prefix/uri mappings. As processed elements come and go, so do the associated mappings for that element.
protected SerializerTrace
m_tracer
Handle for firing generate events. This interface may be implemented by the referenced transformer object.
protected SourceLocator
m_sourceLocator
protected Writer
m_writer
The writer to send output to. This field is only used in the ToStream serializers, but exists here just so that the fireStartDoc() and other fire... methods can flush this writer when tracing.
protected ElemContext
m_elemContext
A reference to "stack frame" corresponding to the current element. Such a frame is pushed at a startElement() and popped at an endElement(). This frame contains information about the element, such as its namespace URI.
protected char[]
m_charsBuff
A utility buffer for converting Strings passed to character() methods to character arrays. Reusing this buffer means not creating a new character array everytime and it runs faster.
protected char[]
m_attrBuff
A utility buffer for converting Strings passed to attribute methods to character arrays. Reusing this buffer means not creating a new character array everytime and it runs faster.
Constructors Summary
Methods Summary
public voidaddAttribute(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value)
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.

param
uri the URI of the attribute
param
localName the local name of the attribute
param
rawName the qualified name of the attribute
param
type the type of the attribute (probably CDATA)
param
value the value of the attribute
see
com.sun.org.apache.xml.internal.serializer.ExtendedContentHandler#addAttribute(String, String, String, String, String)

        if (m_elemContext.m_startTagOpen)
        {
            addAttributeAlways(uri, localName, rawName, type, value);
        }
public voidaddAttribute(java.lang.String name, java.lang.String value)
Adds the given attribute to the set of collected attributes, but only if there is a currently open element. This method is only called by XSLTC.

param
name the attribute's qualified name
param
value the value of the attribute

        if (m_elemContext.m_startTagOpen)
        {
            final String patchedName = patchName(name);
            final String localName = getLocalName(patchedName);
            final String uri = getNamespaceURI(patchedName, false);

            addAttributeAlways(uri,localName, patchedName, "CDATA", value);
         }
public voidaddAttributeAlways(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value)
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.

param
uri the URI of the attribute
param
localName the local name of the attribute
param
rawName the qualified name of the attribute
param
type the type of the attribute (probably CDATA)
param
value the value of the attribute

//            final int index =
//                (localName == null || uri == null) ?
//                m_attributes.getIndex(rawName):m_attributes.getIndex(uri, localName);        
            int index;
//            if (localName == null || uri == null){
//                index = m_attributes.getIndex(rawName);
//            }
//            else {
//                index = m_attributes.getIndex(uri, localName);
//            }
            index = m_attributes.getIndex(rawName);
            if (index >= 0)
            {
                /* We've seen the attribute before.
                 * We may have a null uri or localName, but all
                 * we really want to re-set is the value anyway.
                 */
                m_attributes.setValue(index,value);
            }
            else
            {
                // the attribute doesn't exist yet, create it
                m_attributes.addAttribute(uri, localName, rawName, type, value);
            }
public voidaddAttributes(org.xml.sax.Attributes atts)
Add the given attributes to the currently collected ones. These attributes are always added, regardless of whether on not an element is currently open.

param
atts List of attributes to add to this list


        int nAtts = atts.getLength();

        for (int i = 0; i < nAtts; i++)
        {
            String uri = atts.getURI(i);

            if (null == uri)
                uri = "";

            addAttributeAlways(
                uri,
                atts.getLocalName(i),
                atts.getQName(i),
                atts.getType(i),
                atts.getValue(i));

        }
public org.xml.sax.ContentHandlerasContentHandler()
Return a {@link ContentHandler} interface into this serializer. If the serializer does not support the {@link ContentHandler} interface, it should return null.

return
A {@link ContentHandler} interface into this serializer, or null if the serializer is not SAX 2 capable
throws
IOException An I/O exception occured

        return this;
public com.sun.org.apache.xml.internal.serializer.DOMSerializerasDOMSerializer()
Return a {@link DOMSerializer} interface into this serializer. If the serializer does not support the {@link DOMSerializer} interface, it should return null.

return
A {@link DOMSerializer} interface into this serializer, or null if the serializer is not DOM capable
throws
IOException An I/O exception occured
see
com.sun.org.apache.xml.internal.serializer.Serializer#asDOMSerializer()

 
        return this;
public voidcharacters(org.w3c.dom.Node node)
This method gets the nodes value as a String and uses that String as if it were an input character notification.

param
node the Node to serialize
throws
org.xml.sax.SAXException

        flushPending();
        String data = node.getNodeValue();
        if (data != null)
        {
            final int length = data.length();
            if (length > m_charsBuff.length)
            {
                m_charsBuff = new char[length * 2 + 1];
            }
            data.getChars(0, length, m_charsBuff, 0);
            characters(m_charsBuff, 0, length);
        }
public voidclose()
Flush and close the underlying java.io.Writer. This method applies to ToStream serializers, not ToSAXHandler serializers.

see
com.sun.org.apache.xml.internal.serializer.ToStream

        // do nothing (base behavior)
public voidcomment(java.lang.String data)
Receive notification of a comment.

see
com.sun.org.apache.xml.internal.serializer.ExtendedLexicalHandler#comment(String)

    

                 
         
    
        final int length = data.length();
        if (length > m_charsBuff.length)
        {
            m_charsBuff = new char[length * 2 + 1];
        }
        data.getChars(0, length, m_charsBuff, 0);
        comment(m_charsBuff, 0, length);
public voidendEntity(java.lang.String name)
Report the end of an entity.

param
name The name of the entity that is ending.
throws
org.xml.sax.SAXException The application may raise an exception.
see
#startEntity

        if (name.equals("[dtd]"))
            m_inExternalDTD = false;
        m_inEntityRef = false;

        if (m_tracer != null)
            this.fireEndEntity(name);
public voidentityReference(java.lang.String name)
Entity reference event.

param
name Name of entity
throws
org.xml.sax.SAXException


        flushPending();

        startEntity(name);
        endEntity(name);

        if (m_tracer != null)
		    fireEntityReference(name);
public voiderror(org.xml.sax.SAXParseException exc)

see
org.xml.sax.ErrorHandler#error(SAXParseException)
public voidfatalError(org.xml.sax.SAXParseException exc)

see
org.xml.sax.ErrorHandler#fatalError(SAXParseException)

        
      m_elemContext.m_startTagOpen = false;
protected voidfireCDATAEvent(char[] chars, int start, int length)
Report the CDATA trace event

param
chars content of CDATA
param
start starting index of characters to output
param
length number of characters to output

		if (m_tracer != null)
        {
            flushMyWriter();
			m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_CDATA, chars, start,length);
        }
protected voidfireCharEvent(char[] chars, int start, int length)
Report the characters trace event

param
chars content of characters
param
start starting index of characters to output
param
length number of characters to output

        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_CHARACTERS, chars, start,length);
        }
protected voidfireCommentEvent(char[] chars, int start, int length)
Report the comment trace event

param
chars content of comment
param
start starting index of comment to output
param
length number of characters to output

		if (m_tracer != null)
        {
            flushMyWriter();
			m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_COMMENT, new String(chars, start, length));
        }
protected voidfireEndDoc()
To fire off end document trace event

        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_ENDDOCUMENT);
        }
protected voidfireEndElem(java.lang.String name)
To fire off the end element trace event

param
name Name of element

        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_ENDELEMENT,name, (Attributes)null);
        }
public voidfireEndEntity(java.lang.String name)
To fire off end entity trace event

param
name Name of entity

        if (m_tracer != null)
            flushMyWriter();
    	// we do not need to handle this.
protected voidfireEntityReference(java.lang.String name)
To fire off the entity reference trace event

param
name Name of entity reference

        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_ENTITYREF,name, (Attributes)null);
        }
protected voidfireEscapingEvent(java.lang.String name, java.lang.String data)
To fire off the PI trace event

param
name Name of PI


        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_PI,name, data);
        }
protected voidfireStartDoc()
To fire off start document trace event

        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_STARTDOCUMENT);
        }
protected voidfireStartElem(java.lang.String elemName)
Report the start element trace event. This trace method needs to be called just before the attributes are cleared.

param
elemName the qualified name of the element

        
        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_STARTELEMENT,
                elemName, m_attributes);     	 
        }
protected voidfireStartEntity(java.lang.String name)
To fire off start entity trace event

param
name Name of entity

        
        if (m_tracer != null)
        {
            flushMyWriter();
            m_tracer.fireGenerateEvent(SerializerTrace.EVENTTYPE_ENTITYREF, name);
        }
private voidflushMyWriter()
This method is only used internally when flushing the writer from the various fire...() trace events. Due to the writer being wrapped with SerializerTraceWriter it may cause the flush of these trace events: EVENTTYPE_OUTPUT_PSEUDO_CHARACTERS EVENTTYPE_OUTPUT_CHARACTERS which trace the output written to the output stream.

        if (m_writer != null)
        {
            try
            {
                m_writer.flush();
            }
            catch(IOException ioe)
            {
            
            }
        }
public java.lang.StringgetDoctypePublic()
Returns the previously set value of the value to be used as the public identifier in the document type declaration (DTD).

return
the public identifier to be used in the DOCTYPE declaration in the output document.

        return m_doctypePublic;
public java.lang.StringgetDoctypeSystem()
Returns the previously set value of the value to be used as the system identifier in the document type declaration (DTD).

return
the system identifier to be used in the DOCTYPE declaration in the output document.

        return m_doctypeSystem;
public java.lang.StringgetEncoding()
Returns the character encoding to be used in the output document.

return
the character encoding to be used in the output document.

        return m_encoding;
public booleangetIndent()

return
true if the output document should be indented to visually indicate its structure.

        return m_doIndent;
public intgetIndentAmount()

return
the number of spaces to indent for each indentation level.

        return m_indentAmount;
protected static java.lang.StringgetLocalName(java.lang.String qname)
Returns the local name of a qualified name. If the name has no prefix, then it works as the identity (SAX2).

param
qname the qualified name
return
the name, but excluding any prefix and colon.

        final int col = qname.lastIndexOf(':");
        return (col > 0) ? qname.substring(col + 1) : qname;
public java.lang.StringgetMediaType()
Gets the mediatype the media-type or MIME type associated with the output document.

return
the mediatype the media-type or MIME type associated with the output document.

        return m_mediatype;
public com.sun.org.apache.xml.internal.serializer.NamespaceMappingsgetNamespaceMappings()
Some users of the serializer may need the current namespace mappings

return
the current namespace mappings (prefix/uri)
see
com.sun.org.apache.xml.internal.serializer.ExtendedContentHandler#getNamespaceMappings()

        return m_prefixMap;
public java.lang.StringgetNamespaceURI(java.lang.String qname, boolean isElement)
Returns the URI of an element or attribute. Note that default namespaces do not apply directly to attributes.

param
qname a qualified name
param
isElement true if the qualified name is the name of an element.
return
returns the namespace URI associated with the qualified name.

        String uri = EMPTYSTRING;
        int col = qname.lastIndexOf(':");
        final String prefix = (col > 0) ? qname.substring(0, col) : EMPTYSTRING;

        if (!EMPTYSTRING.equals(prefix) || isElement)
        {
            if (m_prefixMap != null)
            {
                uri = m_prefixMap.lookupNamespace(prefix);
                if (uri == null && !prefix.equals(XMLNS_PREFIX))
                {
                    throw new RuntimeException(
                        XMLMessages.createXMLMessage(
                            XMLErrorResources.ER_NAMESPACE_PREFIX,
                            new Object[] { qname.substring(0, col) }  ));
                }
            }
        }
        return uri;
public java.lang.StringgetNamespaceURIFromPrefix(java.lang.String prefix)
Returns the URI of prefix (if any)

param
prefix the prefix whose URI is searched for
return
the namespace URI currently associated with the prefix, null if the prefix is undefined.

        String uri = null;
        if (m_prefixMap != null)
            uri = m_prefixMap.lookupNamespace(prefix);
        return uri;
public booleangetOmitXMLDeclaration()

return
true if the XML declaration is to be omitted from the output document.

        return m_shouldNotWriteXMLHeader;
public java.lang.StringgetPrefix(java.lang.String namespaceURI)
Returns the prefix currently pointing to the given URI (if any).

param
namespaceURI the uri of the namespace in question
return
a prefix pointing to the given URI (if any).
see
com.sun.org.apache.xml.internal.serializer.ExtendedContentHandler#getPrefix(String)

        String prefix = m_prefixMap.lookupPrefix(namespaceURI);
        return prefix;
protected static final java.lang.StringgetPrefixPart(java.lang.String qname)
Returns the local name of a qualified name. If the name has no prefix, then it works as the identity (SAX2).

param
qname a qualified name
return
returns the prefix of the qualified name, or null if there is no prefix.

        final int col = qname.indexOf(':");
        return (col > 0) ? qname.substring(0, col) : null;
        //return (col > 0) ? qname.substring(0,col) : "";
public java.lang.StringgetStandalone()
Gets the XSL standalone attribute

return
a value of "yes" if the standalone delaration is to be included in the output document.
see
com.sun.org.apache.xml.internal.serializer.XSLOutputAttributes#getStandalone()

        return m_standalone;
public javax.xml.transform.TransformergetTransformer()
Gets the transformer associated with this serializer

return
returns the transformer associated with this serializer.
see
com.sun.org.apache.xml.internal.serializer.SerializationHandler#getTransformer()

        return m_transformer;
public java.lang.StringgetVersion()
Gets the version of the output format.

return
the version of the output format.

        return m_version;
protected voidinitCDATA()
Initialize global variables

        // CDATA stack
        //        _cdataStack = new Stack();
        //        _cdataStack.push(new Integer(-1)); // push dummy value
protected booleanisCdataSection()
Push a boolean state based on if the name of the element is found in the list of qnames. A state is only pushed if there were some cdata-section-names were specified.

param
namespaceURI Should be a non-null reference to the namespace URL of the element that owns the state, or empty string.
param
localName Should be a non-null reference to the local name of the element that owns the state. Hidden parameters are the vector of qualified elements specified in cdata-section-names attribute, and the m_cdataSectionStates stack onto which whether the current element is in the list is pushed (true or false). Other hidden parameters are the current elements namespaceURI, localName and qName


        boolean b = false;

        if (null != m_cdataSectionElements)
        {
            if (m_elemContext.m_elementLocalName == null)
                m_elemContext.m_elementLocalName = 
                    getLocalName(m_elemContext.m_elementName);
            if (m_elemContext.m_elementURI == null)
            {
                String prefix = getPrefixPart(m_elemContext.m_elementName);
                if (prefix != null)
                    m_elemContext.m_elementURI = 
                        m_prefixMap.lookupNamespace(prefix);

            }

            if ((null != m_elemContext.m_elementURI) 
                && m_elemContext.m_elementURI.length() == 0)
                m_elemContext.m_elementURI = null;

            int nElems = m_cdataSectionElements.size();

            // loop through 2 at a time, as these are pairs of URI and localName
            for (int i = 0; i < nElems; i += 2)
            {
                String uri = (String) m_cdataSectionElements.elementAt(i);
                String loc = (String) m_cdataSectionElements.elementAt(i + 1);
                if (loc.equals(m_elemContext.m_elementLocalName)
                    && subPartMatch(m_elemContext.m_elementURI, uri))
                {
                    b = true;

                    break;
                }
            }
        }
        return b;
public voidnamespaceAfterStartElement(java.lang.String uri, java.lang.String prefix)
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.

param
uri the URI of the namespace
param
prefix the prefix associated with the given URI.
see
com.sun.org.apache.xml.internal.serializer.ExtendedContentHandler#namespaceAfterStartElement(String, String)

        // default behavior is to do nothing
protected java.lang.StringpatchName(java.lang.String qname)
TODO: This method is a HACK! Since XSLTC does not have access to the XML file, it sometimes generates a NS prefix of the form "ns?" for an attribute. If at runtime, when the qname of the attribute is known, another prefix is specified for the attribute, then we can get a qname of the form "ns?:otherprefix:name". This function patches the qname by simply ignoring "otherprefix".


        
        final int lastColon = qname.lastIndexOf(':");

        if (lastColon > 0) {
            final int firstColon = qname.indexOf(':");
            final String prefix = qname.substring(0, firstColon);
            final String localName = qname.substring(lastColon + 1);

        // If uri is "" then ignore prefix
            final String uri = m_prefixMap.lookupNamespace(prefix);
            if (uri != null && uri.length() == 0) {
                return localName;
            }
            else if (firstColon != lastColon) {
                return prefix + ':" + localName;
            }
        }
        return qname;
public booleanreset()

    	resetSerializerBase();
    	return true;
private voidresetSerializerBase()
Reset all of the fields owned by SerializerBase

    	this.m_attributes.clear();
    	this.m_cdataSectionElements = null;
        this.m_elemContext = new ElemContext();
    	this.m_doctypePublic = null;
    	this.m_doctypeSystem = null;
    	this.m_doIndent = false;
    	this.m_encoding = null;
    	this.m_indentAmount = 0;
    	this.m_inEntityRef = false;
    	this.m_inExternalDTD = false;
    	this.m_mediatype = null;
    	this.m_needToCallStartDocument = true;
    	this.m_needToOutputDocTypeDecl = false;
        if (this.m_prefixMap != null)
    	    this.m_prefixMap.reset();
    	this.m_shouldNotWriteXMLHeader = false;
    	this.m_sourceLocator = null;
    	this.m_standalone = null;
    	this.m_standaloneWasSpecified = false;
    	this.m_tracer = null;
    	this.m_transformer = null;
    	this.m_version = null;
    	// don't set writer to null, so that it might be re-used
    	//this.m_writer = null;
public voidsetDoctype(java.lang.String doctypeSystem, java.lang.String doctypePublic)
Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties

param
doctypeSystem the system identifier to be used in the DOCTYPE declaration in the output document.
param
doctypePublic the public identifier to be used in the DOCTYPE declaration in the output document.

        this.m_doctypeSystem = doctypeSystem;
        this.m_doctypePublic = doctypePublic;
public voidsetDoctypePublic(java.lang.String doctypePublic)
Set the value coming from the xsl:output doctype-public stylesheet attribute.

param
doctypePublic the public identifier to be used in the DOCTYPE declaration in the output document.

        this.m_doctypePublic = doctypePublic;
public voidsetDoctypeSystem(java.lang.String doctypeSystem)
Set the value coming from the xsl:output doctype-system stylesheet attribute.

param
doctypeSystem the system identifier to be used in the DOCTYPE declaration in the output document.

        this.m_doctypeSystem = doctypeSystem;
public voidsetDocumentLocator(org.xml.sax.Locator locator)
Receive an object for locating the origin of SAX document events.

param
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.

        return;

        // I don't do anything with this yet.
public voidsetEncoding(java.lang.String m_encoding)
Sets the character encoding coming from the xsl:output encoding stylesheet attribute.

param
encoding the character encoding

        this.m_encoding = m_encoding;
public voidsetIndent(boolean doIndent)
Sets the value coming from the xsl:output indent stylesheet attribute.

param
doIndent true if the output document should be indented to visually indicate its structure.
see
com.sun.org.apache.xml.internal.serializer.XSLOutputAttributes#setIndent(boolean)

        m_doIndent = doIndent;
public voidsetIndentAmount(int m_indentAmount)
Sets the indentation amount.

param
m_indentAmount The m_indentAmount to set

        this.m_indentAmount = m_indentAmount;
public voidsetMediaType(java.lang.String mediaType)
Sets the value coming from the xsl:output media-type stylesheet attribute.

param
mediaType the non-null media-type or MIME type associated with the output document.
see
javax.xml.transform.OutputKeys#MEDIA_TYPE
see
com.sun.org.apache.xml.internal.serializer.SerializationHandler#setMediaType(String)

        m_mediatype = mediaType;
public voidsetNamespaceMappings(com.sun.org.apache.xml.internal.serializer.NamespaceMappings mappings)
Used only by TransformerSnapshotImpl to restore the serialization to a previous state.

param
NamespaceMappings

        m_prefixMap = mappings;
public voidsetOmitXMLDeclaration(boolean b)
Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute

param
b true if the XML declaration is to be omitted from the output document.

        this.m_shouldNotWriteXMLHeader = b;
public voidsetSourceLocator(javax.xml.transform.SourceLocator locator)
This method is used to set the source locator, which might be used to generated an error message.

param
locator the source locator
see
com.sun.org.apache.xml.internal.serializer.ExtendedContentHandler#setSourceLocator(javax.xml.transform.SourceLocator)

        m_sourceLocator = locator;
public voidsetStandalone(java.lang.String standalone)
Sets the value coming from the xsl:output standalone stylesheet attribute.

param
standalone a value of "yes" indicates that the standalone 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.

        if (standalone != null)
        {
            m_standaloneWasSpecified = true;
            setStandaloneInternal(standalone);
        }
protected voidsetStandaloneInternal(java.lang.String standalone)
Sets the XSL standalone attribute, but does not remember if this is a default or explicite setting.

param
standalone "yes" | "no"

        if ("yes".equals(standalone))
            m_standalone = "yes";
        else
            m_standalone = "no";
public voidsetTransformer(javax.xml.transform.Transformer t)
Sets the transformer associated with this serializer

param
t the transformer associated with this serializer.
see
com.sun.org.apache.xml.internal.serializer.SerializationHandler#setTransformer(Transformer)

        m_transformer = t;
        
        // If this transformer object implements the SerializerTrace interface
        // then assign m_tracer to the transformer object so it can be used
        // to fire trace events.
        if ((m_transformer instanceof SerializerTrace) &&
            (((SerializerTrace) m_transformer).hasTraceListeners())) {
           m_tracer = (SerializerTrace) m_transformer;
        } else {
           m_tracer = null;
        }
public voidsetVersion(java.lang.String version)
Sets the value coming from the xsl:output version attribute.

param
version the version of the output format.
see
com.sun.org.apache.xml.internal.serializer.SerializationHandler#setVersion(String)

        m_version = version;
public voidstartDocument()
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).

throws
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
throws
org.xml.sax.SAXException


        // if we do get called with startDocument(), handle it right away       
        startDocumentInternal();
        m_needToCallStartDocument = false;
        return;
protected voidstartDocumentInternal()
This method handles what needs to be done at a startDocument() call, whether from an external caller, or internally called in the serializer. Historically Xalan has not always called a startDocument() although it always calls endDocument() on the serializer. So the serializer must be flexible for that. Even if no external call is made into startDocument() this method will always be called as a self generated internal startDocument, it handles what needs to be done at a startDocument() call. This method exists just to make sure that startDocument() is only ever called from an external caller, which in principle is just a matter of style.

throws
SAXException

        if (m_tracer != null)
            this.fireStartDoc();
private static final booleansubPartMatch(java.lang.String p, java.lang.String t)
Tell if two strings are equal, without worry if the first string is null.

param
p String reference, which may be null.
param
t String reference, which may be null.
return
true if strings are equal.

        return (p == t) || ((null != p) && (p.equals(t)));
public voidwarning(org.xml.sax.SAXParseException exc)

see
org.xml.sax.ErrorHandler#warning(SAXParseException)