: Class JAXPTransformer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.xmlmill
Class JAXPTransformer

java.lang.Object
  |
  +--com.xmlmill.JAXPTransformer

public class JAXPTransformer
extends java.lang.Object

The JAXPTransformer instance takes care of the transformation of xml data and a xsl stylesheet (or .mill file) to a pdf file.

*** A JAXPTransformer instance should not be reused. ***: After having called the transform() method the instance should be discarded.

Field Summary

static java.lang.String XSLTONLY
          The Feature: http://com.xmlmill/transform/xslt-transformation-only"

Constructor Summary

JAXPTransformer()
          Zero argument default constructor.

JAXPTransformer(java.io.File xmlfile)
          Constructor of a PDXTransform object.

Method Summary

java.lang.String getBaseURL()
          Returns the baseURL against which relative URLs will be solved in the result-tree.

org.xml.sax.ContentHandler getContentHandler()
          Returns the internal ContentHandler instance used to analyse the SAX events.

int getDocumentSize()
          Returns the size of the generated document (in bytes).

boolean getFeature(java.lang.String name)
          Defines if the feature is set.

javax.xml.validation.Schema getSchema()
          Returns the defined javax.xml.validation.Schema instance.

java.lang.String getSchemaLocation(java.lang.String uri)
          Return the URI of a schema to use to validate the result-tree against.

javax.xml.transform.Templates getTemplates()
          Returns the javax.xml.transform.Templates instance defined

boolean isValidating()
          Returns if validation is on.

void printComments(boolean b)
          Deprecated. Use setFeature() instead.

void setBaseURL(java.io.File f)
          Sets the URL against which relative URLs in the result-tree will be resolved.

void setBaseURL(java.lang.String url)
          Defines the URL against which relative URLs in the result-tree will be resolved.

void setBaseURL(java.net.URL url)
          Sets the URI against which relative URIs in the result-tree will be resolved.

void setDocumentSize(int size)
          Defines the minimum size the document should contain (in bytes).

void setErrorHandler(JAXPErrorHandler handler)
          Defines the behavior of the errorhandler.

void setFeature(java.lang.String name, boolean b)
          Sets the particular feature in the underlying implementation of com.xmlmill.PDXTransformHandler.

void setOutput(java.io.OutputStream ostream)
          Deprecated. Use setOutPutStream() instead

void setOutputFolder(java.io.File f)
          Define the outputfolder.

void setOutputStream(java.io.OutputStream ostream)
          Defines the outputstream to put result in.

void setSchema(javax.xml.validation.Schema schema)
          Defines a javax.xml.validation.Schema instance.

void setSchemaLocation(java.lang.String uri)
          Defines the javax.xml.validation.Schema to use to validate the result-tree against.

void setStylesheetParam(java.lang.String name, java.lang.Object value)
          Add a parameter for the transformation Pass a qualified name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name.

void setTemplates(javax.xml.transform.Templates t)
          Defines a javax.xml.transform.Templates instance.

void setValidating(boolean b)
          Defines if the result tree of the xml/xsl transformation process should be validated.

void setXMLDocument(org.w3c.dom.Document doc)
          Defines the XML Document to be used.

void setXMLDocument(java.io.File f)
          Defines the XML Document to be used.

void setXMLDocument(java.io.InputStream stream)
          Defines the XML Document to be used.

void setXMLDocument(java.io.Reader reader)
          Defines the XML Document to be used.

void setXMLDocument(java.net.URL url)
          Defines the XML Document to be used.

void setXMLEncoding(java.lang.String encoding)
          Defines the XML encoding to be used.

void setXMLFile(java.io.File f)
          Deprecated. use setXMLDocument() instead.

void setXMLPublicid(java.lang.String publicid)
          Defines the public identifier for this XML input source.

void setXMLReader(java.io.Reader reader)
          Deprecated. use setXMLDocument() instead.

void setXMLStream(java.io.InputStream stream)
          Deprecated. use setXMLDocument() instead.

void setXMLSystemId(java.io.File f)
          Deprecated. Use setBaseURL() instead.

