Top Description Fields Constructors Methods

org.hibernate.tool.hbm2ddl

public Class SchemaUpdateTask

Class Inheritance

extends MatchingTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.hibernate.tool.hbm2ddl.SchemaUpdateTask

Imports

java.io.File, .FileInputStream, .FileNotFoundException, .IOException, java.util.LinkedList, .List, .Properties, org.hibernate.HibernateException, org.hibernate.boot.MetadataBuilder, .MetadataSources, org.hibernate.boot.model.naming.ImplicitNamingStrategy, .PhysicalNamingStrategy, org.hibernate.boot.registry.StandardServiceRegistry, .StandardServiceRegistryBuilder, org.hibernate.boot.registry.classloading.spi.ClassLoaderService, org.hibernate.boot.spi.MetadataImplementor, org.hibernate.internal.log.DeprecationLogger, org.hibernate.internal.util.collections.ArrayHelper, org.apache.tools.ant.BuildException, .DirectoryScanner, .Project, org.apache.tools.ant.taskdefs.MatchingTask, org.apache.tools.ant.types.FileSet

An Ant task for SchemaUpdate.

<taskdef name="schemaupdate"
    classname="org.hibernate.tool.hbm2ddl.SchemaUpdateTask"
    classpathref="class.path"/>

<schemaupdate
    properties="${build.classes.dir}/hibernate.properties"
    quiet="no"
    <fileset dir="${build.classes.dir}">
        <include name="*.hbm.xml"/>
    </fileset>
</schemaupdate>

Author: Rong C Ou, Gavin King
See Also: SchemaUpdate

Field Summary

Modifier and Type	Field and Description
private File	configurationFile
private String	delimiter
private List<FileSet>	fileSets
private boolean	haltOnError
private String	implicitNamingStrategy
private File	outputFile
private String	physicalNamingStrategy
private File	propertiesFile
private boolean	quiet
private boolean	text

Inherited from org.apache.tools.ant.taskdefs.MatchingTask:: fileset

Constructor Summary

Access	Constructor and Description
public	SchemaUpdateTask()

Method Summary

Modifier and Type	Method and Description
public void	addFileset(FileSet fileSet)
private String[]	collectFiles()
private void	configure(StandardServiceRegistryBuilder registryBuilder)
private void	configure(MetadataSources metadataSources)
private void	configure(MetadataBuilder metadataBuilder, StandardServiceRegistry serviceRegistry)
public void	execute() Overrides org.apache.tools.ant.Task.execute. Execute the task
public String	getDelimiter()
public File	getOutputFile()
public boolean	isHaltOnError()
public void	setConfig(File the file name configurationFile) Set a `cfg.xml` file
public void	setDelimiter(String delimiter)
public void	setHaltOnError(boolean haltOnError)
public void	setImplicitNamingStrategy(String implicitNamingStrategy)
public void	setNamingStrategy(String namingStrategy)
public void	setOutputFile(File outputFile)
public void	setPhysicalNamingStrategy(String physicalNamingStrategy)
public void	setProperties(File the properties file name propertiesFile) Set a properties file
public void	setQuiet(boolean true to enable quiet mode quiet) Enable "quiet" mode.
public void	setText(boolean true to enable text-only mode text) Enable "text-only" mode.

Field Detail

configurationFile	back to summary
private File configurationFile

delimiter	back to summary
private String delimiter

fileSets	back to summary
private List<FileSet> fileSets

haltOnError	back to summary
private boolean haltOnError

implicitNamingStrategy	back to summary
private String implicitNamingStrategy

outputFile	back to summary
private File outputFile

physicalNamingStrategy	back to summary
private String physicalNamingStrategy

propertiesFile	back to summary
private File propertiesFile

quiet	back to summary
private boolean quiet

text	back to summary
private boolean text

Constructor Detail

SchemaUpdateTask	back to summary
public SchemaUpdateTask()

Method Detail

addFileset	back to summary
public void addFileset(FileSet fileSet) Annotations @SuppressWarnings:UnusedDeclaration

collectFiles	back to summary
private String[] collectFiles()

configure	back to summary
private void configure(StandardServiceRegistryBuilder registryBuilder) throws IOException

configure	back to summary
private void configure(MetadataSources metadataSources)

configure	back to summary
private void configure(MetadataBuilder metadataBuilder, StandardServiceRegistry serviceRegistry) Annotations @SuppressWarnings:deprecation

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Execute the task

Annotations

@Override

Exceptions

BuildException:

Doc from org.apache.tools.ant.Task.execute.

if something goes wrong with the build.

getDelimiter	back to summary
public String getDelimiter() Annotations @SuppressWarnings:UnusedDeclaration

getOutputFile	back to summary
public File getOutputFile() Annotations @SuppressWarnings:UnusedDeclaration

isHaltOnError	back to summary
public boolean isHaltOnError() Annotations @SuppressWarnings:UnusedDeclaration

setConfig back to summary

public void setConfig(File configurationFile)

Set a cfg.xml file

Parameters

configurationFile:File: the file name

Annotations

@SuppressWarnings:UnusedDeclaration

setDelimiter	back to summary
public void setDelimiter(String delimiter) Annotations @SuppressWarnings:UnusedDeclaration

setHaltOnError	back to summary
public void setHaltOnError(boolean haltOnError) Annotations @SuppressWarnings:UnusedDeclaration

setImplicitNamingStrategy	back to summary
public void setImplicitNamingStrategy(String implicitNamingStrategy) Annotations @SuppressWarnings:UnusedDeclaration

setNamingStrategy	back to summary
public void setNamingStrategy(String namingStrategy) Annotations @SuppressWarnings:UnusedDeclaration

setOutputFile	back to summary
public void setOutputFile(File outputFile) Annotations @SuppressWarnings:UnusedDeclaration

setPhysicalNamingStrategy	back to summary
public void setPhysicalNamingStrategy(String physicalNamingStrategy) Annotations @SuppressWarnings:UnusedDeclaration

setProperties

back to summary

public void setProperties(File propertiesFile)

Set a properties file

Parameters

propertiesFile:File: the properties file name

Annotations

@SuppressWarnings:UnusedDeclaration

setQuiet

back to summary

public void setQuiet(boolean quiet)

Enable "quiet" mode. The schema will not be written to standard out.

Parameters

quiet:boolean: true to enable quiet mode

Annotations

@SuppressWarnings:UnusedDeclaration

setText

back to summary

public void setText(boolean text)

Enable "text-only" mode. The schema will not be updated in the database.

Parameters

text:boolean: true to enable text-only mode

Annotations

@SuppressWarnings:UnusedDeclaration