de.opsdesign.yax.tools
Class YaxTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          de.opsdesign.yax.tools.YaxTask

All Implemented Interfaces:

ArgsHandler, java.lang.Cloneable

public class YaxTask
extends org.apache.tools.ant.Task
implements ArgsHandler

runs yax (an xproc (xml pipeline language) processor) which applies the xproc pipeline script to the input resources.

Since:

yax 0.8

Field Summary

protected boolean	debug if set to true, yax logs also debug messages.
protected boolean	force if set to true, existant output files will be overwritten.
protected java.io.File	in input file (for treating a single file)
protected java.util.List<org.apache.tools.ant.types.ResourceCollection>	inList multiple input files (receives all include files from fileset)
protected boolean	noOutputfile set to 'true' supresses generation of (top level) output file(s).
protected java.io.File	out output file (only if a single input file is used (will say 'in' is used).
protected java.io.File	outDir output directory (if omitted input file parent will be used instead)
protected java.lang.String	outPattern output file name pattern use like {$inTrunk}.output.
protected java.util.List<org.apache.tools.ant.taskdefs.Property>	properties start parameters equivalent to the start parameter of command line uses + properties of the properties file(s)
protected java.io.File	propertyfile property file. its content overrides the yax property file (if there are any)
protected boolean	quiet if set to true, yax logs only very important events.
protected java.io.File	script xproc script file.
protected boolean	verbose if set to true, yax comments intensively the progress.

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Fields inherited from interface de.opsdesign.yax.ArgsHandler

IN_LIST, NO_OUPUTFILE, OUT_DIR, OUT_PATTERN

Constructor Summary

YaxTask()

Method Summary

void	add(org.apache.tools.ant.taskdefs.Property property)
void	add(org.apache.tools.ant.types.ResourceCollection inputs) Adds input files to treat as input.
org.apache.tools.ant.types.Path	createClasspath()
void	execute()
java.io.File	getIn() Sets the single file to treat as input.
java.io.File	getOut()
java.io.File	getOutDir()
java.lang.String	getOutPattern()
java.io.File	getPropertyfile()
java.io.File	getScript()
void	init() Initialize internal instance of XMLCatalog
boolean	isDebug()
boolean	isForce() Get the XML catalog containing entity definitions
boolean	isNoOutputfile()
boolean	isQuiet()
boolean	isVerbose()
void	setClasspathRef(org.apache.tools.ant.types.Reference r)
void	setDebug(boolean debug)
void	setForce(boolean force)
void	setIn(java.io.File in)
void	setNoOutputfile(boolean noOutputfile)
void	setOut(java.io.File out)
void	setOutDir(java.io.File outDir)
void	setOutPattern(java.lang.String outPattern)
void	setPropertyfile(java.io.File propertyfile)
void	setQuiet(boolean quiet)
void	setScript(java.io.File script)
void	setVerbose(boolean verbose)

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Field Detail

verbose

protected boolean verbose

if set to true, yax comments intensively the progress.

quiet

protected boolean quiet

if set to true, yax logs only very important events.

debug

protected boolean debug

if set to true, yax logs also debug messages.

propertyfile

protected java.io.File propertyfile

property file. its content overrides the yax property file (if there are any)

in

protected java.io.File in

input file (for treating a single file)

out

protected java.io.File out

output file (only if a single input file is used (will say 'in' is used).

outDir

protected java.io.File outDir

output directory (if omitted input file parent will be used instead)

outPattern

protected java.lang.String outPattern

output file name pattern use like {$inTrunk}.output.{inExtension}

noOutputfile

protected boolean noOutputfile

set to 'true' supresses generation of (top level) output file(s). (Takes no effect of inner outputs)

script

protected java.io.File script

xproc script file.

force

protected boolean force

if set to true, existant output files will be overwritten.

properties

protected java.util.List<org.apache.tools.ant.taskdefs.Property> properties

start parameters equivalent to the start parameter of command line uses + properties of the properties file(s)

inList

protected java.util.List<org.apache.tools.ant.types.ResourceCollection> inList

multiple input files (receives all include files from fileset)

Constructor Detail

YaxTask

public YaxTask()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

init

public void init()
          throws org.apache.tools.ant.BuildException

Initialize internal instance of XMLCatalog

Overrides:

init in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - on error

add

public void add(org.apache.tools.ant.types.ResourceCollection inputs)

Adds input files to treat as input.

Parameters:

inputs - a set of input files to treat as input documents.

Since:

yax 0.7

add

public void add(org.apache.tools.ant.taskdefs.Property property)

isForce

public boolean isForce()

Get the XML catalog containing entity definitions

Returns:

the XML catalog for the task.

setForce

public void setForce(boolean force)

getIn

public java.io.File getIn()

Sets the single file to treat as input.

Parameters:

in - a single input file to treat as input document.

Since:

yax 0.7

setIn

public void setIn(java.io.File in)

getOut

public java.io.File getOut()

setOut

public void setOut(java.io.File out)

getOutDir

public java.io.File getOutDir()

setOutDir

public void setOutDir(java.io.File outDir)

getOutPattern

public java.lang.String getOutPattern()

setOutPattern

public void setOutPattern(java.lang.String outPattern)

getScript

public java.io.File getScript()

setScript

public void setScript(java.io.File script)

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference r)

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

getPropertyfile

public java.io.File getPropertyfile()

setPropertyfile

public void setPropertyfile(java.io.File propertyfile)

isQuiet

public boolean isQuiet()

setQuiet

public void setQuiet(boolean quiet)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)

isNoOutputfile

public boolean isNoOutputfile()

setNoOutputfile

public void setNoOutputfile(boolean noOutputfile)