org.codehaus.mojo.xml.transformer
Class TransformationSet

java.lang.Object
  extended by org.codehaus.mojo.xml.transformer.TransformationSet

public class TransformationSet
extends java.lang.Object

An instance of this class is used to specify a set of files, which are transformed by a common XSLT stylesheet.


Constructor Summary
TransformationSet()
           
 
Method Summary
 NameValuePair[] getAttributes()
          Returns the attributes, which should be set on the transformer factory.
 java.io.File getDir()
          Returns a directory, which is scanned for files to transform.
 java.lang.String[] getExcludes()
          Returns patterns of files, which are being excluded from the transformation set.
 NameValuePair[] getFeatures()
          Returns the features, which should be set on the transformer factory.
 org.codehaus.plexus.components.io.filemappers.FileMapper[] getFileMappers()
          Returns a set of file mappers, which are being used to convert the generated files name.
 java.lang.String[] getIncludes()
          Returns patterns of files, which are being included into the transformation set.
 java.lang.String[] getOtherDepends()
          Returns patterns of additional files, which are being considered for the uptodate check.
 java.io.File getOutputDir()
          Returns the output directory, where the generated files are being placed.
 NameValuePair[] getOutputProperties()
          Returns the transformers output properties.
 NameValuePair[] getParameters()
          Returns the stylesheet parameters.
 java.io.File getStylesheet()
          Returns the XSLT stylesheet, which is being used to control the transformation.
 boolean isAddedToClasspath()
          Returns, whether the output directory is added to the classpath.
 boolean isSkipDefaultExcludes()
          Returns, whether Maven's default excludes are being ignored.
 boolean isValidating()
          Returns, whether the transformer should create validating XML parsers for reading XML documents.
 void setAddedToClasspath(boolean pAddedToClasspath)
          Sets, whether the output directory is added to the classpath.
 void setAttributes(NameValuePair[] pAttributes)
          Sets the attributes, which should be set on the transformer factory.
 void setDir(java.io.File pDir)
          Sets the name of a directory, which is scanned for files to transform.
 void setExcludes(java.lang.String[] pExcludes)
          Sets patterns of files, which are being excluded from the transformation set.
 void setFeatures(NameValuePair[] pFeatures)
          Sets the features, which should be set on the transformer factory.
 void setFileMappers(org.codehaus.plexus.components.io.filemappers.FileMapper[] pFileMappers)
          Sets a set of file mappers, which are being used to convert the generated files name.
 void setIncludes(java.lang.String[] pIncludes)
          Sets patterns of files, which are being included into the transformation set.
 void setOtherDepends(java.lang.String[] pOtherDepends)
          Sets patterns of additional files, which are being considered for the uptodate check.
 void setOutputDir(java.io.File pOutputDir)
          Sets the output directory, where the generated files are being placed.
 void setOutputProperties(NameValuePair[] pOutputProperties)
          Sets the transformers output properties.
 void setParameters(NameValuePair[] pParameters)
          Sets the stylesheet parameters.
 void setSkipDefaultExcludes(boolean pSkipDefaultExcludes)
          Sets, whether Maven's default excludes are being ignored.
 void setStylesheet(java.io.File pStylesheet)
          Sets the XSLT stylesheet, which is being used to control the transformation.
 void setValidating(boolean pValidating)
          Sets, whether the transformer should create validating XML parsers for reading XML documents.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransformationSet

public TransformationSet()
Method Detail

setExcludes

public void setExcludes(java.lang.String[] pExcludes)
Sets patterns of files, which are being excluded from the transformation set.


setIncludes

public void setIncludes(java.lang.String[] pIncludes)
Sets patterns of files, which are being included into the transformation set.


setOtherDepends

public void setOtherDepends(java.lang.String[] pOtherDepends)
Sets patterns of additional files, which are being considered for the uptodate check.


setParameters

public void setParameters(NameValuePair[] pParameters)
Sets the stylesheet parameters.


getDir

public java.io.File getDir()
Returns a directory, which is scanned for files to transform.


getExcludes

public java.lang.String[] getExcludes()
Returns patterns of files, which are being excluded from the transformation set.


getIncludes

public java.lang.String[] getIncludes()
Returns patterns of files, which are being included into the transformation set.


getOtherDepends

public java.lang.String[] getOtherDepends()
Returns patterns of additional files, which are being considered for the uptodate check.


getOutputDir

public java.io.File getOutputDir()
Returns the output directory, where the generated files are being placed. Defaults to {project.build.directory}/generated-resources/xml/xslt.


getParameters

public NameValuePair[] getParameters()
Returns the stylesheet parameters.


getStylesheet

public java.io.File getStylesheet()
Returns the XSLT stylesheet, which is being used to control the transformation.


isAddedToClasspath

public boolean isAddedToClasspath()
Returns, whether the output directory is added to the classpath. Defaults to false.


isSkipDefaultExcludes

public boolean isSkipDefaultExcludes()
Returns, whether Maven's default excludes are being ignored. Defaults to false (Default excludes are being used).


setAddedToClasspath

public void setAddedToClasspath(boolean pAddedToClasspath)
Sets, whether the output directory is added to the classpath. Defaults to false.


setDir

public void setDir(java.io.File pDir)
Sets the name of a directory, which is scanned for files to transform.


setOutputDir

public void setOutputDir(java.io.File pOutputDir)
Sets the output directory, where the generated files are being placed. Defaults to {project.build.directory}/generated-resources/xml/xslt.


setSkipDefaultExcludes

public void setSkipDefaultExcludes(boolean pSkipDefaultExcludes)
Sets, whether Maven's default excludes are being ignored. Defaults to false (Default excludes are being used).


setStylesheet

public void setStylesheet(java.io.File pStylesheet)
Sets the XSLT stylesheet, which is being used to control the transformation.


getFileMappers

public org.codehaus.plexus.components.io.filemappers.FileMapper[] getFileMappers()
Returns a set of file mappers, which are being used to convert the generated files name.


setFileMappers

public void setFileMappers(org.codehaus.plexus.components.io.filemappers.FileMapper[] pFileMappers)
Sets a set of file mappers, which are being used to convert the generated files name.


isValidating

public boolean isValidating()
Returns, whether the transformer should create validating XML parsers for reading XML documents. The default value is false.


setValidating

public void setValidating(boolean pValidating)
Sets, whether the transformer should create validating XML parsers for reading XML documents. The default value is false.


getOutputProperties

public NameValuePair[] getOutputProperties()
Returns the transformers output properties.


setOutputProperties

public void setOutputProperties(NameValuePair[] pOutputProperties)
Sets the transformers output properties.


getFeatures

public NameValuePair[] getFeatures()
Returns the features, which should be set on the transformer factory.


setFeatures

public void setFeatures(NameValuePair[] pFeatures)
Sets the features, which should be set on the transformer factory.


getAttributes

public NameValuePair[] getAttributes()
Returns the attributes, which should be set on the transformer factory.


setAttributes

public void setAttributes(NameValuePair[] pAttributes)
Sets the attributes, which should be set on the transformer factory.



Copyright © 2006-2010 The Apache Software Foundation. All Rights Reserved.