org.restsql.tools.impl

Class AbstractResourceDefinitionGenerator

java.lang.Object

org.restsql.tools.impl.AbstractResourceDefinitionGenerator

All Implemented Interfaces:

ResourceDefinitionGenerator

Direct Known Subclasses:

MySqlResourceDefinitionGenerator, PostgreSqlResourceDefinitionGenerator

public abstract class AbstractResourceDefinitionGenerator
extends Object
implements ResourceDefinitionGenerator

Base implemenation for generator.

Author:

Mark Sawers

Nested Class Summary

Nested classes/interfaces inherited from interface org.restsql.tools.ResourceDefinitionGenerator

ResourceDefinitionGenerator.GenerationException

Constructor Summary

Constructors

Constructor and Description
AbstractResourceDefinitionGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	createDefs(File subDirObj, String databaseName, String exclusionPattern) Creates resource definitions.
protected File	createSubDir(String relativeSubDir, String sqlResourcesDir) Creates sub directory if it does not exist.
int	generate(String relativeSubDir, String databaseName, String exclusionPattern) Creates resource definition files, one per table in the provided database.
protected abstract String	getColumnsQuery() Hook method for implementation by db-specific classes.
protected String	getTableExclusionQueryClause() Returns query clause for a table name exclusion pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResourceDefinitionGenerator

public AbstractResourceDefinitionGenerator()

Method Detail

generate

public int generate(String relativeSubDir,
           String databaseName,
           String exclusionPattern)
             throws ResourceDefinitionGenerator.GenerationException

Description copied from interface: ResourceDefinitionGenerator

Creates resource definition files, one per table in the provided database.

Specified by:

generate in interface ResourceDefinitionGenerator

Parameters:

relativeSubDir - directory path relative to sql resources directory to create

databaseName - database name

exclusionPattern - table name pattern to exclude

Returns:

number of definitions created

Throws:

ResourceDefinitionGenerator.GenerationException - if a database access or file write error occurs

createDefs

protected int createDefs(File subDirObj,
             String databaseName,
             String exclusionPattern)
                  throws ResourceDefinitionGenerator.GenerationException

Creates resource definitions.

Parameters:

subDirObj - subdir file object

databaseName - database name

Returns:

number of definitions created

Throws:

GenerationException - if a database access or file write error occurs

ResourceDefinitionGenerator.GenerationException

getColumnsQuery

protected abstract String getColumnsQuery()

Hook method for implementation by db-specific classes. Must be preparable statement with single query param of the database name. Columns returned must be column name and then table name.

getTableExclusionQueryClause

protected String getTableExclusionQueryClause()

Returns query clause for a table name exclusion pattern.

createSubDir

protected File createSubDir(String relativeSubDir,
                String sqlResourcesDir)
                     throws ResourceDefinitionGenerator.GenerationException

Creates sub directory if it does not exist.

Parameters:

relativeSubDir - directory path relative to sql resources directory to create

sqlResourcesDir - absolute sql resources directory

Throws:

GenerationException - if subdir could not be created, or it exists and is not writable or empty

ResourceDefinitionGenerator.GenerationException