Package org.apache.openjpa.jdbc.ant

Class SchemaToolTask

  • All Implemented Interfaces:
    java.lang.Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer
    public class SchemaToolTask
extends AbstractTask
    Executes the SchemaTool on the specified XML schema definition files. This task can take the following arguments:
    • action
    • ignoreErrors
    • dropTables
    • dropSequences
    • openjpaTables
    • primaryKeys
    • foreignKeys
    • indexes
    • sequences
    • record
    • file
    Of these arguments, only action is required.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SchemaToolTask.Action  

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String file  
      protected SchemaTool.Flags flags  

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

        fileset

      • 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

      Constructors 
      Constructor Description
      SchemaToolTask()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void executeOn​(java.lang.String[] files)
      Perform the task action on the given files.
      protected ConfigurationImpl newConfiguration()
      Implement this method to return a configuration object for the product in use.
      void setAction​(SchemaToolTask.Action act)
      Set the enumerated SchemaTool action type.
      void setDropSequences​(boolean dropSequences)
      Set whether the SchemaTool should drop sequences.
      void setDropTables​(boolean dropTables)
      Set whether the SchemaTool should drop tables.
      void setFile​(java.lang.String file)
      Set the output file we want the SchemaTool to write to.
      void setForeignKeys​(boolean fks)
      Set whether to generate foreign key information.
      void setIgnoreErrors​(boolean ignoreErrors)
      Set whether we want the SchemaTool to ignore SQL errors.
      void setIndexes​(boolean idxs)
      Set whether to generate index information.
      void setOpenJPATables​(boolean openjpaTables)
      Set whether to drop or reflect on OpenJPA tables.
      void setPrimaryKeys​(boolean pks)
      Set whether to generate primary key information.
      void setRecord​(boolean record)
      Set whether the SchemaTool should record to the schema factory.
      void setSequences​(boolean sequences)
      Set whether the SchemaTool should manipulate sequences.

      • 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

        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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SchemaToolTask

        public SchemaToolTask()

    • Method Detail

      • setAction

        public void setAction​(SchemaToolTask.Action act)
        Set the enumerated SchemaTool action type.

      • setIgnoreErrors

        public void setIgnoreErrors​(boolean ignoreErrors)
        Set whether we want the SchemaTool to ignore SQL errors.

      • setDropTables

        public void setDropTables​(boolean dropTables)
        Set whether the SchemaTool should drop tables.

      • setOpenJPATables

        public void setOpenJPATables​(boolean openjpaTables)
        Set whether to drop or reflect on OpenJPA tables.

      • setDropSequences

        public void setDropSequences​(boolean dropSequences)
        Set whether the SchemaTool should drop sequences.

      • setSequences

        public void setSequences​(boolean sequences)
        Set whether the SchemaTool should manipulate sequences.

      • setPrimaryKeys

        public void setPrimaryKeys​(boolean pks)
        Set whether to generate primary key information.

      • setForeignKeys

        public void setForeignKeys​(boolean fks)
        Set whether to generate foreign key information.

      • setIndexes

        public void setIndexes​(boolean idxs)
        Set whether to generate index information.

      • setRecord

        public void setRecord​(boolean record)
        Set whether the SchemaTool should record to the schema factory.

      • setFile

        public void setFile​(java.lang.String file)
        Set the output file we want the SchemaTool to write to.

      • executeOn

        protected void executeOn​(java.lang.String[] files)
                  throws java.lang.Exception
        Description copied from class: AbstractTask
        Perform the task action on the given files.
        Specified by:
        executeOn in class AbstractTask
        Throws:
        java.lang.Exception