void setXMLSystemId(java.lang.String systemid)
          Deprecated. Use setBaseURL() instead.

void setXMLSystemId(java.net.URL systemid)
          Deprecated. Use setBaseURL() instead.

void setXMLUrl(java.net.URL url)
          Deprecated. use setXMLDocument() instead.

void setXSLDocument(org.w3c.dom.Document doc)
          Defines the the XSL Document as a DOM document.

void setXSLDocument(java.io.File f)
          Defines the XSL file used to convert a XML file.

void setXSLDocument(java.io.InputStream stream)
          Defines the XSL stream to be used.

void setXSLDocument(java.io.Reader reader)
          Defines the XSL reader to be used.

void setXSLDocument(java.net.URL url)
          Defines the XSL URL to be used.

void setXSLFile(java.io.File f)
          Deprecated. Use setXSLDocument() instead.

void setXSLReader(java.io.Reader reader)
          Deprecated. Use setXSLDocument() instead.

void setXSLStream(java.io.InputStream stream)
          Deprecated. Use setXSLDocument() instead.

void setXSLSystemId(java.io.File f)
          Deprecated. Use setBaseURL() instead.

void setXSLSystemId(java.lang.String systemid)
          Deprecated. Use setBaseURL() instead.

void setXSLSystemId(java.net.URL systemid)
          Deprecated. Use setBaseURL() instead.

void setXSLTTransformationOnly(boolean b)
          Deprecated. Use setFeature() instead.

void setXSLUrl(java.net.URL url)
          Deprecated. Use setXSLDocument() instead.

void transform()
          Generates a pdf file from a (xmlmill) xml file.

Methods inherited from class java.lang.Object

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

Field Detail

XSLTONLY

public static final java.lang.String XSLTONLY

The Feature: http://com.xmlmill/transform/xslt-transformation-only"

Constructor Detail

JAXPTransformer

public JAXPTransformer()

Zero argument default constructor.

Since:: 1.25

JAXPTransformer

public JAXPTransformer(java.io.File xmlfile)

Constructor of a PDXTransform object.

Generate a JAXPTransform instance for every xml file to generate.

Parameters:: xmlfile - File representing a (xmlmill) xml file.
Since:: 1.0

Method Detail

setTemplates

public void setTemplates(javax.xml.transform.Templates t)

Defines a javax.xml.transform.Templates instance.

This javax.xml.transform.Templates instance is used to define an internal javax.xml.transform.Transformer instance.

If a Templates instance is defined, it will take precedence over a xsl-stylesheet defined in an xml document (using the <?xml-stylesheet href="..." type="text/xsl"?> tag).

Parameters:: templates - A javax.xml.transform.Templates instance.
Since:: 2.20

getTemplates

public javax.xml.transform.Templates getTemplates()

Returns the javax.xml.transform.Templates instance defined

Returns:: The Templates object that was created, or null if no Templates object has been created.
Since:: 2.20

setSchema

public void setSchema(javax.xml.validation.Schema schema)

Defines a javax.xml.validation.Schema instance.

The javax.xml.validation.Schema class is an "immutable" memory representation of schema. Once the schemas are loaded into memory and represented as a Schema instance, it can be used for validation. In this way, a single Schema instance can be shared with many different parser instances even running in different threads. Applications are encouraged to be written so that the same set of schema are parsed only once and the same Schema instance is passed to different instances of the parser.

Note:You need a JAXP 1.3 compliant implementation to use this method successfully.

Parameters:: schema - A javax.xml.validation.Schema instance.
Since:: 2.20

setSchemaLocation

public void setSchemaLocation(java.lang.String uri)
                       throws XMLMillFatalError

Defines the javax.xml.validation.Schema to use to validate the result-tree against.

Note:You need a JAXP 1.3 compliant implementation to use this method successfully.

Parameters:: String - representing the Schema location as a URI. The URI should be fully resolved. For example: http://www. xmlmill.com/test/xmlmill.xsd or file:///c:/xmlmill/test/xmlmill.xsd
Throws:: XMLMillFatalError - when a XMLMill fatal error occurs.
Since:: 2.20

getSchemaLocation

