DODS 7.1 API

org.enhydra.ant.taskdefs
Class DODS_XMLBuilder

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.apache.tools.ant.taskdefs.MatchingTask
              extended by org.apache.tools.ant.taskdefs.Javac
                  extended by org.enhydra.ant.taskdefs.DODS_XMLBuilder
All Implemented Interfaces:
org.apache.tools.ant.types.selectors.SelectorContainer

public class DODS_XMLBuilder
extends org.apache.tools.ant.taskdefs.Javac

Author:
Sinisa Milosevic Invoke DODS to generate a set of java classes from a doml file
The files will only be regenerated/compiled if the date on the doml file is newer than at least one of the generated files
This taskdef extends Ant's task; refer to that documentation for parameters that affect compilation.
Typically made visible to an Ant build file with the following declaration:
  <taskdef name="dods" classname="org.enhydra.ant.taskdefs.Dods"/>
Parameters

 doml       - The doml input file describing data object mapping. Required = Yes
 outdir     - Target for generated classes, expressed as a directory path. Required = Yes
 tablesonly - If this attribute is set to true dods tast generate only tables.xml. Required = No
 force      - Force DODS to always be regenerated source files. Required = No

Examples
 <dods doml="${basedir}/discRack.doml"
        outdir="${basedir}/src"/>

Nested Class Summary
static class DODS_XMLBuilder.BooleanAttribute
           
 
Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Javac
org.apache.tools.ant.taskdefs.Javac.ImplementationSpecificArgument
 
Field Summary
protected  java.lang.String configDir
           
protected  java.lang.String database
           
protected  java.io.File domlFile
           
protected  boolean forceBuild
           
protected  java.io.File sourceoutDir
           
protected  boolean tablesOnly
           
 
Fields inherited from class org.apache.tools.ant.taskdefs.Javac
compileList, failOnError, listFiles
 
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
fileset
 
Fields inherited from class org.apache.tools.ant.Task
description, location, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
DODS_XMLBuilder()
           
 
Method Summary
 void execute()
          Simply invoke DODS Generator, and then compile the generated files
 java.lang.String getConfigDir()
          Returns curent configurationDir (folder with dodsConf.xml file).
 void setConfigDir(java.lang.String string)
           
 void setDatabase(java.lang.String database)
          Set the database vendor for creating sql
 void setDoml(java.io.File domlFile)
          Sets the doml descriptor file.
 void setForce(java.lang.String force)
          Force DODS to always be regenerated source files
 void setOutdir(java.io.File sourceout)
          The destination directory into which the generated sources are written
 void setTablesonly(boolean isTablesOnly)
          Sets tablesOnly property.
 
Methods inherited from class org.apache.tools.ant.taskdefs.Javac
checkParameters, compile, createBootclasspath, createClasspath, createCompilerArg, createExtdirs, createSourcepath, createSrc, getBootclasspath, getClasspath, getCompiler, getCompilerVersion, getCurrentCompilerArgs, getDebug, getDebugLevel, getDepend, getDeprecation, getDestdir, getEncoding, getExecutable, getExtdirs, getFailonerror, getFileList, getIncludeantruntime, getIncludejavaruntime, getJavacExecutable, getListfiles, getMemoryInitialSize, getMemoryMaximumSize, getNowarn, getOptimize, getSource, getSourcepath, getSrcdir, getSystemJavac, getTarget, getTempdir, getVerbose, isForkedJavac, isJdkCompiler, recreateSrc, resetFileLists, scanDir, setBootclasspath, setBootClasspathRef, setClasspath, setClasspathRef, setCompiler, setDebug, setDebugLevel, setDepend, setDeprecation, setDestdir, setEncoding, setExecutable, setExtdirs, setFailonerror, setFork, setIncludeantruntime, setIncludejavaruntime, setListfiles, setMemoryInitialSize, setMemoryMaximumSize, setNowarn, setOptimize, setProceed, setSource, setSourcepath, setSourcepathRef, setSrcdir, setTarget, setTempdir, setVerbose
 
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

domlFile

protected java.io.File domlFile

sourceoutDir

protected java.io.File sourceoutDir

database

protected java.lang.String database

forceBuild

protected boolean forceBuild

tablesOnly

protected boolean tablesOnly

configDir

protected java.lang.String configDir
Constructor Detail

DODS_XMLBuilder

public DODS_XMLBuilder()
Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Simply invoke DODS Generator, and then compile the generated files

Overrides:
execute in class org.apache.tools.ant.taskdefs.Javac
Throws:
org.apache.tools.ant.BuildException

setDoml

public void setDoml(java.io.File domlFile)
Sets the doml descriptor file.

Parameters:
domlFile - - The doml input file describing data object mapping

setOutdir

public void setOutdir(java.io.File sourceout)
The destination directory into which the generated sources are written

Parameters:
sourceout - - Target for generated classes, expressed as a directory path

setDatabase

public void setDatabase(java.lang.String database)
Set the database vendor for creating sql

Parameters:
database - database vendor for creating sql

setTablesonly

public void setTablesonly(boolean isTablesOnly)
Sets tablesOnly property.

Parameters:
isTablesOnly - - new tablesOnly value.

setForce

public void setForce(java.lang.String force)
Force DODS to always be regenerated source files

Parameters:
force - - Set to "true" or "false"

getConfigDir

public java.lang.String getConfigDir()
Returns curent configurationDir (folder with dodsConf.xml file).

Returns:
Curent configurationDir.

setConfigDir

public void setConfigDir(java.lang.String string)
Parameters:
string -

DODS 7.1 API