sk.vracon.sqlcomments.maven

Class AbstractSqlCommentsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

sk.vracon.sqlcomments.maven.AbstractSqlCommentsMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DomainMojo, GenerateMojo

public abstract class AbstractSqlCommentsMojo
extends org.apache.maven.plugin.AbstractMojo

Abstract MOJO implementing generating result and configuration classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	compileWithTestClasses Indicates whether to use standard or test class path for compilation of generated classes.
protected Map<String,DBColumnMetadata>	databaseColumns Database metadata.
protected String	databaseDialect Database dialect class to use.
protected String	databaseUrl Database URL.
protected String	dbPassword Database credentials - password.
protected String	dbUserName Database credentials - username.
protected DatabaseDialect	dialect Database dialect used to map SQL data types to java classes.
protected boolean	hasErrors Internal state indicates if execution had errors and should be stopped.
protected String	jdbcDriverClass JDBC driver class name.
protected String[]	mappingFiles Table metadata configuration files to use.
protected File	outputDirectory The output directory where to generate files and java classes.
protected org.apache.maven.project.MavenProject	project The current Maven project.
static String	TABLE_PROP_CLASS_NAME Table property name - className.
static String	TABLE_PROP_COLUMN_JAVA_CLASS Column property suffix - .javaClass.
static String	TABLE_PROP_COLUMN_MAPPER Column property suffix - .mapper.
static String	TABLE_PROP_INTERFACES Table property name - className.
static String	TABLE_PROP_PK_GENERATOR Table property name - pkGenerator.
protected Map<String,Properties>	tableProperties Parsed table properties.
protected Map<String,String>	tables Table meta data and a list of tables to include.
protected TemplateProcessor	templateProcessor Freemarker template processor.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractSqlCommentsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected void	extractDatabaseMetaData(DatabaseMetaData databaseMetaData) Extract appropriate metadata from database.
protected void	loadDatabaseMetadata() Loads database metadata.
protected DBColumnMetadata	mapDBColumnDefinition(ResultSet columnsRS) Maps column metadata into DBColumnMetadata.
protected void	processFile(File sourceDirectory, String resource) Processes SQL file and generates result class, result mapper class and statement configuration class.
protected void	processFile(File sourceDirectory, String resource, Map<String,Object> extraTemplateModel) Processes SQL file and generates result class, result mapper class and statement configuration class.

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

TABLE_PROP_CLASS_NAME

public static final String TABLE_PROP_CLASS_NAME

Table property name - className.

See Also:

Constant Field Values

TABLE_PROP_INTERFACES

public static final String TABLE_PROP_INTERFACES

Table property name - className.

See Also:

Constant Field Values

TABLE_PROP_PK_GENERATOR

public static final String TABLE_PROP_PK_GENERATOR

Table property name - pkGenerator.

See Also:

Constant Field Values

TABLE_PROP_COLUMN_JAVA_CLASS

public static final String TABLE_PROP_COLUMN_JAVA_CLASS

Column property suffix - .javaClass.

See Also:

Constant Field Values

TABLE_PROP_COLUMN_MAPPER

public static final String TABLE_PROP_COLUMN_MAPPER

Column property suffix - .mapper.

See Also:

Constant Field Values

outputDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/sqlcomments")
protected File outputDirectory

The output directory where to generate files and java classes. The default value is ${project.build.directory}/generated-sources/sqlcomments.

databaseDialect

@Parameter(required=false)
protected String databaseDialect

Database dialect class to use. The default value is DefaultDatabaseDialect.

jdbcDriverClass

@Parameter(required=true)
protected String jdbcDriverClass

JDBC driver class name. Class must be included in plugin dependendcies.

databaseUrl

@Parameter(required=true)
protected String databaseUrl

Database URL.

dbUserName

@Parameter(required=false)
protected String dbUserName

Database credentials - username.

dbPassword

@Parameter(required=false)
protected String dbPassword

Database credentials - password.

compileWithTestClasses

@Parameter(required=false)
protected boolean compileWithTestClasses

Indicates whether to use standard or test class path for compilation of generated classes. The default value is false - using standard class path.

tables

@Parameter(required=false)
protected Map<String,String> tables

Table meta data and a list of tables to include.

Map consists of pairs <table name> - <table properties>. Properties are in form Properties.

Currently supported properties:

• pkGenerator - sequence call or other statement to use in generated insert statements instead of PK column
• className - canonical domain class name used instead of generated name
• [column name].javaClass - java class of a column to which result object should be mapped
• [column name].mapper - class name of a value mapper used for DB object to java transformation. Mapper class must implement IColumnMapper.

mappingFiles

@Parameter(required=false)
protected String[] mappingFiles

Table metadata configuration files to use.

Can contain ant-style wildcards and double wildcards.

Mapping file is a simple XML with root element {code}<sqlcomments>{/code}. Content of root element is the same as parameter tables in pom.xml. Elements are table names and content represents table metadata in Properties format. E.g.

 
     
     
         country.javaClass=sk.vracon.sqlcomments.maven.ExampleEnum
         country.maper=sk.vracon.sqlcomments.core.mappers.EnumMapper
     
     
 
 

project

@Parameter(property="project",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

The current Maven project.

hasErrors

protected boolean hasErrors

Internal state indicates if execution had errors and should be stopped.

databaseColumns

protected Map<String,DBColumnMetadata> databaseColumns

Database metadata. Informations about column size and type. Key is a composition of . .

templateProcessor

protected TemplateProcessor templateProcessor

Freemarker template processor.

dialect

protected DatabaseDialect dialect

Database dialect used to map SQL data types to java classes.

tableProperties

protected Map<String,Properties> tableProperties

Parsed table properties.

See Also:

tables

Constructor Detail

AbstractSqlCommentsMojo

public AbstractSqlCommentsMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

processFile

protected void processFile(File sourceDirectory,
               String resource)

Processes SQL file and generates result class, result mapper class and statement configuration class.

Parameters:

sourceDirectory - source directory

resource - SQL file

processFile

protected void processFile(File sourceDirectory,
               String resource,
               Map<String,Object> extraTemplateModel)

Processes SQL file and generates result class, result mapper class and statement configuration class.

Parameters:

sourceDirectory - source directory

resource - SQL file

loadDatabaseMetadata

protected void loadDatabaseMetadata()
                             throws org.apache.maven.plugin.MojoExecutionException

Loads database metadata.

This method just opens connection. Metadata are processed by extractDatabaseMetaData(DatabaseMetaData).

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

#extractDatabaseMetaData(DatabaseMetaData)}

extractDatabaseMetaData

protected void extractDatabaseMetaData(DatabaseMetaData databaseMetaData)
                                throws SQLException

Extract appropriate metadata from database.

Parameters:

databaseMetaData - database metadata

Throws:

SQLException

mapDBColumnDefinition

protected DBColumnMetadata mapDBColumnDefinition(ResultSet columnsRS)
                                          throws SQLException

Maps column metadata into DBColumnMetadata.

Parameters:

columnsRS -

Returns:

Throws:

SQLException