org.andromda.maven.plugin.andromdapp.hibernate

Class HibernateSchemaManagement

java.lang.Object

org.andromda.maven.plugin.andromdapp.hibernate.HibernateSchemaManagement

All Implemented Interfaces:

SchemaManagement

Direct Known Subclasses:

HibernateCreateSchema, HibernateDropSchema, HibernateUpdateSchema, HibernateValidateSchema

public abstract class HibernateSchemaManagement
extends Object
implements SchemaManagement

A Hibernate management object.

Author:

Chad Brandon

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	HIBERNATE_2_PACKAGE The Hibernate 2 schema export class name.
protected static String	HIBERNATE_3_PACKAGE The Hibernate 3 schema export class name.
protected static Logger	logger getLogger(HibernateSchemaManagement.class)

Constructor Summary

Constructors

Constructor and Description
HibernateSchemaManagement()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addArguments(Map options, List<String> arguments) Adds any arguments required by the specialized class.
String	execute(Connection connection, Map options) Executes the schema related task and returns the resulting SQL script (if applicable).
protected Class	getExecutionClass() Retrieves the class that performs the execution work.
protected abstract String	getExecutionClassName() Returns the name of the class that performs the execution.
protected abstract String	getExecutionOuputPath(Map options) Returns the path of the execution output file.
protected List<String>	getMappingFilesList(String extension, String baseDirectory) Retrieves all mapping files having the given extension existing in the baseDirectory or any of its sub directories.
protected String	getOutputPath() Gets the path to which output should be written.
protected String	getProperty(Map properties, String name) Attempts to retrieve the given property with the given name.
protected String	getRequiredProperty(Map properties, String name) Attempts to retrieve the given property with the given name.
protected String	getVersion() Returns the current Hibernate version this management object is targetting.
void	setOutputPath(String outputPath) Sets the path to which the output should be written.
void	setVersion(String version) Sets the version of Hibernate to target.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static Logger logger

getLogger(HibernateSchemaManagement.class)

HIBERNATE_2_PACKAGE

protected static final String HIBERNATE_2_PACKAGE

The Hibernate 2 schema export class name.

See Also:

Constant Field Values

HIBERNATE_3_PACKAGE

protected static final String HIBERNATE_3_PACKAGE

The Hibernate 3 schema export class name.

See Also:

Constant Field Values

Constructor Detail

HibernateSchemaManagement

public HibernateSchemaManagement()

Method Detail

setVersion

public void setVersion(String version)

Sets the version of Hibernate to target.

Parameters:

version - the version of Hibernate to target.

getExecutionClass

protected Class getExecutionClass()

Retrieves the class that performs the execution work.

Returns:

the Hibernate class that performs the work.

getVersion

protected String getVersion()

Returns the current Hibernate version this management object is targetting.

Returns:

the Hibernate version (2 or 3).

setOutputPath

public void setOutputPath(String outputPath)

Sets the path to which the output should be written.

Parameters:

outputPath -

getProperty

protected String getProperty(Map properties,
                 String name)

Attempts to retrieve the given property with the given name.

Parameters:

properties - the properties from which to retrieve the property.

name - the name of the property to retrieve.

Returns:

the value of the property.

getRequiredProperty

protected String getRequiredProperty(Map properties,
                         String name)

Attempts to retrieve the given property with the given name. If the property isn't found an exception is thrown.

Parameters:

properties - the properties from which to retrieve the property.

name - the name of the property to retrieve.

Returns:

the value of the property.

getOutputPath

protected String getOutputPath()

Gets the path to which output should be written.

Returns:

the output path.

getExecutionClassName

protected abstract String getExecutionClassName()

Returns the name of the class that performs the execution.

Returns:

the execution class.

execute

public String execute(Connection connection,
             Map options)
               throws Exception

Description copied from interface: SchemaManagement

Executes the schema related task and returns the resulting SQL script (if applicable).

Specified by:

execute in interface SchemaManagement

Parameters:

connection - the connection if required to execute the task.

options - the options used during execution.

Returns:

SQL script

Throws:

Exception

See Also:

SchemaManagement.execute(java.sql.Connection, java.util.Map)

getExecutionOuputPath

protected abstract String getExecutionOuputPath(Map options)

Returns the path of the execution output file.

Parameters:

options - the options from which to retrieve properties.

Returns:

the output path.

addArguments

protected abstract void addArguments(Map options,
                List<String> arguments)
                              throws Exception

Adds any arguments required by the specialized class.

Parameters:

options - any options from which to retrieve argument values.

arguments - the list of arguments to add.

Throws:

Exception

getMappingFilesList

protected List<String> getMappingFilesList(String extension,
                               String baseDirectory)

Retrieves all mapping files having the given extension existing in the baseDirectory or any of its sub directories.

Parameters:

extension - the mapping file extension

baseDirectory - the directory from which to perform the search.

Returns:

the list of mapping files