Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.odftoolkit.odfdom.pkg
Class OdfXMLHelper

java.lang.Object
  extended by org.odftoolkit.odfdom.pkg.OdfXMLHelper

public class OdfXMLHelper
extends java.lang.Object

Constructor Summary
OdfXMLHelper()
           
 
Method Summary
 org.xml.sax.XMLReader newXMLReader(OdfPackage pkg)
          create an XMLReader with a Resolver set to parse content in a ODF Package
 void parse(OdfPackage pkg, java.lang.String path, org.xml.sax.ContentHandler contentHandler, org.xml.sax.ErrorHandler errorHandler)
          use SAX parser to parse content of package
 void transform(OdfPackage pkg, java.lang.String path, java.io.File template)
          Do XSL-Transformation on content contained in package insert result back to package
 void transform(OdfPackage pkg, java.lang.String path, java.io.File template, java.io.File out)
          Do XSL-Transformation on content contained in package
 void transform(OdfPackage pkg, java.lang.String path, javax.xml.transform.Source templateSource, java.io.File out)
          Do XSL-Transformation on content contained in package
 void transform(OdfPackage pkg, java.lang.String path, javax.xml.transform.Source templateSource, javax.xml.transform.Result result)
          Do XSL-Transformation on content contained in package
 void transform(OdfPackage pkg, java.lang.String path, javax.xml.transform.Source templateSource, java.lang.String outPath)
          Do XSL-Transformation on content contained in package
 void transform(OdfPackage pkg, java.lang.String path, java.lang.String templatePath)
          Do XSL-Transformation on content contained in package insert result back to package
 void transform(OdfPackage pkg, java.lang.String path, java.lang.String templatePath, java.lang.String outPath)
          Do XSL-Transformation on content contained in package
 void transform(OdfPackage pkg, java.lang.String path, javax.xml.transform.Templates templates)
          Do XSL-Transformation on content contained in package and insert result back to package
 void transform(OdfPackage pkg, java.lang.String path, javax.xml.transform.Templates templates, javax.xml.transform.Result result)
          Does an XSL-Transformation on content contained in package.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OdfXMLHelper

public OdfXMLHelper()
Method Detail

newXMLReader

public org.xml.sax.XMLReader newXMLReader(OdfPackage pkg)
                                   throws org.xml.sax.SAXException,
                                          javax.xml.parsers.ParserConfigurationException
create an XMLReader with a Resolver set to parse content in a ODF Package

Parameters:
pkg - the ODF Package
Returns:
a SAX XMLReader
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

parse

public void parse(OdfPackage pkg,
                  java.lang.String path,
                  org.xml.sax.ContentHandler contentHandler,
                  org.xml.sax.ErrorHandler errorHandler)
           throws org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException,
                  java.io.IOException,
                  java.lang.IllegalArgumentException,
                  javax.xml.transform.TransformerConfigurationException,
                  javax.xml.transform.TransformerException
use SAX parser to parse content of package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
contentHandler - a SAX Content handler to receive SAX Events
errorHandler - a SAX Error handler to be called on errors during parsing
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException
java.lang.IllegalArgumentException
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      java.lang.String templatePath,
                      java.lang.String outPath)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
templatePath - a path to a file in the filesystem containing an XSL Template
outPath - a path in the filesystem for the output of the XSL Transformation
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      javax.xml.transform.Source templateSource,
                      java.lang.String outPath)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
templateSource - TraX Source of an XSL Transformation Template
outPath - path to an output file for the XSL Transformation
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      javax.xml.transform.Source templateSource,
                      java.io.File out)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
templateSource - TraX Source of an XSL Transformation
out - an output File
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      java.lang.String templatePath)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package insert result back to package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
templatePath - path inside the filesystem to an XSL template file
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      java.io.File template,
                      java.io.File out)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
template - File containing an XSLT Template
out - File for the XSLT ouput
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      java.io.File template)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package insert result back to package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
template - a File containing an XSLT Template
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      javax.xml.transform.Source templateSource,
                      javax.xml.transform.Result result)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
templateSource - TraX Source of an XSLT Template
result - TraX Result of XSL-Tranformation
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      javax.xml.transform.Templates templates,
                      javax.xml.transform.Result result)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Does an XSL-Transformation on content contained in package.

There are three default parameteres provided to the transformation: There are three default parameteres provided to the transformation:
  1. sourceURL: the URL of the source directory
  2. sourceBaseURL: baseURL of the source file (the package). This URL necessary to access any content within the package from the XSLT scripts. The relative package path will concatenated after the 'sourceBaseURL'.
  3. targetURL: the URL of the target directory
  4. targetBaseURL:the baseURL of the target file

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
templates - TraX XSLT Template
result - TraX XSLT Result
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

transform

public void transform(OdfPackage pkg,
                      java.lang.String path,
                      javax.xml.transform.Templates templates)
               throws javax.xml.transform.TransformerConfigurationException,
                      javax.xml.transform.TransformerException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException
Do XSL-Transformation on content contained in package and insert result back to package

Parameters:
pkg - a OdfPackage
path - a path inside the OdfPackage, eg. to a contained content.xml stream
templates - Trax XSLT Template
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
java.io.IOException
java.lang.IllegalArgumentException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2008-2010 ODF Toolkit Project. All Rights Reserved.