org.objectweb.jorm.util.lib
Class AntJorm

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.MatchingTask
                    |
                    +--org.objectweb.jorm.util.lib.AntJorm

public class AntJorm

extends org.apache.tools.ant.taskdefs.MatchingTask

Inner Class Summary

class	AntJorm.Extension
class	AntJorm.Param
class	AntJorm.Value

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset, useDefaultExcludes

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

description, location, target, taskName, taskType, wrapper

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

project

Constructor Summary

AntJorm()

Method Summary

org.apache.tools.ant.types.Path	createClasspath() Creates a nested classpath element if it is not already defined.
org.apache.tools.ant.types.DTDLocation	createDTD() Create a DTD location record.
AntJorm.Extension	createExtension()
void	execute() execute method of the Ant task
org.apache.tools.ant.types.Path	getClasspath() Gets the classpath to be used for the compilation.
void	setBinderinheritance(java.lang.String s) Deprecated. use the setMappinginheritance method
void	setBindingAbstract(boolean bindingAbstract) It assigns the boolean value which indictes if the generated Binding must be declared abstract.
void	setBindinginheritance(java.lang.String s) It assigns the class name which the generated PBinding classes must extend.
void	setClasspath(org.apache.tools.ant.types.Path cp) Set the classpath to be used for this compilation.
void	setClasspathRef(org.apache.tools.ant.types.Reference r) Adds a reference to a CLASSPATH defined elsewhere.
void	setConf(java.lang.String s) It assigns the jorm configuration file.
void	setJormclasspath(java.lang.String cp) It assigns the classpath where jorm can load .pd files which are needed (the dependecies).
void	setKeepsrc(boolean keepsrc) It assigns a boolean to indicate if the generated .java file must be kept.
void	setLocalPropertiesFile(boolean l) The assigned boolean value indicates if the path to jorm configuration file is relative to a .pd file or absolute.
void	setLogPropFile(java.lang.String logPropFile) It assigns the logging configuration file(monolog file).
void	setMappername(java.lang.String s) It assigns the mapper name which must be used.
void	setMappingfactory(java.lang.String mappingfactory) It assigns the name of the mappingFactory which must be used for the generation.
void	setMappinginheritance(java.lang.String s) It assigns the class name which the generated PBinding classes must extend.
void	setMappingname(java.lang.String s) It assigns the mapping name which must be used.
void	setNoJavac(boolean l) The assigned boolean value indicates if the generated must be compiled.
void	setOutput(java.lang.String s) The ouput name is the directory name where the generated files will be created.
void	setParser(java.lang.String parser) It assigns the paser name.
void	setPdDir(java.io.File d) It assignsthe directory name where the include and exclude clause has been based.
void	setVerbose(boolean verbose) It assigns the verbose mode to the jorm generator.
void	setVerifier(java.lang.String verifier) It assigns the verifier name.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, setDefaultexcludes, setExcludes, setExcludesfile, setIncludes, setIncludesfile, XsetIgnore, XsetItems

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

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

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

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

AntJorm

public AntJorm()

Method Detail

setPdDir

public void setPdDir(java.io.File d)

It assignsthe directory name where the include and exclude clause has been based. (REQUIRED)

createDTD

public org.apache.tools.ant.types.DTDLocation createDTD()

Create a DTD location record. This stores the location of a DTD. The DTD is identified by its public Id. The location may either be a file location or a resource location.

Returns:

the DTD location object to be configured by Ant

setLocalPropertiesFile

public void setLocalPropertiesFile(boolean l)

The assigned boolean value indicates if the path to jorm configuration file is relative to a .pd file or absolute. (true => relative / false => absolute (OPTIONAL: default value is false)

setNoJavac

public void setNoJavac(boolean l)

The assigned boolean value indicates if the generated must be compiled. The compilation is done after the generation of all classes. true=> no compilation / false=> the classes will be compiled This parameter can be override for a class if you use a local jorm configuration file which defines also the property. (OPTIONAL: default value is false)

setJormclasspath

public void setJormclasspath(java.lang.String cp)

It assigns the classpath where jorm can load .pd files which are needed (the dependecies). (OPTIONAL: default value is the PdDir)

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path cp)

Set the classpath to be used for this compilation. The classpath is used to find the jorm classes (to launch the generation) and to compile the generated classes.(REQUIRED)

getClasspath

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

Gets the classpath to be used for the compilation. The classpath is used to find the jorm classes (to launch the generation) and to compile the generated classes.(REQUIRED)

createClasspath

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

Creates a nested classpath element if it is not already defined. The classpath is used to find the jorm classes (to launch the generation) and to compile the generated classes.(REQUIRED)

setClasspathRef

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

Adds a reference to a CLASSPATH defined elsewhere. The classpath is used to find the jorm classes (to launch the generation) and to compile the generated classes.(REQUIRED)

setOutput

public void setOutput(java.lang.String s)

The ouput name is the directory name where the generated files will be created. Futhermmore the classes will be compiled in this directory. (REQUIRED)

Parameters:

s - the string representation of the output directory

setConf

public void setConf(java.lang.String s)

It assigns the jorm configuration file. (REQUIRED)

Parameters:

s - the string representation of the configuration file.

setMappingname

public void setMappingname(java.lang.String s)

It assigns the mapping name which must be used. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. (OPTIONAL default value = "" empty string)

setMappername

public void setMappername(java.lang.String s)

It assigns the mapper name which must be used. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. This parameter must be defined in the task or in the jorm configuration file.

setBindinginheritance

public void setBindinginheritance(java.lang.String s)

It assigns the class name which the generated PBinding classes must extend. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. (OPTIONAL default value is "")

setBinderinheritance

public void setBinderinheritance(java.lang.String s)

Deprecated. use the setMappinginheritance method

It assigns the class name which the generated PBinding classes must extend. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. (OPTIONAL default value is "")

setMappinginheritance

public void setMappinginheritance(java.lang.String s)

It assigns the class name which the generated PBinding classes must extend. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. (OPTIONAL default value is "")

setMappingfactory

public void setMappingfactory(java.lang.String mappingfactory)

It assigns the name of the mappingFactory which must be used for the generation. This parameter can be override for a class if you use a local jorm configuration file which defines also the property.

setVerbose

public void setVerbose(boolean verbose)

It assigns the verbose mode to the jorm generator. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. (OPTIONAL the default value is false)

setKeepsrc

public void setKeepsrc(boolean keepsrc)

It assigns a boolean to indicate if the generated .java file must be kept. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. (OPTIONAL the default value is true)

setParser

public void setParser(java.lang.String parser)

It assigns the paser name. This parameter must be defined in the task or in the jorm configuration file. This parameter can be override for a class if you use a local jorm configuration file which defines also the property.

setVerifier

public void setVerifier(java.lang.String verifier)

It assigns the verifier name. This parameter must be defined in the task or in the jorm configuration file. This parameter can be override for a class if you use a local jorm configuration file which defines also the property.

setBindingAbstract

public void setBindingAbstract(boolean bindingAbstract)

It assigns the boolean value which indictes if the generated Binding must be declared abstract. This parameter can be override for a class if you use a local jorm configuration file which defines also the property. This parameter must be defined in the task or in the jorm configuration file.

setLogPropFile

public void setLogPropFile(java.lang.String logPropFile)

It assigns the logging configuration file(monolog file). (REQUIRED)

createExtension

public AntJorm.Extension createExtension()

execute

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

execute method of the Ant task

Overrides:

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