org.apache.ws.jaxme.sqls

Interface SQLGenerator

Known Subinterfaces:
DB2SQLGenerator, HsqlDbSQLGenerator, OraSQLGenerator
Known Implementing Classes:
DB2SQLGeneratorImpl, HsqlDbSQLGeneratorImpl, OraSQLGeneratorImpl, SQLGeneratorImpl

public interface SQLGenerator

An SQL generator.
Author:
Jochen Wiedmann

Method Summary

String
getConstraint(Constraint pConstraint)
Generates the WHERE clause of a SELECT, UPDATE, or DELETE statement.
Collection
getCreate(ForeignKey pKey)
Generates a CREATE FOREIGN KEY statement.
Collection
getCreate(Index pIndex)
Generates a CREATE INDEX statement.
Collection
getCreate(Schema pSchema)
Generates a CREATE SCHEMA statement.
Collection
getCreate(Schema pSchema, boolean pAll)
Generates CREATE statements for the schema.
Collection
getCreate(Table pTable)
Generates a CREATE TABLE statement.
Collection
getCreate(Table pTable, boolean pAll)
Generates CREATE statements for the table.
Collection
getDrop(ForeignKey pKey)
Generates a DROP FOEIGN KEY statement.
Collection
getDrop(Index pIndex)
Generates a DROP INDEX statement.
Collection
getDrop(Schema pSchema)
Generates a DROP SCHEMA statement.
Collection
getDrop(Schema pSchema, boolean pAll)
Generates DROP statements for the schema.
Collection
getDrop(Table pTable)
Generates a DROP TABLE statement.
Collection
getDrop(Table pTable, boolean pAll)
Generates DROP statements for the table.
String
getLineTerminator()
Returns the line terminator.
String
getQuery(Statement pStatement)
Generates an INSERT, UPDATE, DELETE or SELECT statement.
String
getStatementTerminator()
Returns the statement terminator.
String
getWhereClause(SelectStatement pQuery)
Returns the WHERE ...
void
setLineTerminator(String pTerminator)
Sets the line terminator.
void
setStatementTerminator(String pTerminator)
Sets the statement terminator.

Method Details

getConstraint

public String getConstraint(Constraint pConstraint)
Generates the WHERE clause of a SELECT, UPDATE, or DELETE statement.

getCreate

public Collection getCreate(ForeignKey pKey)
Generates a CREATE FOREIGN KEY statement.

getCreate

public Collection getCreate(Index pIndex)
Generates a CREATE INDEX statement.

getCreate

public Collection getCreate(Schema pSchema)
Generates a CREATE SCHEMA statement. Doesn't create CREATE TABLE or similar statements.

getCreate

public Collection getCreate(Schema pSchema,
                            boolean pAll)
Generates CREATE statements for the schema.
Parameters:
pAll - If this parameter is set to true, then the method is equivalent to getCreate(Schema). Otherwise the returned collection will also include CREATE statements for all the tables and indexes in the schema. These additional statements are created by invoking getCreate(Table,boolean) for all the tables in the schema.

getCreate

public Collection getCreate(Table pTable)
Generates a CREATE TABLE statement. Doesn't create CREATE INDEX or similar statements.

getCreate

public Collection getCreate(Table pTable,
                            boolean pAll)
Generates CREATE statements for the table.
Parameters:
pAll - If this parameter is set to true, then the method is equivalent to getCreate(Table). Otherwise the returned collection will also include CREATE statements for the indexes, which are defined on the table. These additional statements are created by invoking getCreate(Index) and getCreate(ForeignKey) for all the indexes in the schema.

getDrop

public Collection getDrop(ForeignKey pKey)
Generates a DROP FOEIGN KEY statement.

getDrop

public Collection getDrop(Index pIndex)
Generates a DROP INDEX statement.

getDrop

public Collection getDrop(Schema pSchema)
Generates a DROP SCHEMA statement. Doesn't create DROP TABLE or similar statements.

getDrop

public Collection getDrop(Schema pSchema,
                          boolean pAll)
Generates DROP statements for the schema.
Parameters:
pAll - If this parameter is set to true, then the method is equivalent to getDrop(Schema). Otherwise the returned collection will also include DROP statements for all the tables and indexes in the schema. These additional statements are created by invoking getDrop(Table,boolean) for all the tables in the schema.

getDrop

public Collection getDrop(Table pTable)
Generates a DROP TABLE statement. Doesn't create DROP INDEX or similar statements.

getDrop

public Collection getDrop(Table pTable,
                          boolean pAll)
Generates DROP statements for the table.
Parameters:
pAll - If this parameter is set to true, then the method is equivalent to getDrop(Table). Otherwise the returned collection will also include DROP statements for the indexes, which are defined on the table. These additional statements are created by invoking getDrop(Index) and getDrop(ForeignKey) for all the indexes in the schema.

getLineTerminator

public String getLineTerminator()
Returns the line terminator. A non-null value indicates that the generated statements should be made human readable by splitting them over multiple lines. A null value ensures that a statement consists of a single line only. Defaults to "\n".

getQuery

public String getQuery(Statement pStatement)
Generates an INSERT, UPDATE, DELETE or SELECT statement.

getStatementTerminator

public String getStatementTerminator()
Returns the statement terminator. A non-null value will be appended to all generated statements. Defaults to null.

getWhereClause

public String getWhereClause(SelectStatement pQuery)
Returns the WHERE ... ORDER BY ... part of the SELECT statement.

setLineTerminator

public void setLineTerminator(String pTerminator)
Sets the line terminator. A non-null value indicates that the generated statements should be made human readable by splitting them over multiple lines. A null value ensures that a statement consists of a single line only. Defaults to "\n".

setStatementTerminator

public void setStatementTerminator(String pTerminator)
Sets the statement terminator. A non-null value will be appended to all generated statements. Defaults to null.