org.apache.xalan.processor

Class StylesheetHandler

Implemented Interfaces:
TemplatesHandler, NodeConsumer, PrefixResolver

public class StylesheetHandler
extends DefaultHandler
implements TemplatesHandler, PrefixResolver, NodeConsumer

Initializes and processes a stylesheet via SAX events. This class acts as essentially a state machine, maintaining a ContentHandler stack, and pushing appropriate content handlers as parse events occur.

Field Summary

static int
STYPE_IMPORT
If getStylesheetType returns this value, the current stylesheet is an imported stylesheet.
static int
STYPE_INCLUDE
If getStylesheetType returns this value, the current stylesheet is an included stylesheet.
static int
STYPE_ROOT
If getStylesheetType returns this value, the current stylesheet is a root stylesheet.

Constructor Summary

StylesheetHandler(TransformerFactoryImpl processor)
Create a StylesheetHandler object, creating a root stylesheet as the target.

Method Summary

void
characters(ch[] , int start, int length)
Receive notification of character data inside an element.
XPath
createXPath(String str, ElemTemplateElement owningTemplate)
Process an expression string into an XPath.
void
endDocument()
Receive notification of the end of the document.
void
endElement(String uri, String localName, String rawName)
Receive notification of the end of an element.
void
endPrefixMapping(String prefix)
Receive notification of the end of a Namespace mapping.
void
error(org.xml.sax.SAXParseException e)
Receive notification of a recoverable XSLT processing error.
void
fatalError(org.xml.sax.SAXParseException e)
Report a fatal XSLT processing error.
String
getBaseIdentifier()
Return the base identifier.
boolean
getIncremental()
SAXSourceLocator
getLocator()
Get the current stylesheet Locator object.
String
getNamespaceForPrefix(String prefix)
Given a namespace, get the corrisponding prefix from the current namespace support context.
String
getNamespaceForPrefix(String prefix, Node context)
Given a namespace, get the corrisponding prefix.
boolean
getOptimize()
Node
getOriginatingNode()
Set the node that is originating the SAX event.
XSLTSchema
getSchema()
Get the root of the XSLT Schema, which tells us how to transition content handlers, create elements, etc.
boolean
getSource_location()
TransformerFactoryImpl
getStylesheetProcessor()
Get the XSLT TransformerFactoryImpl for needed services.
StylesheetRoot
getStylesheetRoot()
Return the stylesheet root that this handler is constructing.
String
getSystemId()
Get the base ID (URI or system ID) from where relative URLs will be resolved.
Templates
getTemplates()
When this object is used as a ContentHandler or ContentHandler, it will create a Templates object, which the caller can get once the SAX events have been completed.
boolean
handlesNullPrefixes()
void
ignorableWhitespace(ch[] , int start, int length)
Receive notification of ignorable whitespace in element content.
boolean
isStylesheetParsingComplete()
Test whether the _last_ endDocument() has been processed.
void
notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration.
void
processingInstruction(String target, String data)
Receive notification of a processing instruction.
void
pushStylesheet(Stylesheet s)
Push the current stylesheet being constructed.
InputSource
resolveEntity(String publicId, String systemId)
Resolve an external entity.
void
setDocumentLocator(Locator locator)
Receive a Locator object for document events.
void
setOriginatingNode(Node n)
Set the node that is originating the SAX event.
void
setSystemId(String baseID)
Set the base ID (URL or system ID) for the stylesheet created by this builder.
void
skippedEntity(String name)
Receive notification of a skipped entity.
void
startDocument()
Receive notification of the beginning of the document.
void
startElement(String uri, String localName, String rawName, Attributes attributes)
Receive notification of the start of an element.
void
startPrefixMapping(String prefix, String uri)
Receive notification of the start of a Namespace mapping.
void
unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration.
void
warn(String msg, args[] )
Warn the user of an problem.
void
warning(org.xml.sax.SAXParseException e)
Receive notification of a XSLT processing warning.

Field Details

STYPE_IMPORT

public static final int STYPE_IMPORT
If getStylesheetType returns this value, the current stylesheet is an imported stylesheet.
Field Value:
3

STYPE_INCLUDE

public static final int STYPE_INCLUDE
If getStylesheetType returns this value, the current stylesheet is an included stylesheet.
Field Value:
2

STYPE_ROOT

public static final int STYPE_ROOT
If getStylesheetType returns this value, the current stylesheet is a root stylesheet.
Field Value:
1

Constructor Details