public java.lang.String getSchemaLocation(java.lang.String uri)
                                   throws XMLMillFatalError

Return the URI of a schema to use to validate the result-tree against.

Returns:: String representing the URI of Schema location.
Throws:: XMLMillFatalError - when a XMLMill fatal error occurs.
Since:: 2.20

getSchema

public javax.xml.validation.Schema getSchema()

Returns the defined javax.xml.validation.Schema instance.

Returns:: A javax.xml.validation.Schema instance.
Since:: 2.20

setXMLDocument

public void setXMLDocument(java.io.File f)

Defines the XML Document to be used.

Define the XML Document to be used via a java.io.File reference.

Parameters:: f - File representing the XML Document.
Since:: 2.20

setXMLDocument

public void setXMLDocument(java.io.InputStream stream)

Defines the XML Document to be used.

Define the XML Document to be used via a java.io.Inputstream reference.

Parameters:: stream - InputStream representing the XML data.
Since:: 2.20

setXMLDocument

public void setXMLDocument(java.io.Reader reader)

Defines the XML Document to be used.

Define the XML Document to be used via a java.io.Reader reference.

Parameters:: reader - Reader representing the XML data.
Since:: 2.20

setXMLDocument

public void setXMLDocument(java.net.URL url)

Defines the XML Document to be used.

Define the XML Document to be used via a java.io.URL reference.

Parameters:: url - URL representing the XML data.
Since:: 1.25

setXMLDocument

public void setXMLDocument(org.w3c.dom.Document doc)

Defines the XML Document to be used.

Define the XML Document to be used via a org.w3c.dom.Document reference.

Parameters:: doc - a org.w3c.dom.Document object.
Since:: 1.40

setXSLDocument

public void setXSLDocument(java.io.File f)

Defines the XSL file used to convert a XML file.

This file will be used if the XML file does not contain a reference to a XSL file. If it does, this XSL file will be ignored.

Parameters:: f - File representing the outputfolder.
Since:: 2.20

setXSLDocument

public void setXSLDocument(java.io.InputStream stream)

Defines the XSL stream to be used.

Parameters:: stream - InputStream representing the XSLDocument.
Since:: 2.20

setXSLDocument

public void setXSLDocument(java.io.Reader reader)

Defines the XSL reader to be used.

Parameters:: reader - Reader representing the XSLDocument.
Since:: 2.20

setXSLDocument

public void setXSLDocument(java.net.URL url)

Defines the XSL URL to be used.

Parameters:: url - URL representing the XSLDocument.
Since:: 2.20

setXSLDocument

public void setXSLDocument(org.w3c.dom.Document doc)

Defines the the XSL Document as a DOM document.

Parameters:: doc - a org.w3c.dom.Document object.
Since:: 1.40

setBaseURL

public void setBaseURL(java.lang.String url)
                throws XMLMillFatalError

Defines the URL against which relative URLs in the result-tree will be resolved.

Generally, it's only necessary to set this property if the result-tree contains relative URLs.

Relative URIs are not allowed here. Base URIs must be absolute. The base URI may not be set to null or an empty string./p>

Parameters:: URL - representing the base URL. The URL should be fully resolved. For example: "http://www. xmlmill.com/test/" or "file:///c:/xmlmill/test/"
Throws:: XMLMillFatalError - when a XMLMill fatal error occurs.
Since:: 2.20

setBaseURL

public void setBaseURL(java.io.File f)
                throws XMLMillFatalError

Sets the URL against which relative URLs in the result-tree will be resolved.

Generally, it's only necessary to set this property if the result-tree contains relative URLs.

Relative URIs are not allowed here. Base URIs must be absolute. The base URI may not be set to null or an empty string./p>

Parameters:: f - File representing the System Identifier.
Throws:: XMLMillFatalError - when a XMLMill fatal error occurs.
Since:: 2.20

setBaseURL

public void setBaseURL(java.net.URL url)
                throws XMLMillFatalError

Sets the URI against which relative URIs in the result-tree will be resolved.

Generally, it's only necessary to set this property if the result-tree contains relative URIs.

Relative URIs are not allowed here. Base URIs must be absolute. The base URI may not be set to null or an empty string./p>

