TraXLiaison (Apache Ant API)
Date: 2008-06-27

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

## org.apache.tools.ant.taskdefs.optional
Class TraXLiaison

    java.lang.Object
      org.apache.tools.ant.taskdefs.optional.TraXLiaison

All Implemented Interfaces:
  javax.xml.transform.ErrorListener, XSLTLiaison, XSLTLiaison2, XSLTLiaison3, XSLTLoggerAware

    public class TraXLiaison

extends java.lang.Object
implements XSLTLiaison3, javax.xml.transform.ErrorListener, XSLTLoggerAware

Concrete liaison for XSLT processor implementing TraX. (ie JAXP 1.1)

Since:
  Ant 1.3

Field Summary

Fields inherited from interface org.apache.tools.ant.taskdefs.XSLTLiaison
`FILE_PROTOCOL_PREFIX`

Constructor Summary
`TraXLiaison()` Constructor for TraXLiaison.

Method Summary
`void` | `addParam(java.lang.String name, java.lang.String value)` Add a parameter.
`void` | `configure(XSLTProcess xsltTask)` Specific configuration for the TRaX liaison.
`void` | `error(javax.xml.transform.TransformerException e)` Log an error.
`void` | `fatalError(javax.xml.transform.TransformerException e)` Log a fatal error.
`protected java.lang.String` | `getSystemId(java.io.File file)` Deprecated. since 1.5.x. Use org.apache.tools.ant.util.JAXPUtils#getSystemId instead.
`void` | `setAttribute(java.lang.String name, java.lang.Object value)` Set a custom attribute for the JAXP factory implementation.
`void` | `setEntityResolver(org.xml.sax.EntityResolver aResolver)` Set the class to resolve entities during the transformation.
`void` | `setFactory(java.lang.String name)` Set the factory name to use instead of JAXP default lookup.
`void` | `setLogger(XSLTLogger l)` Set a logger.
`void` | `setOutputProperty(java.lang.String name, java.lang.String value)` Set the output property for the current transformer.
`void` | `setStylesheet(java.io.File stylesheet)` Set the stylesheet file.
`void` | `setStylesheet(Resource stylesheet)` Set the stylesheet file.
`void` | `setURIResolver(javax.xml.transform.URIResolver aResolver)` Set the class to resolve URIs during the transformation
`void` | `transform(java.io.File infile, java.io.File outfile)` Transform an input file.
`void` | `warning(javax.xml.transform.TransformerException e)` Log a warning.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### TraXLiaison

    public TraXLiaison()
                throws java.lang.Exception

  Constructor for TraXLiaison.

  Throws:
    `java.lang.Exception` - never

Method Detail

### setStylesheet

    public void setStylesheet(java.io.File stylesheet)
                       throws java.lang.Exception

  Set the stylesheet file.

  Specified by:
    `setStylesheet` in interface `XSLTLiaison`
  Parameters:
    `stylesheet` - a `File` value
  Throws:
    `java.lang.Exception` - on error

### setStylesheet

    public void setStylesheet(Resource stylesheet)
                       throws java.lang.Exception

  Set the stylesheet file.

  Specified by:
    `setStylesheet` in interface `XSLTLiaison3`
  Parameters:
    `stylesheet` - a `Resource` value
  Throws:
    `java.lang.Exception` - on error

### transform

    public void transform(java.io.File infile,
                          java.io.File outfile)
                   throws java.lang.Exception

  Transform an input file.

  Specified by:
    `transform` in interface `XSLTLiaison`
  Parameters:
    `infile` - the file to transform
    `outfile` - the result file
  Throws:
    `java.lang.Exception` - on error
  See Also:
    `XSLTLiaison.setStylesheet(File)`

### setFactory

    public void setFactory(java.lang.String name)

  Set the factory name to use instead of JAXP default lookup.

  Parameters:
    `name` - the fully qualified class name of the factory to use or null for the default JAXP look up mechanism.
  Since:
    Ant 1.6

### setAttribute

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

  Set a custom attribute for the JAXP factory implementation.

  Parameters:
    `name` - the attribute name.
    `value` - the value of the attribute, usually a boolean string or object.
  Since:
    Ant 1.6

### setOutputProperty

    public void setOutputProperty(java.lang.String name,
                                  java.lang.String value)

  Set the output property for the current transformer. Note that the stylesheet must be set prior to calling this method.

  Parameters:
    `name` - the output property name.
    `value` - the output property value.
  Since:
    Ant 1.5, Ant 1.5

### setEntityResolver

    public void setEntityResolver(org.xml.sax.EntityResolver aResolver)

  Set the class to resolve entities during the transformation.

  Parameters:
    `aResolver` - the resolver class.

### setURIResolver

    public void setURIResolver(javax.xml.transform.URIResolver aResolver)

  Set the class to resolve URIs during the transformation

  Parameters:
    `aResolver` - a `EntityResolver` value

### addParam

    public void addParam(java.lang.String name,
                         java.lang.String value)

  Add a parameter.

  Specified by:
    `addParam` in interface `XSLTLiaison`
  Parameters:
    `name` - the name of the parameter
    `value` - the value of the parameter

### setLogger

    public void setLogger(XSLTLogger l)

  Set a logger.

  Specified by:
    `setLogger` in interface `XSLTLoggerAware`
  Parameters:
    `l` - a logger.

### error

    public void error(javax.xml.transform.TransformerException e)

  Log an error.

  Specified by:
    `error` in interface `javax.xml.transform.ErrorListener`
  Parameters:
    `e` - the exception to log.

### fatalError

    public void fatalError(javax.xml.transform.TransformerException e)

  Log a fatal error.

  Specified by:
    `fatalError` in interface `javax.xml.transform.ErrorListener`
  Parameters:
    `e` - the exception to log.

### warning

    public void warning(javax.xml.transform.TransformerException e)

  Log a warning.

  Specified by:
    `warning` in interface `javax.xml.transform.ErrorListener`
  Parameters:
    `e` - the exception to log.

### getSystemId

    protected java.lang.String getSystemId(java.io.File file)

  Deprecated. since 1.5.x. Use org.apache.tools.ant.util.JAXPUtils#getSystemId instead.

  Parameters:
    `file` - the filename to use for the systemid
  Returns:
    the systemid

### configure

    public void configure(XSLTProcess xsltTask)

  Specific configuration for the TRaX liaison.

  Specified by:
    `configure` in interface `XSLTLiaison2`
  Parameters:
    `xsltTask` - the XSLTProcess task instance from which this liasion is to be configured.

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