StylesheetHandler

public StylesheetHandler(TransformerFactoryImpl processor)
            throws TransformerConfigurationException
Create a StylesheetHandler object, creating a root stylesheet as the target.
Parameters:
processor - non-null reference to the transformer factory that owns this handler.

Method Details

characters

public void characters(ch[] ,
                       int start,
                       int length)
            throws org.xml.sax.SAXException
Receive notification of character data inside an element.
Parameters:
start - The start position in the character array.
length - The number of characters to use from the character array.
See Also:
org.xml.sax.ContentHandler.characters

createXPath

public XPath createXPath(String str,
                         ElemTemplateElement owningTemplate)
            throws TransformerException
Process an expression string into an XPath. Must be public for access by the AVT class.
Parameters:
str - A non-null reference to a valid or invalid XPath expression string.
Returns:
A non-null reference to an XPath object that represents the string argument.

endDocument

public void endDocument()
            throws org.xml.sax.SAXException
Receive notification of the end of the document.
See Also:
org.xml.sax.ContentHandler.endDocument

endElement

public void endElement(String uri,
                       String localName,
                       String rawName)
            throws org.xml.sax.SAXException
Receive notification of the end of an element.
Parameters:
uri - The Namespace URI, or an empty string.
localName - The local name (without prefix), or empty string if not namespace processing.
rawName - The qualified name (with prefix).
See Also:
org.xml.sax.ContentHandler.endElement

endPrefixMapping

public void endPrefixMapping(String prefix)
            throws org.xml.sax.SAXException
Receive notification of the end of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).

Parameters:
prefix - The Namespace prefix being declared.
See Also:
org.xml.sax.ContentHandler.endPrefixMapping

error

public void error(org.xml.sax.SAXParseException e)
            throws org.xml.sax.SAXException
Receive notification of a recoverable XSLT processing error.
Parameters:
e - The error information encoded as an exception.

fatalError

public void fatalError(org.xml.sax.SAXParseException e)
            throws org.xml.sax.SAXException
Report a fatal XSLT processing error.
Parameters:
e - The error information encoded as an exception.

getBaseIdentifier

public String getBaseIdentifier()
Return the base identifier.
Specified by:
getBaseIdentifier in interface PrefixResolver
Returns:
The base identifier of the current stylesheet.

getIncremental

public boolean getIncremental()
Returns:
Incremental flag

getLocator

public SAXSourceLocator getLocator()
Get the current stylesheet Locator object.
Returns:
non-null reference to the current locator object.

getNamespaceForPrefix

public String getNamespaceForPrefix(String prefix)
Given a namespace, get the corrisponding prefix from the current namespace support context.
Specified by:
getNamespaceForPrefix in interface PrefixResolver
Parameters:
prefix - The prefix to look up, which may be an empty string ("") for the default Namespace.
Returns:
The associated Namespace URI, or null if the prefix is undeclared in this context.

getNamespaceForPrefix

public String getNamespaceForPrefix(String prefix,
                                    Node context)
Parameters:
prefix - The prefix to look up, which may be an empty string ("") for the default Namespace.
context - The node context from which to look up the URI.
Returns:
The associated Namespace URI, or null if the prefix is undeclared in this context.

getOptimize

public boolean getOptimize()
Returns:
Optimization flag

getOriginatingNode

public Node getOriginatingNode()
Set the node that is originating the SAX event.
Returns:
Reference to node that originated the current event.

getSchema

public XSLTSchema getSchema()
Get the root of the XSLT Schema, which tells us how to transition content handlers, create elements, etc.
Returns:
The root XSLT Schema, which should never be null.

getSource_location

public boolean getSource_location()
Returns:
Source Location flag

getStylesheetProcessor

public TransformerFactoryImpl getStylesheetProcessor()
Get the XSLT TransformerFactoryImpl for needed services. TODO: This method should be renamed.
Returns:
The TransformerFactoryImpl that owns this handler.

getStylesheetRoot

public StylesheetRoot getStylesheetRoot()
Return the stylesheet root that this handler is constructing.
Returns:
The root stylesheet of the stylesheets tree.

getSystemId

public String getSystemId()
Get the base ID (URI or system ID) from where relative URLs will be resolved.

getTemplates

public Templates getTemplates()
When this object is used as a ContentHandler or ContentHandler, it will create a Templates object, which the caller can get once the SAX events have been completed.

handlesNullPrefixes

public boolean handlesNullPrefixes()
Specified by:
handlesNullPrefixes in interface PrefixResolver