Parameters:: URI - representing the base URI. The URI should be fully resolved. For example: "http://www. xmlmill.com/test/" or "file:///c:/xmlmill/test/"
Throws:: XMLMillFatalError - when a XMLMill fatal error occurs.
Since:: 2.20

getBaseURL

public java.lang.String getBaseURL()

Returns the baseURL against which relative URLs will be solved in the result-tree.

Returns:: String representing the baseURL.
Since:: 2.20

setOutputFolder

public void setOutputFolder(java.io.File f)

Define the outputfolder.

The outputfolder is the folder where the generated pdf files will be put in. If no outputfolder is defined, the pdf file will be put in the folder that is defined in the XMLMill tag. If the XMLMill tag defines a folder, the outputfolder defined here will override this.

Parameters:: f - File representing the outputfolder.
Since:: 1.1a

setValidating

public void setValidating(boolean b)

Defines if the result tree of the xml/xsl transformation process should be validated.

For backwards compatibility the validation is per default off.

Parameters:: b - boolean if validation should be done.
Since:: 2.20

isValidating

public boolean isValidating()

Returns if validation is on.

Returns:: boolean if validation should be done.
Since:: 2.20

setFeature

public void setFeature(java.lang.String name,
                       boolean b)
                throws XMLMillNotRecognizedException

Sets the particular feature in the underlying implementation of com.xmlmill.PDXTransformHandler.

The following features can be defined:

http://com.xmlmill/transform/XSLTTransformationOnly

true: Only a XSLT transformation should be done. The generated xml file that is normally send to the XMLMill transform object is written to a file.

false: A normal transformation is done (a .pdf file is generated).

Default: Feature is not set (false).

Parameters:: name - The name of the feature to be set.; b - The value of the feature to be set.
Throws:: XMLMILLNotRecognizedException - When the property-name is not recognized.
Since:: 1.40
See Also:: XSLTONLY

getFeature

public boolean getFeature(java.lang.String name)
                   throws XMLMillNotRecognizedException

Defines if the feature is set.

See setFeature() for more information concerning which features can be defined.

Parameters:: name - The feature name, as a complete URI.
Returns:: boolean representing the current feature state.
Throws:: XMLMILLNotRecognizedException - When the property-name is not recognized.
Since:: 1.40

setXMLPublicid

public void setXMLPublicid(java.lang.String publicid)

Defines the public identifier for this XML input source.

The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.

Parameters:: publicid - String representing the public identifier.
Since:: 1.25

setXMLEncoding

public void setXMLEncoding(java.lang.String encoding)

Defines the XML encoding to be used.

Set the character encoding, if known. The encoding must be a string acceptable for an XML encoding declaration (see section 4.3.3 of the XML 1.0 recommendation). This method has no effect when the application provides a character stream.

Parameters:: encoding - String describing the character encoding.
Since:: 1.25

setOutputStream

public void setOutputStream(java.io.OutputStream ostream)

Defines the outputstream to put result in.

If the XMLMill 'file' attribute in the <document> tag defines a filename, the outputstream defined here will override this.

Parameters:: ostream - Outputstream representing the outputstream.
Since:: 1.27

getDocumentSize

public int getDocumentSize()

Returns the size of the generated document (in bytes).

Returns the size of the generated document. This method can be used by a servlet to get the number of bytes written to the stream so it can be mentioned in the setContentLength() method of the response object.

Returns:: int representing the size of the document (in bytes).
Since:: 1.25

setDocumentSize

public void setDocumentSize(int size)

Defines the minimum size the document should contain (in bytes).

With IE it is possible that when the size of the PDF document is smaller than the buffer-size defined by your servlet container, the document is not displayed (although Adobe opens correctly). With this method XMLMill is forced to generate a document that has a least a minimum size of the parameter passed.

Parameters:: size - representing the minimum size of the document (in bytes).
Since:: 1.53

setErrorHandler

public void setErrorHandler(JAXPErrorHandler handler)

Defines the behavior of the errorhandler.

Defines whether or not the log and stop processing when a error or warning happens.

