net.sf.saxon.trans

Class ConfigurationReader

java.lang.Object

net.sf.saxon.trans.ConfigurationReader

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class ConfigurationReader
extends java.lang.Object
implements Receiver

Class used to read a config.xml file and transfer all settings from the file to the Configuration

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	targetConfig

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
ConfigurationReader()

Method Summary

Modifier and Type	Method and Description
void	characters(UnicodeString chars, Location location, int properties) Notify character data.
void	close() Notify the end of the event stream
void	comment(UnicodeString content, Location location, int properties) Notify a comment.
void	endDocument() Notify the end of a document node
void	endElement() Notify the end of an element.
protected void	error(XPathException err)
protected void	errorClass(java.lang.String element, java.lang.String attribute, java.lang.String actual, java.lang.Class required, java.lang.Exception cause)
PipelineConfiguration	getPipelineConfiguration() Get the pipeline configuration
java.lang.String	getSystemId()
Configuration	makeConfiguration(javax.xml.transform.Source source) Create a Configuration based on the contents of this configuration file
void	open() Notify the start of the event stream
void	processingInstruction(java.lang.String name, UnicodeString data, Location location, int properties) Output a processing instruction
protected void	readExtensionElement(AttributeMap atts) Process details of XSLT extension elements.
protected void	readWithParam(AttributeMap atts, NamespaceMap nsMap)
protected void	readXsltPackage(AttributeMap atts)
void	setBaseConfiguration(Configuration base) Set a base Configuration to be used by the new Configuration.
void	setClassLoader(java.lang.ClassLoader classLoader) Set the ClassLoader to be used for dynamic loading of the configuration, and for dynamic loading of other classes used within the configuration.
void	setPipelineConfiguration(PipelineConfiguration pipe) Set the pipeline configuration
void	setSystemId(java.lang.String systemId)
void	setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) Notify an unparsed entity URI.
void	startDocument(int properties) Notify the start of a document node
void	startElement(NodeName elemName, SchemaType type, AttributeMap atts, NamespaceMap namespaces, Location location, int properties) Notify the start of an element

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.event.Receiver

append, append, handlesAppend, usesTypeAnnotations

Field Detail

targetConfig

protected Configuration targetConfig

Constructor Detail

ConfigurationReader

public ConfigurationReader()

Method Detail

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

Description copied from interface: Receiver

Set the pipeline configuration

Specified by:

setPipelineConfiguration in interface Receiver

Parameters:

pipe - the pipeline configuration

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()

Description copied from interface: Receiver

Get the pipeline configuration

Specified by:

getPipelineConfiguration in interface Receiver

Returns:

the pipeline configuration

setSystemId

public void setSystemId(java.lang.String systemId)

Specified by:

setSystemId in interface javax.xml.transform.Result

open

public void open()
          throws XPathException

Description copied from interface: Receiver

Notify the start of the event stream

Specified by:

open in interface Receiver

Throws:

XPathException - if an error occurs

startDocument

public void startDocument(int properties)
                   throws XPathException

Description copied from interface: Receiver

Notify the start of a document node

Specified by:

startDocument in interface Receiver

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

setUnparsedEntity

public void setUnparsedEntity(java.lang.String name,
                              java.lang.String systemID,
                              java.lang.String publicID)
                       throws XPathException

Description copied from interface: Receiver

Notify an unparsed entity URI.

Specified by:

setUnparsedEntity in interface Receiver

Parameters:

name - The name of the unparsed entity

systemID - The system identifier of the unparsed entity

publicID - The identifier of the unparsed entity

Throws:

XPathException - if an error occurs

processingInstruction

public void processingInstruction(java.lang.String name,
                                  UnicodeString data,
                                  Location location,
                                  int properties)
                           throws XPathException

Description copied from interface: Receiver

Output a processing instruction

Specified by:

processingInstruction in interface Receiver

Parameters:

name - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

location - provides information such as line number and system ID.

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

comment

public void comment(UnicodeString content,
                    Location location,
                    int properties)
             throws XPathException

Description copied from interface: Receiver

Notify a comment. Comments are only notified if they are outside the DTD.

Specified by:

comment in interface Receiver

Parameters:

content - The content of the comment

location - provides information such as line number and system ID.

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs

close

public void close()
           throws XPathException

Description copied from interface: Receiver

Notify the end of the event stream

Specified by:

close in interface Receiver

Throws:

XPathException - if an error occurs

getSystemId

public java.lang.String getSystemId()

Specified by:

getSystemId in interface javax.xml.transform.Result

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Set the ClassLoader to be used for dynamic loading of the configuration, and for dynamic loading of other classes used within the configuration. By default the class loader of this class is used.

Parameters:

classLoader - the ClassLoader to be used

setBaseConfiguration

public void setBaseConfiguration(Configuration base)

Set a base Configuration to be used by the new Configuration. The new Configuration shares a NamePool and document number allocator with the base Configuration

Parameters:

base - the base configuration to be used

makeConfiguration

public Configuration makeConfiguration(javax.xml.transform.Source source)
                                throws XPathException

Create a Configuration based on the contents of this configuration file

Parameters:

source - the Source of the configuration file

Returns:

the constructed Configuration

Throws:

XPathException - if a failure occurs, typically an invalid configuration file

endDocument

public void endDocument()

Description copied from interface: Receiver

Notify the end of a document node

Specified by:

endDocument in interface Receiver

startElement

public void startElement(NodeName elemName,
                         SchemaType type,
                         AttributeMap atts,
                         NamespaceMap namespaces,
                         Location location,
                         int properties)
                  throws XPathException

Description copied from interface: Receiver

Notify the start of an element

Specified by:

startElement in interface Receiver

Parameters:

elemName - the name of the element.

type - the type annotation of the element.

atts - the attributes of this element

namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements

location - an object providing information about the module, line, and column where the node originated

properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

readExtensionElement

protected void readExtensionElement(AttributeMap atts)

Process details of XSLT extension elements. Overridden in Saxon-PE configuration reader

Parameters:

atts - the attributes of the extensionElement element in the configuration file

readXsltPackage

protected void readXsltPackage(AttributeMap atts)

readWithParam

protected void readWithParam(AttributeMap atts,
                             NamespaceMap nsMap)

error

protected void error(XPathException err)

errorClass

protected void errorClass(java.lang.String element,
                          java.lang.String attribute,
                          java.lang.String actual,
                          java.lang.Class required,
                          java.lang.Exception cause)

endElement

public void endElement()
                throws XPathException

Description copied from interface: Receiver

Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.

Specified by:

endElement in interface Receiver

Throws:

XPathException - if an error occurs

characters

public void characters(UnicodeString chars,
                       Location location,
                       int properties)
                throws XPathException

Description copied from interface: Receiver

Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.

Specified by:

characters in interface Receiver

Parameters:

chars - The characters

location - provides information such as line number and system ID.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

Throws:

XPathException - if an error occurs