org.apache.uima.pear.tools
Class PearPackagingAntTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.uima.pear.tools.PearPackagingAntTask

All Implemented Interfaces:

Cloneable

public class PearPackagingAntTask
extends org.apache.tools.ant.Task

Class to create an ANT task to package a UIMA PEAR file. See the example below on how to add the target to your ant build.

 <!-- define the classpath settings for the pear packaging task. 
      uimaj-pear-task.jar and uima-core.jar is needed -->
 <path id="pearTask.classpath">
     <fileset dir="/home/apache-uima/lib/" includes="uimaj-pear-task.jar"/>
     <fileset dir="/home/apache-uima/lib/" includes="uima-core.jar"/>
 </path>
 
 <!-- pear packaging sample target -->
 <target name="pearPackagingSample">
     
   <!-- Define pear packaging task -->
   <taskdef name="packagePear" 
       classname="org.apache.uima.pear.tools.PearPackagingAntTask"
       classpathref="pearTask.classpath"/>

    <!-- Sample pear packaging -->
    <packagePear componentID="SampleAnnotator"
        mainComponentDesc="desc/mainComponentDesc.xml" 
        classpath="$main_root/pearClasspahtEntry;$main_root/anotherPearClasspahtEntry" 
        datapath="$main_root/resources"
        mainComponentDir="/home/user/workspace/SampeAnntotator" 
        targetDir="/home/user/pearArchive">
        <envVar name="ENV_VAR_NO1" value="value1"/>
        <envVar name="ENV_VAR_NO2" value="value2"/>
   </packagePear>
 </target>
 

Field Summary

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

Constructor Summary

PearPackagingAntTask()

Method Summary

void	addEnvVar(org.apache.tools.ant.types.Parameter envVar) add environment variable for the pear component
void	execute()
void	setClasspath(String classpath) set classpath for the pear component.
void	setComponentID(String componentID) set component ID for the pear component
void	setDatapath(String datapath) the datapath setting for the pear component
void	setMainComponentDesc(String mainComponentDesc) the main component descriptor for the pear component
void	setMainComponentDir(String mainComponentDir) the main component directory for the pear data
void	setTargetDir(String targetDir) the target directory for the output

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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

Constructor Detail

PearPackagingAntTask

public PearPackagingAntTask()

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

addEnvVar

public void addEnvVar(org.apache.tools.ant.types.Parameter envVar)

add environment variable for the pear component

Parameters:

envVar - environment variable setting

setClasspath

public void setClasspath(String classpath)

set classpath for the pear component.

Parameters:

classpath - the classpath to set

setComponentID

public void setComponentID(String componentID)

set component ID for the pear component

Parameters:

componentID - the componentID to set

setDatapath

public void setDatapath(String datapath)

the datapath setting for the pear component

Parameters:

datapath - the datapath to set

setMainComponentDesc

public void setMainComponentDesc(String mainComponentDesc)

the main component descriptor for the pear component

Parameters:

mainComponentDesc - the mainComponentDesc to set

setMainComponentDir

public void setMainComponentDir(String mainComponentDir)

the main component directory for the pear data

Parameters:

mainComponentDir - the mainComponentDir to set

setTargetDir

public void setTargetDir(String targetDir)

the target directory for the output

Parameters:

targetDir - the targetDir to set