Parameters:: handler - the errors handler.
Since:: 1.25

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()
                                             throws org.xml.sax.SAXException,
                                                    XMLMillFatalError,
                                                    java.io.IOException

Returns the internal ContentHandler instance used to analyse the SAX events.

*** This method should be used with care (and preferably not at all). ***

Returns the internal ContentHandler instance that is responsible for analyzing (and acting upon) the SAX events it receives.

The returned ContentHandler is:

an instance of an internal PDXTransformHandler instance responsible for analyzing (and acting upon) the SAX events it receives.
a ValidatorHandler instance that is wrapped around the internal PDXTransformHandler instance and will perform validation first before the SAX events are passed to the PDXTransformHandler instance .

Note:

The ValidatorHandler instance will only be instantiated when following conditions are met:

Validation has been requested, using the setValidation() method.
The underlying implementation of the JAXP interface is JAXP 1.3 compliant (the setVersion() method is used to define the correct version.
The schema to use has been defined using the setSchemaLocation() method or setSchema() method.

Note:This method can be used if you have built the ML tree yourself and willing to fire the SAX events yourselves to a org.xml.sax.ContentHandler instance.

Returns:: ContentHandler representing the ContentHandler instance.
Throws:: org.xml.sax.SAXException -; XMLMillException -
Since:: 1.52, 2.20

setStylesheetParam

public void setStylesheetParam(java.lang.String name,
                               java.lang.Object value)

Add a parameter for the transformation

Pass a qualified name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name. If the name has a null URL, the String only contain the local name. An application can safely check for a non-null URI by testing to see if the first character of the name is a '{' character.

For example, if a URI and local name were obtained from an element defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>, then the qualified name would be "http://xyz.foo.com/yada/baz.html}foo". Note that no prefix is used.

Parameters:: name - The name of the parameter, which may begin with a namespace URI in curly braces ({}).; value - The value object. This can be any valid Java object. It is up to the processor to provide the proper object coersion or to simply pass the object on for use in an extension.
Returns:: int representing the size of the document (in bytes).
Since:: 1.52

transform

public void transform()
               throws javax.xml.transform.TransformerException,
                      javax.xml.transform.TransformerConfigurationException,
                      java.io.IOException,
                      org.xml.sax.SAXException,
                      java.lang.Exception,
                      XMLMillException

Generates a pdf file from a (xmlmill) xml file.

Calling this method will start the actual generation process.

Throws:: javax.xml.transform.TransformerException -; javax.xml.transform.TransformerConfigurationException -; java.io.IOException -; org.xml.sax.SAXException -; java.lang.Exception -; XMLMillException -
Since:: 1.0

setXMLFile

public void setXMLFile(java.io.File f)

Deprecated. use setXMLDocument() instead.

Defines the XML file to be used.

Parameters:: f - File representing the XML data.
Since:: 1.20

setXMLStream

public void setXMLStream(java.io.InputStream stream)

Deprecated. use setXMLDocument() instead.

Defines the XML stream to be used.

Parameters:: stream - InputStream representing the XML data.
Since:: 1.25

setXMLReader

public void setXMLReader(java.io.Reader reader)

Deprecated. use setXMLDocument() instead.

Defines the XML reader to be used.

Parameters:: reader - Reader representing the XML data.
Since:: 1.25

setXMLUrl

public void setXMLUrl(java.net.URL url)

Deprecated. use setXMLDocument() instead.

Defines the XML URL to be used.

Parameters:: url - URL representing the XML data.
Since:: 1.25

setXSLTTransformationOnly

public void setXSLTTransformationOnly(boolean b)

Deprecated. Use setFeature() instead.

Defines if only a XSLT transformation should be done.

If true the generated xml file that is normally send to the XMLMill transform object will now be written to a file.

Parameters:: b - boolean defining is XSLT transformation should be done only.
Since:: 1.35

printComments

public void printComments(boolean b)

Deprecated. Use setFeature() instead.

Define if comment are logged.

All comments, which are send to the LexicalHandler are printed in the logfile.

Parameters:: b - boolean indication whether or not to print comments in the log file.
Since:: 1.25