org.apache.torque.mojo
Class IdTableInitSqlMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.torque.mojo.TexenTaskMojo
          org.apache.torque.mojo.DataModelTaskMojo
              org.apache.torque.mojo.SqlMojoBase
                  org.apache.torque.mojo.IdTableInitSqlMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class IdTableInitSqlMojo
extends SqlMojoBase

Generates SQL for populating the id table in the database.

Author:

Raphael Pieroni (rafale_at_codehaus.org), Thomas Fischer, Marc Kannegiesser

Field Summary

static String	INITIALID_CONTEXT_PROPERTY
static String	INITIALIDSTEP_CONTEXT_PROPERTY
static String	INITIALIDVALUE_CONTEXT_PROPERTY

Fields inherited from class org.apache.torque.mojo.DataModelTaskMojo

TARGET_DATABASE_CONTEXT_PROPERTY

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

IdTableInitSqlMojo()
Creates a new IdTableInitSqlMojo object.

Method Summary

protected String	getControlTemplate() Returns the path to the control template.
String	getInitialID() Returns the initial id of the idtable
String	getInitialIDStep() Returns the initial id step of the idtables
String	getInitialIDValue() Returns the initial id value of the idtables
protected org.apache.commons.configuration.PropertiesConfiguration	getMojoContextProperties() Returns the context properties for the Texen task.
void	setInitialID(String initialID) Sets the initial id of the idtables
void	setInitialIDStep(String initialIDStep) Sets the initial id step of the idtables
void	setInitialIDValue(String initialIDValue) Sets the initial id value of the idtables

Methods inherited from class org.apache.torque.mojo.SqlMojoBase

configureTask, getSuffix, setSuffix

Methods inherited from class org.apache.torque.mojo.DataModelTaskMojo

execute, getReportFile, getSchemaDir, getSchemaExcludes, getSchemaIncludes, getSqlDbMap, getTargetDatabase, getTargetPackage, isRunOnlyOnSchemaChange, schemaChanged, setReportFile, setRunOnlyOnSchemaChange, setSchemaDir, setSchemaExcludes, setSchemaIncludes, setSqlDbMap, setTargetDatabase, setTargetPackage

Methods inherited from class org.apache.torque.mojo.TexenTaskMojo

generateContextProperties, getAntProject, getContextPropertiesPath, getGeneratorTask, getOutputDir, getProject, getTemplatePath, getUseClasspath, getUserContextProperties, setContextPropertiesPath, setGeneratorTask, setOutputDir, setProject, setTemplatePath, setUseClasspath, setUserContextProperties

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

INITIALID_CONTEXT_PROPERTY

public static final String INITIALID_CONTEXT_PROPERTY

See Also:

Constant Field Values

INITIALIDVALUE_CONTEXT_PROPERTY

public static final String INITIALIDVALUE_CONTEXT_PROPERTY

See Also:

Constant Field Values

INITIALIDSTEP_CONTEXT_PROPERTY

public static final String INITIALIDSTEP_CONTEXT_PROPERTY

See Also:

Constant Field Values

Constructor Detail

IdTableInitSqlMojo

public IdTableInitSqlMojo()

Creates a new IdTableInitSqlMojo object.

Method Detail

setInitialID

public void setInitialID(String initialID)

Sets the initial id of the idtables

Parameters:

initialID - The initial of the idtables

getInitialID

public String getInitialID()

Returns the initial id of the idtable

Returns:

initialID The initial ID of the idtables

setInitialIDValue

public void setInitialIDValue(String initialIDValue)

Sets the initial id value of the idtables

Parameters:

initialIDValue - The initial id value of the tables

getInitialIDValue

public String getInitialIDValue()

Returns the initial id value of the idtables

Returns:

initialIDValue the initial id value of the idtables

setInitialIDStep

public void setInitialIDStep(String initialIDStep)

Sets the initial id step of the idtables

Parameters:

initialIDStep - The initial id step of the tables

getInitialIDStep

public String getInitialIDStep()

Returns the initial id step of the idtables

Returns:

initialIDStep the initial id step of the idtables

getMojoContextProperties

protected org.apache.commons.configuration.PropertiesConfiguration getMojoContextProperties()

Returns the context properties for the Texen task.

Overrides:

getMojoContextProperties in class SqlMojoBase

Returns:

The PropertiesConfiguration containing all context properties, not null.

getControlTemplate

protected String getControlTemplate()

Returns the path to the control template.

Overrides:

getControlTemplate in class SqlMojoBase

Returns:

"sql/id-table/Control.vm"