ignorableWhitespace

public void ignorableWhitespace(ch[] ,
                                int start,
                                int length)
            throws org.xml.sax.SAXException
Receive notification of ignorable whitespace in element content.
Parameters:
start - The start position in the character array.
length - The number of characters to use from the character array.
See Also:
org.xml.sax.ContentHandler.ignorableWhitespace

isStylesheetParsingComplete

public boolean isStylesheetParsingComplete()
Test whether the _last_ endDocument() has been processed. This is needed as guidance for stylesheet optimization and compilation engines, which generally don't want to start until all included and imported stylesheets have been fully parsed.
Returns:
true iff the complete stylesheet tree has been built.

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
Receive notification of a notation declaration.

By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.

Parameters:
name - The notation name.
publicId - The notation public identifier, or null if not available.
systemId - The notation system identifier.
See Also:
org.xml.sax.DTDHandler.notationDecl

processingInstruction

public void processingInstruction(String target,
                                  String data)
            throws org.xml.sax.SAXException
Receive notification of a processing instruction.

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

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Parameters:
target - The processing instruction target.
data - The processing instruction data, or null if none is supplied.
See Also:
org.xml.sax.ContentHandler.processingInstruction

pushStylesheet

public void pushStylesheet(Stylesheet s)
Push the current stylesheet being constructed. If no other stylesheets have been pushed onto the stack, assume the argument is a stylesheet root, and also set the stylesheet root member.
Parameters:
s - non-null reference to a stylesheet.

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
            throws org.xml.sax.SAXException
Resolve an external entity.
Parameters:
publicId - The public identifer, or null if none is available.
systemId - The system identifier provided in the XML document.
Returns:
The new input source, or null to require the default behaviour.

setDocumentLocator

public void setDocumentLocator(Locator locator)
Receive a Locator object for document events. This is called by the parser to push a locator for the stylesheet being parsed. The stack needs to be popped after the stylesheet has been parsed. We pop in popStylesheet.
Parameters:
locator - A locator for all SAX document events.
See Also:
org.xml.sax.ContentHandler.setDocumentLocator, org.xml.sax.Locator

setOriginatingNode

public void setOriginatingNode(Node n)
Set the node that is originating the SAX event.
Specified by:
setOriginatingNode in interface NodeConsumer
Parameters:
n - Reference to node that originated the current event.
See Also:
NodeConsumer

setSystemId

public void setSystemId(String baseID)
Set the base ID (URL or system ID) for the stylesheet created by this builder. This must be set in order to resolve relative URLs in the stylesheet.
Parameters:
baseID - Base URL for this stylesheet.

skippedEntity

public void skippedEntity(String name)
            throws org.xml.sax.SAXException
Receive notification of a skipped entity.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Parameters:
name - The name of the skipped entity.
See Also:
org.xml.sax.ContentHandler.processingInstruction

startDocument

public void startDocument()
            throws org.xml.sax.SAXException
Receive notification of the beginning of the document.
See Also:
org.xml.sax.ContentHandler.startDocument

startElement

public void startElement(String uri,
                         String localName,
                         String rawName,
                         Attributes attributes)
            throws org.xml.sax.SAXException
Receive notification of the start of an element.
Parameters:
uri - The Namespace URI, or an empty string.
localName - The local name (without prefix), or empty string if not namespace processing.
rawName - The qualified name (with prefix).
attributes - The specified or defaulted attributes.

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
            throws org.xml.sax.SAXException
Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).

Parameters:
prefix - The Namespace prefix being declared.
uri - The Namespace URI mapped to the prefix.
See Also:
org.xml.sax.ContentHandler.startPrefixMapping

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
Receive notification of an unparsed entity declaration.
Parameters:
name - The entity name.
publicId - The entity public identifier, or null if not available.
systemId - The entity system identifier.
notationName - The name of the associated notation.
See Also:
org.xml.sax.DTDHandler.unparsedEntityDecl

warn

public void warn(String msg,
                 args[] )
            throws org.xml.sax.SAXException
Warn the user of an problem.
Parameters:
msg - An key into the XSLTErrorResources table, that is one of the WG_ prefixed definitions.

warning

public void warning(org.xml.sax.SAXParseException e)
            throws org.xml.sax.SAXException
Receive notification of a XSLT processing warning.
Parameters:
e - The warning information encoded as an exception.

Copyright B) 2005 Apache XML Project. All Rights Reserved.