org.restsql.tools

Interface ResourceDefinitionGenerator

All Known Implementing Classes:

AbstractResourceDefinitionGenerator, MySqlResourceDefinitionGenerator, PostgreSqlResourceDefinitionGenerator

public interface ResourceDefinitionGenerator

Creates resource definition files, one per table found in the specified database, to the specified subdirectory.

Author:

Mark Sawers

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResourceDefinitionGenerator.GenerationException Represents generation exception.

Method Summary

Methods

Modifier and Type	Method and Description
int	generate(String relativeSubDir, String databaseName, String exclusionPattern) Creates resource definition files, one per table in the provided database.

Method Detail

generate

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

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

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