A B C D E F G H I J L M N O P R S T U V W X

A

AUTO_INCREMENT - Static variable in interface org.apache.torque.engine.database.model.IDMethod

Key generation via auto-increment.

AppData - class org.apache.torque.engine.database.model.AppData.

A class for holding application data structures.

AppData(String, String) - Constructor for class org.apache.torque.engine.database.model.AppData

Creates a new instance for the specified database type.

addColumn(Attributes) - Method in class org.apache.torque.engine.database.model.Index

Adds a new column to an index.

addColumn(Attributes) - Method in class org.apache.torque.engine.database.model.Table

A utility function to create a new column from attrib and add it to this table.

addColumn(Column) - Method in class org.apache.torque.engine.database.model.Table

Adds a new column to the column list and set the parent table of the column to the current table

addDatabase(Attributes) - Method in class org.apache.torque.engine.database.model.AppData

An utility method to add a new database from an xml attribute.

addDatabase(Database) - Method in class org.apache.torque.engine.database.model.AppData

Add a database to the list and sets the AppData property to this AppData

addFileset(FileSet) - Method in class org.apache.torque.task.TorqueDataModelTask

Adds a set of xml schema files (nested fileset attribute).

addForeignKey(Attributes) - Method in class org.apache.torque.engine.database.model.Table

A utility function to create a new foreign key from attrib and add it to this table.

addForeignKey(ForeignKey) - Method in class org.apache.torque.engine.database.model.Table

Adds a new FK to the FK list and set the parent table of the column to the current table

addIdMethodParameter(Attributes) - Method in class org.apache.torque.engine.database.model.Table

A utility function to create a new id method parameter from attrib and add it to this table.

addIdMethodParameter(IdMethodParameter) - Method in class org.apache.torque.engine.database.model.Table

Adds a new ID method parameter to the list and sets the parent table of the column associated with the supplied parameter to this table.

addIndex(Index) - Method in class org.apache.torque.engine.database.model.Table

Adds a new index to the index list and set the parent table of the column to the current table

addIndex(Attributes) - Method in class org.apache.torque.engine.database.model.Table

A utility function to create a new index from attrib and add it to this table.

addInheritance(Attributes) - Method in class org.apache.torque.engine.database.model.Column

A utility function to create a new column from attrib and add it to this table.

addInheritance(Inheritance) - Method in class org.apache.torque.engine.database.model.Column

Adds a new inheritance definition to the inheritance list and set the parent column of the inheritance to the current column

addReference(Attributes) - Method in class org.apache.torque.engine.database.model.ForeignKey

Adds a new reference entry to the foreign key

addReference(String, String) - Method in class org.apache.torque.engine.database.model.ForeignKey

Adds a new reference entry to the foreign key

addReferrer(ForeignKey) - Method in class org.apache.torque.engine.database.model.Column

Adds the foreign key from another table that refers to this column.

addReferrer(ForeignKey) - Method in class org.apache.torque.engine.database.model.Table

Adds the foreign key from another table that refers to this table.

addTable(Attributes) - Method in class org.apache.torque.engine.database.model.Database

An utility method to add a new table from an xml attribute.

addTable(Table) - Method in class org.apache.torque.engine.database.model.Database

Add a table to the list and sets the Database property to this Database

addText(String) - Method in class org.apache.torque.task.TorqueSQLExec.Transaction

addText(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the sql command to execute

addUnique(Unique) - Method in class org.apache.torque.engine.database.model.Table

Adds a new Unique to the Unique list and set the parent table of the column to the current table

addUnique(Attributes) - Method in class org.apache.torque.engine.database.model.Table

A utility function to create a new Unique from attrib and add it to this table.

B

BIGINT - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIGINT_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIGINT_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIGINT_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIGINT_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIGINT_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIGINT_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BINARY - Static variable in class org.apache.torque.engine.database.model.TypeMap

BINARY_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BINARY_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BINARY_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BINARY_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIT - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIT_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIT_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIT_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIT_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIT_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BIT_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BLOB - Static variable in class org.apache.torque.engine.database.model.TypeMap

BLOB_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BLOB_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BLOB_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANCHAR - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANCHAR_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANCHAR_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANCHAR_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANCHAR_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANCHAR_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANCHAR_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANINT - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANINT_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANINT_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANINT_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANINT_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANINT_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

BOOLEANINT_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

C

CHAR - Static variable in class org.apache.torque.engine.database.model.TypeMap

CHAR_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

CHAR_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

CHAR_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

CHAR_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

CLOB - Static variable in class org.apache.torque.engine.database.model.TypeMap

CLOB_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

CLOB_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

CLOB_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

CONSTRAINT_GENERATOR - Static variable in class org.apache.torque.engine.database.model.NameFactory

The fully qualified class name of the constraint name generator.

CONV_METHOD_JAVANAME - Static variable in interface org.apache.torque.engine.database.model.NameGenerator

Similar to NameGenerator.CONV_METHOD_UNDERSCORE except nothing is converted to lowercase.

CONV_METHOD_NOCHANGE - Static variable in interface org.apache.torque.engine.database.model.NameGenerator

Specifies no modification when converting from a schema column or table name to a java name.

CONV_METHOD_UNDERSCORE - Static variable in interface org.apache.torque.engine.database.model.NameGenerator

Traditional method for converting schema table and column names to java names.

Column - class org.apache.torque.engine.database.model.Column.

A Class for holding data about a column used in an Application.

Column() - Constructor for class org.apache.torque.engine.database.model.Column

Creates a new instance with a null name.

Column(String) - Constructor for class org.apache.torque.engine.database.model.Column

Creates a new column and set the name

ConstraintNameGenerator - class org.apache.torque.engine.database.model.ConstraintNameGenerator.

A NameGenerator implementation for table-specific constraints.

ConstraintNameGenerator() - Constructor for class org.apache.torque.engine.database.model.ConstraintNameGenerator

cleanup() - Method in class org.apache.torque.task.TorqueDataDumpTask

Closes the db-connection, overriding the cleanup() hook method in TexenTask.

columnTableMap - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

Hashtable to track what table a column belongs to.

containsColumn(Column) - Method in class org.apache.torque.engine.database.model.Table

Returns true if the table contains a specified column

containsColumn(String) - Method in class org.apache.torque.engine.database.model.Table

Returns true if the table contains a specified column

context - Variable in class org.apache.torque.task.TorqueDataModelTask

Velocity context which exposes our objects in the templates.

createClasspath() - Method in class org.apache.torque.task.TorqueSQLExec

Create the classpath for loading the driver.

D

DATE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DATE_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DATE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DATE_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

DATE_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

DECIMAL - Static variable in class org.apache.torque.engine.database.model.TypeMap

DECIMAL_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DECIMAL_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DECIMAL_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

DECIMAL_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

DOUBLE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DOUBLE_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DOUBLE_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DOUBLE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

DOUBLE_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

DOUBLE_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

DOUBLE_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

DTDResolver - class org.apache.torque.engine.database.transform.DTDResolver.

A resolver to get the database.dtd file for the XML parser from the jar.

DTDResolver() - Constructor for class org.apache.torque.engine.database.transform.DTDResolver

constructor

Database - class org.apache.torque.engine.database.model.Database.

A class for holding application data structures.

Database() - Constructor for class org.apache.torque.engine.database.model.Database

dataModelDbMap - Variable in class org.apache.torque.task.TorqueDataModelTask

Map of data model name to database name.

dataModels - Variable in class org.apache.torque.task.TorqueDataModelTask

Data models that we collect.

databaseNames - Variable in class org.apache.torque.task.TorqueDataModelTask

Hashtable containing the names of all the databases in our collection of schemas.

databaseNode - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

The document root element.

dbDriver - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

JDBC driver.

dbPassword - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

JDBC password.

dbSchema - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

DB schema to use.

dbUrl - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

JDBC URL.

dbUser - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

JDBC user name.

doFinalInitialization() - Method in class org.apache.torque.engine.database.model.Database

doFinalInitialization() - Method in class org.apache.torque.engine.database.model.Table

A hook for the SAX XML parser to call when this table has been fully loaded from the XML, and all nested elements have been processed.

doc - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

DOM document produced.

E

EngineException - exception org.apache.torque.engine.EngineException.

The base class of all exceptions thrown by the engine.

EngineException() - Constructor for class org.apache.torque.engine.EngineException

Constructs a new EngineException without specified detail message.

EngineException(String) - Constructor for class org.apache.torque.engine.EngineException

Constructs a new EngineException with specified detail message.

EngineException(Throwable) - Constructor for class org.apache.torque.engine.EngineException

Constructs a new EngineException with specified nested Throwable.

EngineException(String, Throwable) - Constructor for class org.apache.torque.engine.EngineException

Constructs a new EngineException with specified detail message and nested Throwable.

endElement(String, String, String) - Method in class org.apache.torque.engine.database.transform.XmlToAppData

Handles closing elements of the xml file.

execSQL(String, PrintStream) - Method in class org.apache.torque.task.TorqueSQLExec

Exec the sql statement.

execute() - Method in class org.apache.torque.engine.database.transform.SQLToAppData

Execute the parser.

execute() - Method in class org.apache.torque.task.PackageAsPathTask

Executes the package to patch converstion and stores it in the user property value.

execute() - Method in class org.apache.torque.task.TorqueJDBCTransformTask

Default constructor.

execute() - Method in class org.apache.torque.task.TorqueSQLExec

Load the sql file and then execute it

execute() - Method in class org.apache.torque.task.TorqueSQLTransformTask

Execute the task.

F

FLOAT - Static variable in class org.apache.torque.engine.database.model.TypeMap

FLOAT_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

FLOAT_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

FLOAT_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

FLOAT_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

FLOAT_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

FLOAT_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

ForeignKey - class org.apache.torque.engine.database.model.ForeignKey.

A class for information about foreign keys of a table.

ForeignKey() - Constructor for class org.apache.torque.engine.database.model.ForeignKey

fetch(String) - Method in class org.apache.torque.task.TorqueDataDumpTask.TableTool

Fetches an Iterator for the data in the named table.

filesets - Variable in class org.apache.torque.task.TorqueDataModelTask

Fileset of XML schemas which represent our data models.

G

generateName(List) - Method in class org.apache.torque.engine.database.model.ConstraintNameGenerator

First element of inputs should be of type Database, second should be a table name, third is the type identifier (spared if trimming is necessary due to database type length constraints), and the fourth is a Integer indicating the number of this contraint.

generateName(List) - Method in class org.apache.torque.engine.database.model.JavaNameGenerator

inputs should consist of two elements, the original name of the database element and the method for generating the name.

generateName(String, List) - Static method in class org.apache.torque.engine.database.model.NameFactory

Given a list of String objects, implements an algorithm which produces a name.

generateName(List) - Method in interface org.apache.torque.engine.database.model.NameGenerator

Given a list of String objects, implements an algorithm which produces a name.

generateXML() - Method in class org.apache.torque.task.TorqueJDBCTransformTask

Generates an XML database schema from JDBC metadata.

get(String) - Method in class org.apache.torque.task.TorqueDataDumpTask.TableTool

Returns the value for the column

getAlgorithm(String) - Method in class org.apache.torque.engine.database.model.NameFactory

Factory method which retrieves an instance of the named generator.

getAlias() - Method in class org.apache.torque.engine.database.model.Table

JavaName of om object this entry references.

getAncestor() - Method in class org.apache.torque.engine.database.model.Inheritance

Get the value of ancestor.

getAppData() - Method in class org.apache.torque.engine.database.model.Database

Get the parent of the table

getBaseClass() - Method in class org.apache.torque.engine.database.model.Database

Get the value of baseClass.

getBaseClass() - Method in class org.apache.torque.engine.database.model.Table

Gets the value of base class for classes produced from this table.

getBasePathToDbProps() - Method in class org.apache.torque.task.TorqueDataModelTask

The path to properties file containing db idiosyncrasies is constructed by appending the "getTargetDatabase()/db.props to this path.

getBasePeer() - Method in class org.apache.torque.engine.database.model.Database

Get the value of basePeer.

getBasePeer() - Method in class org.apache.torque.engine.database.model.Table

Get the value of basePeer.

getChildren() - Method in class org.apache.torque.engine.database.model.Column

Get the inheritance definitions.

getChildrenColumn() - Method in class org.apache.torque.engine.database.model.Table

Gets the column that subclasses of the class representing this table can be produced from.

getChildrenNames() - Method in class org.apache.torque.engine.database.model.Table

Get the objects that can be created from this table.

getClassName() - Method in class org.apache.torque.engine.database.model.Inheritance

Get the value of className.

getCol() - Method in class org.apache.torque.engine.sql.Token

Get the column number of this token.

getColumn() - Method in class org.apache.torque.engine.database.model.Inheritance

Get the value of parent.

getColumn(String) - Method in class org.apache.torque.engine.database.model.Table

Returns a specified column.

getColumn() - Method in class org.apache.torque.engine.database.transform.XmlToData.ColumnValue

getColumnByJavaName(String) - Method in class org.apache.torque.engine.database.model.Table

Returns a specified column.

getColumnList() - Method in class org.apache.torque.engine.database.model.Index

Return a comma delimited string of the columns which compose this index.

getColumnNames() - Method in class org.apache.torque.engine.database.model.Index

Returns the list of names of the columns referenced by this index.

getColumnValues() - Method in class org.apache.torque.engine.database.transform.XmlToData.DataRow

getColumns() - Method in class org.apache.torque.engine.database.model.Index

Return the list of local columns.

getColumns() - Method in class org.apache.torque.engine.database.model.Table

Returns an Array containing all the columns in the table

getColumns(DatabaseMetaData, String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

Retrieves all the column names and types for a given table from JDBC metadata.

getContainsForeignPK() - Method in class org.apache.torque.engine.database.model.Table

Determine if this table contains a foreign PK

getDataDTD() - Method in class org.apache.torque.task.TorqueDataSQLTask

Gets the DataDTD attribute of the TorqueDataSQLTask object

getDataModelDbMap() - Method in class org.apache.torque.task.TorqueDataModelTask

Return the data model to database name map.

getDataModels() - Method in class org.apache.torque.task.TorqueDataModelTask

Return the data models that have been processed.

getDataXmlFile() - Method in class org.apache.torque.task.TorqueDataSQLTask

Gets the DataXmlFile attribute of the TorqueDataSQLTask object

getDatabase() - Method in class org.apache.torque.engine.database.model.AppData

Get database object.

getDatabase(String) - Method in class org.apache.torque.engine.database.model.AppData

Return the database with the specified name.

getDatabase() - Method in class org.apache.torque.engine.database.model.Table

Get the parent of the table

getDatabase() - Method in class org.apache.torque.task.TorqueSQLTask

getDatabaseDriver() - Method in class org.apache.torque.task.TorqueDataDumpTask

Get the database driver name

getDatabaseName() - Method in class org.apache.torque.task.TorqueDataDumpTask

Get the database name to dump

getDatabasePassword() - Method in class org.apache.torque.task.TorqueDataDumpTask

Get the database password

getDatabaseType() - Method in class org.apache.torque.engine.database.model.Database

getDatabaseUrl() - Method in class org.apache.torque.task.TorqueDataDumpTask

Get the database url

getDatabaseUser() - Method in class org.apache.torque.task.TorqueDataDumpTask

Get the database user

getDatabases() - Method in class org.apache.torque.engine.database.model.AppData

Return an array of all databases

getDbSchema() - Method in class org.apache.torque.task.TorqueJDBCTransformTask

getDefaultIdMethod() - Method in class org.apache.torque.engine.database.model.Database

Get the value of defaultIdMethod.

getDefaultJavaNamingMethod() - Method in class org.apache.torque.engine.database.model.Database

Get the value of defaultJavaNamingMethod which specifies the method for converting schema names for table and column to Java names.

getDefaultJavaType() - Method in class org.apache.torque.engine.database.model.Database

Get type to use in Java sources (primitive || object)

getDefaultSetting() - Method in class org.apache.torque.engine.database.model.Column

Return a string that will give this column a default value.

getDefaultValue() - Method in class org.apache.torque.engine.database.model.Column

Get a string that will give this column a default value.

getDescription() - Method in class org.apache.torque.engine.database.model.Column

Get the description for the Table

getDescription() - Method in class org.apache.torque.engine.database.model.Table

Get the description for the Table

getEscapedValue() - Method in class org.apache.torque.engine.database.transform.XmlToData.ColumnValue

getForeignColumnNames() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns a comma delimited string of foreign column names

getForeignColumns() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns the list of foreign column names.

getForeignKey() - Method in class org.apache.torque.engine.database.model.Column

get the foreign key object for this column if it is a foreign key or part of a foreign key

getForeignKey(String) - Method in class org.apache.torque.engine.database.model.Table

Return the first foreign key that includes col in it's list of local columns.

getForeignKeys() - Method in class org.apache.torque.engine.database.model.Table

Returns an Array containing all the FKs in the table

getForeignKeys(DatabaseMetaData, String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

Retrieves a list of foreign key columns for a given table.

getForeignLocalMapping() - Method in class org.apache.torque.engine.database.model.ForeignKey

Utility method to get foreign column names to local column names mapping for this foreign key.

getForeignTableName() - Method in class org.apache.torque.engine.database.model.ForeignKey

Get the foreignTableName of the FK

getForeignTableNames() - Method in class org.apache.torque.engine.database.model.Table

A list of tables referenced by foreign keys in this table

getFullyQualifiedName() - Method in class org.apache.torque.engine.database.model.Column

Returns table.column

getIdMethod() - Method in class org.apache.torque.engine.database.model.Table

Get the method for generating pk's

getIdMethodParameters() - Method in class org.apache.torque.engine.database.model.Table

Returns a Collection of parameters relevant for the chosen id generation method.

getIdTableXMLFile() - Method in class org.apache.torque.task.TorqueSQLTask

Gets the id-table xml schema file path.

getIdiosyncrasies(String) - Method in class org.apache.torque.engine.database.model.AppData

Each database has its own list of idiosyncrasies which can be configured by editting its db.props file.

getIndices() - Method in class org.apache.torque.engine.database.model.Table

Returns an Array containing all the indices in the table

getInputFile() - Method in class org.apache.torque.task.TorqueSQLTransformTask

Get the current input file

getInputSource(String) - Method in class org.apache.torque.engine.database.transform.XmlToData

get an InputSource for an URL String

getInputValidator() - Method in class org.apache.torque.engine.database.model.Column

Returns the class name to do input validation

getInterface() - Method in class org.apache.torque.engine.database.model.Table

Interface which objects for this table will implement

getJavaName() - Method in class org.apache.torque.engine.database.model.Column

Get name to use in Java sources to build method names.

getJavaName() - Method in class org.apache.torque.engine.database.model.Table

Get name to use in Java sources

getJavaNative() - Method in class org.apache.torque.engine.database.model.Column

Return a string representation of the native java type which corresponds to the JDBC type of this column.

getJavaNative(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Return native java type which corresponds to the JDBC type provided.

getJavaNativeObject(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Return native java type which corresponds to the JDBC type provided.

getJavaObject() - Method in class org.apache.torque.engine.database.model.Column

Return a string representation of the Java object which corresponds to the JDBC type of this column.

getJavaObject(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Return a Java object which corresponds to the JDBC type provided.

getJavaPrimitive() - Method in class org.apache.torque.engine.database.model.Column

Return a string representation of the primitive java type which corresponds to the JDBC type of this column.

getJavaType() - Method in class org.apache.torque.engine.database.model.Column

Get type to use in Java sources

getJdbcType(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Returns the correct jdbc type for torque added types

getKey() - Method in class org.apache.torque.engine.database.model.Inheritance

Get the value of key.

getLine() - Method in class org.apache.torque.engine.sql.Token

Get the line number of this token.

getLocalColumnNames() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns a comma delimited string of local column names

getLocalColumns() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns the list of local column names.

getLocalForeignMapping() - Method in class org.apache.torque.engine.database.model.ForeignKey

Utility method to get local column names to foreign column names mapping for this foreign key.

getName() - Method in class org.apache.torque.engine.database.model.AppData

Get the name of the database.

getName() - Method in class org.apache.torque.engine.database.model.Column

Get the name of the column

getName() - Method in class org.apache.torque.engine.database.model.Database

Get the name of the Database

getName() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns the name attribute.

getName() - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Get the parameter name

getName() - Method in class org.apache.torque.engine.database.model.Index

Gets the name of this index.

getName() - Method in class org.apache.torque.engine.database.model.Table

Get the name of the Table

getNumColumns() - Method in class org.apache.torque.engine.database.model.Table

Utility method to get the number of columns in this table

getOnDelete() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns the onDelete attribute

getOnUpdate() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns the onUpdate attribute

getOutputFile() - Method in class org.apache.torque.task.TorqueSQLTransformTask

Get the current output file.

getOutputFormat() - Method in class org.apache.torque.task.TorqueDocumentationTask

Get the current output format.

getPPMethod(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Return ParameterParser getX() method which corresponds to the JDBC type provided.

getPackage() - Method in class org.apache.torque.engine.database.model.Database

Get the value of package.

getPackage() - Method in class org.apache.torque.engine.database.model.Table

Get the value of package.

getParameterParserMethod() - Method in class org.apache.torque.engine.database.model.Column

Return ParameterParser getX() method which corresponds to the JDBC type which represents this column.

getPosition() - Method in class org.apache.torque.engine.database.model.Column

Get the location of this column within the table (one-based).

getPrimaryKey() - Method in class org.apache.torque.engine.database.model.Table

Returns the collection of Columns which make up the single primary key for this table.

getPrimaryKeys(DatabaseMetaData, String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

Retrieves a list of the columns composing the primary key for a given table.

getProperty(String) - Method in class org.apache.torque.engine.database.model.Database

Returns the value of the named property from this database's db.props file.

getReferrers() - Method in class org.apache.torque.engine.database.model.Column

Get list of references to this column.

getReferrers() - Method in class org.apache.torque.engine.database.model.Table

Get list of references to this table.

getRelatedColumnName() - Method in class org.apache.torque.engine.database.model.Column

Utility method to get the related column of this local column if this column is a foreign key or part of a foreign key.

getRelatedTableName() - Method in class org.apache.torque.engine.database.model.Column

Utility method to get the related table of this column if it is a foreign key or part of a foreign key

getSequenceName() - Method in class org.apache.torque.engine.database.model.Table

A name to use for creating a sequence if one is not specified.

getShortName() - Method in class org.apache.torque.engine.database.model.AppData

Get the short name of the database (without the '-schema' postfix).

getSize() - Method in class org.apache.torque.engine.database.model.Column

Returns the size of the column

getSqlDbMap() - Method in class org.apache.torque.task.TorqueDataModelTask

Get the sqldbmap.

getSqlDbMap() - Method in class org.apache.torque.task.TorqueSQLExec

Get the sqldbmap properties file.

getSqlFile() - Method in class org.apache.torque.engine.database.transform.SQLToAppData

Get the current input sql file

getSrcDir() - Method in class org.apache.torque.task.TorqueSQLExec

Get the src directory for the sql files listed in the sqldbmap file.

getStr() - Method in class org.apache.torque.engine.sql.Token

Returns the string representation of this token.

getSuffix() - Method in class org.apache.torque.task.TorqueSQLTask

getTable() - Method in class org.apache.torque.engine.database.model.Column

Get the parent Table of the column

getTable(String) - Method in class org.apache.torque.engine.database.model.Database

Return the table with the specified name.

getTable() - Method in class org.apache.torque.engine.database.model.ForeignKey

Get the parent Table of the foreign key

getTable() - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Get the parent Table of the id method

getTable() - Method in class org.apache.torque.engine.database.model.Index

Get the parent Table of the index

getTable() - Method in class org.apache.torque.engine.database.transform.XmlToData.DataRow

getTableByJavaName(String) - Method in class org.apache.torque.engine.database.model.Database

Return the table with the specified javaName.

getTableName() - Method in class org.apache.torque.engine.database.model.Column

Returns the Name of the table the column is in

getTableName() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns the name of the table the foreign key is in

getTableName() - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Returns the Name of the table the id method is in

getTableName() - Method in class org.apache.torque.engine.database.model.Index

Returns the Name of the table the index is in

getTableNames(DatabaseMetaData) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

Get all the table names in the current database that are not system tables.

getTables() - Method in class org.apache.torque.engine.database.model.Database

Return an array of all tables

getTargetDatabase() - Method in class org.apache.torque.task.TorqueDataModelTask

Get the current target database.

getTargetDatabase() - Method in class org.apache.torque.task.TorqueDataSQLTask

Get the current target database.

getTargetPackage() - Method in class org.apache.torque.task.TorqueDataModelTask

Get the current target package.

getTorqueType() - Method in class org.apache.torque.engine.database.model.Column

Returns the column type as given in the schema as an object

getTorqueType(Integer) - Static method in class org.apache.torque.engine.database.model.TypeMap

Returns Torque type constant corresponding to JDBC type code.

getType() - Method in class org.apache.torque.engine.database.model.Column

Returns the column jdbc type as an object

getUncapitalisedJavaName() - Method in class org.apache.torque.engine.database.model.Column

Get variable name to use in Java sources (= uncapitalised java name)

getUnices() - Method in class org.apache.torque.engine.database.model.Table

Returns an Array containing all the UKs in the table

getValue() - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Get the parameter value

getValue() - Method in class org.apache.torque.engine.database.transform.XmlToData.ColumnValue

getValues() - Method in class org.apache.torque.task.TorqueSQLExec.DelimiterType

getValues() - Method in class org.apache.torque.task.TorqueSQLExec.OnError

getVillageMethod() - Method in class org.apache.torque.engine.database.model.Column

Return Village asX() method which corresponds to the JDBC type which represents this column.

getVillageMethod(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Return Village asX() method which corresponds to the JDBC type provided.

getVillageObjectMethod(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Return Village asX() method which corresponds to the JDBC type provided.

getXmlFile() - Method in class org.apache.torque.task.TorqueDataModelTask

Get the xml schema describing the application model.

H

hasMultipleDatabases() - Method in class org.apache.torque.engine.database.model.AppData

Returns whether this application has multiple databases.

hasNext() - Method in class org.apache.torque.task.TorqueDataDumpTask.TableTool

check if there are more records in the QueryDataSet

hasOnDelete() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns whether or not the onDelete attribute is set

hasOnUpdate() - Method in class org.apache.torque.engine.database.model.ForeignKey

Returns whether or not the onUpdate attribute is set

hasPrimaryKey() - Method in class org.apache.torque.engine.database.model.Table

Determine whether this table has a primary key.

I

IDMethod - interface org.apache.torque.engine.database.model.IDMethod.

Interface for various ID retrieval method types (i.e.

ID_BROKER - Static variable in interface org.apache.torque.engine.database.model.IDMethod

Key generation via the IDBroker table.

INTEGER - Static variable in class org.apache.torque.engine.database.model.TypeMap

INTEGER_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

INTEGER_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

INTEGER_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

INTEGER_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

INTEGER_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

INTEGER_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

IdMethodParameter - class org.apache.torque.engine.database.model.IdMethodParameter.

Information related to an ID method.

IdMethodParameter() - Constructor for class org.apache.torque.engine.database.model.IdMethodParameter

Index - class org.apache.torque.engine.database.model.Index.

Information about indices of a table.

Index() - Constructor for class org.apache.torque.engine.database.model.Index

Creates a new instance with default characteristics (no name or parent table, small column list size allocation, non-unique).

Index(Table, List) - Constructor for class org.apache.torque.engine.database.model.Index

Creates a new instance for the list of columns composing an index.

Inheritance - class org.apache.torque.engine.database.model.Inheritance.

A Class for information regarding possible objects representing a table

Inheritance() - Constructor for class org.apache.torque.engine.database.model.Inheritance

initControlContext() - Method in class org.apache.torque.task.TorqueDataDumpTask

Initializes initial context

initControlContext() - Method in class org.apache.torque.task.TorqueDataModelTask

Set up the initial context for generating the SQL from the XML schema.

initControlContext() - Method in class org.apache.torque.task.TorqueDataSQLTask

Set up the initial context for generating the SQL from the XML schema.

initControlContext() - Method in class org.apache.torque.task.TorqueDocumentationTask

Place our target package value into the context for use in the templates.

initControlContext() - Method in class org.apache.torque.task.TorqueSQLTask

Place our target database and target platform values into the context for use in the templates.

initialize() - Static method in class org.apache.torque.engine.database.model.TypeMap

Initializes the SQL to Java map so that it can be used by client code.

isAbstract() - Method in class org.apache.torque.engine.database.model.Table

When a table is abstract, it marks the business object class that is generated as being abstract.

isAlias() - Method in class org.apache.torque.engine.database.model.Table

Is this table specified in the schema or is there just a foreign key reference to it.

isAutoIncrement() - Method in class org.apache.torque.engine.database.model.Column

Return auto increment/sequence string for the target database.

isBit() - Method in class org.apache.torque.engine.database.model.Column

Returns true if the column type is boolean in the java object and a Bit ("1" or "0") in the db.

isBit(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Returns true if the type is boolean in the java object and a Bit "1" or "0" in the db.

isBooleanChar() - Method in class org.apache.torque.engine.database.model.Column

Returns true if the column type is boolean in the java object and a String ("Y" or "N") in the db.

isBooleanChar(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Returns true if the type is boolean in the java object and a String "Y" or "N" in the db.

isBooleanInt() - Method in class org.apache.torque.engine.database.model.Column

Returns true if the column type is boolean in the java object and a numeric (1 or 0) in the db.

isBooleanInt(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Returns true if the type is boolean in the java object and a numeric (1 or 0) in the db.

isEnumeratedClasses() - Method in class org.apache.torque.engine.database.model.Column

Determine if possible classes have been enumerated in the xml file.

isForReferenceOnly() - Method in class org.apache.torque.engine.database.model.Table

Flag to determine if code/sql gets created for this table.

isForeignKey() - Method in class org.apache.torque.engine.database.model.Column

Utility method to determine if this column is a foreign key.

isHeavyIndexing() - Method in class org.apache.torque.engine.database.model.Database

Get the value of heavyIndexing.

isInheritance() - Method in class org.apache.torque.engine.database.model.Column

Determine if this column is a normal property or specifies a the classes that are represented in the table containing this column.

isInitialized() - Static method in class org.apache.torque.engine.database.model.TypeMap

Report whether this object has been initialized.

isMultipleFK() - Method in class org.apache.torque.engine.database.model.Column

Determine if this column is a foreign key that refers to the same table as another foreign key column in this table.

isNotNull() - Method in class org.apache.torque.engine.database.model.Column

Return the isNotNull property of the column

isPrimaryKey() - Method in class org.apache.torque.engine.database.model.Column

Return true if the column is a primary key

isPrimitive() - Method in class org.apache.torque.engine.database.model.Column

returns true, if the columns java native type is an boolean, byte, short, int, long, float, double, char

isSameJavaName() - Method in class org.apache.torque.task.TorqueJDBCTransformTask

isSkipSql() - Method in class org.apache.torque.engine.database.model.Table

Skip generating sql for this table (in the event it should not be created from scratch).

isString() - Method in class org.apache.torque.engine.database.model.Column

Utility method to see if the column is a string

isTextType(String) - Static method in class org.apache.torque.engine.database.model.TypeMap

Returns true if values for the type need to be quoted.

isUnique() - Method in class org.apache.torque.engine.database.model.Column

Get the UNIQUE property

isUnique() - Method in class org.apache.torque.engine.database.model.Index

Returns the uniqueness of this index.

isUnique() - Method in class org.apache.torque.engine.database.model.Unique

Returns true.

isUsePrimitive() - Method in class org.apache.torque.engine.database.model.Column

isValidRdbms(Connection) - Method in class org.apache.torque.task.TorqueSQLExec

Verify if connected to the correct RDBMS

J

JAVA_GENERATOR - Static variable in class org.apache.torque.engine.database.model.NameFactory

The fully qualified class name of the Java name generator.

JavaNameGenerator - class org.apache.torque.engine.database.model.JavaNameGenerator.

A NameGenerator implementation for Java-esque names.

JavaNameGenerator() - Constructor for class org.apache.torque.engine.database.model.JavaNameGenerator

javanameMethod(String) - Method in class org.apache.torque.engine.database.model.JavaNameGenerator

Converts a database schema name to java object name.

L

LONGVARBINARY - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARBINARY_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARBINARY_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARBINARY_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARBINARY_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARCHAR - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARCHAR_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARCHAR_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARCHAR_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

LONGVARCHAR_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

loadFromXML(Attributes) - Method in class org.apache.torque.engine.database.model.Column

Imports a column from an XML specification

loadFromXML(Attributes) - Method in class org.apache.torque.engine.database.model.Database

Load the database object from an xml tag.

loadFromXML(Attributes) - Method in class org.apache.torque.engine.database.model.ForeignKey

Imports foreign key from an XML specification

loadFromXML(Attributes) - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Imports foreign key from an XML specification

loadFromXML(Attributes) - Method in class org.apache.torque.engine.database.model.Index

Imports index from an XML specification

loadFromXML(Attributes) - Method in class org.apache.torque.engine.database.model.Inheritance

Imports foreign key from an XML specification

loadFromXML(Attributes, String) - Method in class org.apache.torque.engine.database.model.Table

Load the table object from an xml tag.

loadIdBrokerModel() - Method in class org.apache.torque.task.TorqueSQLTask

Create the database model necessary for the IDBroker tables.

M

main(String[]) - Static method in class org.apache.torque.engine.database.transform.SQLToAppData

Just 4 testing.

makeList(List) - Static method in class org.apache.torque.engine.database.model.Column

Return a comma delimited string listing the specified columns.

N

NATIVE - Static variable in interface org.apache.torque.engine.database.model.IDMethod

Key generation via database-specific ID method (i.e.

NORMAL - Static variable in class org.apache.torque.task.TorqueSQLExec.DelimiterType

NO_ID_METHOD - Static variable in interface org.apache.torque.engine.database.model.IDMethod

No RDBMS key generation (keys may be generated by the application).

NUMERIC - Static variable in class org.apache.torque.engine.database.model.TypeMap

NUMERIC_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

NUMERIC_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

NUMERIC_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

NUMERIC_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

NameFactory - class org.apache.torque.engine.database.model.NameFactory.

A name generation factory.

NameFactory() - Constructor for class org.apache.torque.engine.database.model.NameFactory

Creates a new instance with storage for algorithm implementations.

NameGenerator - interface org.apache.torque.engine.database.model.NameGenerator.

The generic interface to a name generation algorithm.

name - Variable in class org.apache.torque.task.PackageAsPathTask

The value to store the conversion in.

needEscapedValue() - Method in class org.apache.torque.engine.database.model.Column

Utility method to return the value as an element to be usable in an SQL insert statement.

next() - Method in class org.apache.torque.task.TorqueDataDumpTask.TableTool

load the next record from the QueryDataSet

nochangeMethod(String) - Method in class org.apache.torque.engine.database.model.JavaNameGenerator

Converts a database schema name to java object name.

O

org.apache.torque.engine - package org.apache.torque.engine

org.apache.torque.engine.database.model - package org.apache.torque.engine.database.model

org.apache.torque.engine.database.transform - package org.apache.torque.engine.database.transform

org.apache.torque.engine.sql - package org.apache.torque.engine.sql

org.apache.torque.task - package org.apache.torque.task

tasks to generate code, sql, docs, ..

P

PackageAsPathTask - class org.apache.torque.task.PackageAsPathTask.

Simple task to convert packages to paths.

PackageAsPathTask() - Constructor for class org.apache.torque.task.PackageAsPathTask

ParseException - exception org.apache.torque.engine.sql.ParseException.

An Exception for parsing SQLToAppData.

ParseException(String) - Constructor for class org.apache.torque.engine.sql.ParseException

constructor.

parseFile(String) - Method in class org.apache.torque.engine.database.transform.XmlToAppData

Parses a XML input file and returns a newly created and populated AppData structure.

parseFile(String) - Method in class org.apache.torque.engine.database.transform.XmlToData

pckg - Variable in class org.apache.torque.task.PackageAsPathTask

The package to convert.

primaryKeys - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

Hashtable of columns that have primary keys.

printPrimaryKey() - Method in class org.apache.torque.engine.database.model.Table

Returns all parts of the primary key, separated by commas.

printResults(PrintStream) - Method in class org.apache.torque.task.TorqueSQLExec

print any results in the statement.

printSize() - Method in class org.apache.torque.engine.database.model.Column

Return the size in brackets for use in an sql schema if the type is String.

R

REAL - Static variable in class org.apache.torque.engine.database.model.TypeMap

REAL_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

REAL_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

REAL_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

REAL_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

REAL_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

REAL_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

ROW - Static variable in class org.apache.torque.task.TorqueSQLExec.DelimiterType

remove() - Method in class org.apache.torque.task.TorqueDataDumpTask.TableTool

unsupported! always throws Exception

requiresIdTable() - Method in class org.apache.torque.engine.database.model.Database

Determines if this database will be using the IDMethod.ID_BROKER to create ids for torque OM objects.

requiresTransactionInPostgres() - Method in class org.apache.torque.engine.database.model.Column

Return true if the column requires a transaction in Postgres

requiresTransactionInPostgres() - Method in class org.apache.torque.engine.database.model.Table

Return true if the column requires a transaction in Postgres

resolveEntity(String, String) - Method in class org.apache.torque.engine.database.transform.DTDResolver

An implementation of the SAX EntityResolver interface to be called by the XML parser.

resolveEntity(String, String) - Method in class org.apache.torque.engine.database.transform.XmlToAppData

EntityResolver implementation.

resolveEntity(String, String) - Method in class org.apache.torque.engine.database.transform.XmlToData

called by the XML parser

runStatements(Reader, PrintStream) - Method in class org.apache.torque.task.TorqueSQLExec

Read the statements from the .sql file and execute them.

S

SEQUENCE - Static variable in interface org.apache.torque.engine.database.model.IDMethod

Key generation via sequences.

SMALLINT - Static variable in class org.apache.torque.engine.database.model.TypeMap

SMALLINT_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

SMALLINT_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

SMALLINT_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

SMALLINT_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

SMALLINT_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

SMALLINT_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

SQLScanner - class org.apache.torque.engine.sql.SQLScanner.

A simple Scanner implementation that scans an sql file into usable tokens.

SQLScanner() - Constructor for class org.apache.torque.engine.sql.SQLScanner

Creates a new scanner with no Reader

SQLScanner(Reader) - Constructor for class org.apache.torque.engine.sql.SQLScanner

Creates a new scanner with an Input Reader

SQLToAppData - class org.apache.torque.engine.database.transform.SQLToAppData.

A Class that converts an sql input file to an AppData structure.

SQLToAppData(String) - Constructor for class org.apache.torque.engine.database.transform.SQLToAppData

Create a new class with an input Reader

SQLToAppData(String, String, String) - Constructor for class org.apache.torque.engine.database.transform.SQLToAppData

Create a new class with an input Reader.

STD_SEPARATOR_CHAR - Static variable in interface org.apache.torque.engine.database.model.NameGenerator

The character used by most implementations as the separator between name elements.

sameJavaName - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

scan() - Method in class org.apache.torque.engine.sql.SQLScanner

Scan the input Reader and returns a list of tokens.

setAbstract(boolean) - Method in class org.apache.torque.engine.database.model.Table

When a table is abstract, it marks the business object class that is generated as being abstract.

setAlias(String) - Method in class org.apache.torque.engine.database.model.Table

Set whether this table specified in the schema or is there just a foreign key reference to it.

setAncestor(String) - Method in class org.apache.torque.engine.database.model.Inheritance

Set the value of ancestor.

setAppData(AppData) - Method in class org.apache.torque.engine.database.model.Database

Set the parent of the database

setAutoIncrement(boolean) - Method in class org.apache.torque.engine.database.model.Column

Set the auto increment value.

setAutocommit(boolean) - Method in class org.apache.torque.task.TorqueSQLExec

Set the autocommit flag for the DB connection.

setBaseClass(String) - Method in class org.apache.torque.engine.database.model.Database

Set the value of baseClass.

setBaseClass(String) - Method in class org.apache.torque.engine.database.model.Table

Set the value of baseClass.

setBasePathToDbProps(String) - Method in class org.apache.torque.task.TorqueDataModelTask

The path to properties file containing db idiosyncrasies is constructed by appending the "getTargetDatabase()/db.props to this path.

setBasePeer(String) - Method in class org.apache.torque.engine.database.model.Database

Set the value of basePeer.

setBasePeer(String) - Method in class org.apache.torque.engine.database.model.Table

Set the value of basePeer.

setClassName(String) - Method in class org.apache.torque.engine.database.model.Inheritance

Set the value of className.

setClasspath(Path) - Method in class org.apache.torque.task.TorqueSQLExec

Set the classpath for loading the driver.

setClasspathRef(Reference) - Method in class org.apache.torque.task.TorqueSQLExec

Set the classpath for loading the driver using the classpath reference.

setColumn(Column) - Method in class org.apache.torque.engine.database.model.Inheritance

Set the value of parent.

setContainsForeignPK(boolean) - Method in class org.apache.torque.engine.database.model.Table

Set whether this table contains a foreign PK

setContextProperties(String) - Method in class org.apache.torque.task.TorqueDataModelTask

Override Texen's context properties to map the torque.xxx properties (including defaults set by the org/apache/torque/defaults.properties) to just xxx.

setDataDTD(String) - Method in class org.apache.torque.task.TorqueDataSQLTask

Sets the DataDTD attribute of the TorqueDataSQLTask object

setDataXmlFile(String) - Method in class org.apache.torque.task.TorqueDataSQLTask

Sets the DataXmlFile attribute of the TorqueDataSQLTask object

setDatabase(Database) - Method in class org.apache.torque.engine.database.model.Table

Set the parent of the table

setDatabase(String) - Method in class org.apache.torque.task.TorqueSQLTask

setDatabaseDriver(String) - Method in class org.apache.torque.task.TorqueDataDumpTask

Set the database driver name

setDatabaseName(String) - Method in class org.apache.torque.task.TorqueDataDumpTask

Set the database name

setDatabasePassword(String) - Method in class org.apache.torque.task.TorqueDataDumpTask

Set the database password

setDatabaseType(String) - Method in class org.apache.torque.engine.database.model.Database

setDatabaseUrl(String) - Method in class org.apache.torque.task.TorqueDataDumpTask

Set the database url

setDatabaseUser(String) - Method in class org.apache.torque.task.TorqueDataDumpTask

Set the database user

setDbDriver(String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

setDbPassword(String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

setDbSchema(String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

setDbUrl(String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

setDbUser(String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

setDefaultIdMethod(String) - Method in class org.apache.torque.engine.database.model.Database

Set the value of defaultIdMethod.

setDefaultJavaNamingMethod(String) - Method in class org.apache.torque.engine.database.model.Database

Set the value of defaultJavaNamingMethod.

setDefaultValue(String) - Method in class org.apache.torque.engine.database.model.Column

Set a string that will give this column a default value.

setDelimiter(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the statement delimiter.

setDelimiterType(TorqueSQLExec.DelimiterType) - Method in class org.apache.torque.task.TorqueSQLExec

Set the Delimiter type for this sql task.

setDescription(String) - Method in class org.apache.torque.engine.database.model.Column

Set the description for the Table

setDescription(String) - Method in class org.apache.torque.engine.database.model.Table

Set the description for the Table

setDriver(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the JDBC driver to be used.

setEncoding(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the file encoding to use on the sql files read in

setForReferenceOnly(boolean) - Method in class org.apache.torque.engine.database.model.Table

Flag to determine if code/sql gets created for this table.

setForeignTableName(String) - Method in class org.apache.torque.engine.database.model.ForeignKey

Set the foreignTableName of the FK

setHeavyIndexing(boolean) - Method in class org.apache.torque.engine.database.model.Database

Set the value of heavyIndexing.

setIdMethod(String) - Method in class org.apache.torque.engine.database.model.Table

Set the method for generating pk's

setIdTableXMLFile(String) - Method in class org.apache.torque.task.TorqueSQLTask

Set the path to the xml schema file that defines the id-table, used by the idbroker method.

setInput(Reader) - Method in class org.apache.torque.engine.sql.SQLScanner

Set the Input

setInputFile(String) - Method in class org.apache.torque.task.TorqueSQLTransformTask

Set the sql input file.

setInterface(String) - Method in class org.apache.torque.engine.database.model.Table

Interface which objects for this table will implement

setJavaName(String) - Method in class org.apache.torque.engine.database.model.Column

Set name to use in Java sources

setJavaName(String) - Method in class org.apache.torque.engine.database.model.Table

Set name to use in Java sources

setKey(String) - Method in class org.apache.torque.engine.database.model.Inheritance

Set the value of key.

setName(String) - Method in class org.apache.torque.engine.database.model.AppData

Set the name of the database.

setName(String) - Method in class org.apache.torque.engine.database.model.Column

Set the name of the column

setName(String) - Method in class org.apache.torque.engine.database.model.Database

Set the name of the Database

setName(String) - Method in class org.apache.torque.engine.database.model.ForeignKey

Sets the name attribute.

setName(String) - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Set the parameter name

setName(String) - Method in class org.apache.torque.engine.database.model.Index

Set the name of this index.

setName(String) - Method in class org.apache.torque.engine.database.model.Table

Set the name of the Table

setName(String) - Method in class org.apache.torque.task.PackageAsPathTask

setNotNull(boolean) - Method in class org.apache.torque.engine.database.model.Column

Set the isNotNull property of the column

setOnDelete(String) - Method in class org.apache.torque.engine.database.model.ForeignKey

Sets the onDelete attribute

setOnUpdate(String) - Method in class org.apache.torque.engine.database.model.ForeignKey

Sets the onUpdate attribute

setOnerror(TorqueSQLExec.OnError) - Method in class org.apache.torque.task.TorqueSQLExec

Set the action to perform onerror

setOutput(File) - Method in class org.apache.torque.task.TorqueSQLExec

Set the output file.

setOutputFile(String) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

setOutputFile(String) - Method in class org.apache.torque.task.TorqueSQLTransformTask

Set the current output file.

setOutputFormat(String) - Method in class org.apache.torque.task.TorqueDocumentationTask

Set the current output format.

setPackage(String) - Method in class org.apache.torque.engine.database.model.Database

Set the value of package.

setPackage(String) - Method in class org.apache.torque.engine.database.model.Table

Set the value of package.

setPackage(String) - Method in class org.apache.torque.task.PackageAsPathTask

setPassword(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the password for the DB connection.

setPosition(int) - Method in class org.apache.torque.engine.database.model.Column

Get the location of this column within the table (one-based).

setPrimaryKey(boolean) - Method in class org.apache.torque.engine.database.model.Column

Set if the column is a primary key or not

setPrint(boolean) - Method in class org.apache.torque.task.TorqueSQLExec

Set the print flag.

setRdbms(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the rdbms required

setSameJavaName(boolean) - Method in class org.apache.torque.task.TorqueJDBCTransformTask

setShowheaders(boolean) - Method in class org.apache.torque.task.TorqueSQLExec

Set the showheaders flag.

setSize(String) - Method in class org.apache.torque.engine.database.model.Column

Set the size of the column

setSkipSql(boolean) - Method in class org.apache.torque.engine.database.model.Table

Set whether this table should have its creation sql generated.

setSqlDbMap(String) - Method in class org.apache.torque.task.TorqueDataModelTask

Set the sqldbmap.

setSqlDbMap(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the sqldbmap properties file.

setSqlFile(String) - Method in class org.apache.torque.engine.database.transform.SQLToAppData

Set the current input sql file

setSrc(File) - Method in class org.apache.torque.task.TorqueSQLExec.Transaction

setSrcDir(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the src directory for the sql files listed in the sqldbmap file.

setSuffix(String) - Method in class org.apache.torque.task.TorqueSQLTask

setTable(Table) - Method in class org.apache.torque.engine.database.model.Column

Set the parent Table of the column

setTable(Table) - Method in class org.apache.torque.engine.database.model.ForeignKey

Set the parent Table of the foreign key

setTable(Table) - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Set the parent Table of the id method

setTable(Table) - Method in class org.apache.torque.engine.database.model.Index

Set the parent Table of the index

setTargetDatabase(String) - Method in class org.apache.torque.task.TorqueDataModelTask

Set the current target database.

setTargetDatabase(String) - Method in class org.apache.torque.task.TorqueDataSQLTask

Set the current target database.

setTargetPackage(String) - Method in class org.apache.torque.task.TorqueDataModelTask

Set the current target package.

setType(String) - Method in class org.apache.torque.engine.database.model.Column

Returns the colunm type

setTypeFromString(String, String) - Method in class org.apache.torque.engine.database.model.Column

Set the column type from a string property (normally a string from an sql input file)

setUnique(boolean) - Method in class org.apache.torque.engine.database.model.Column

Set true if the column is UNIQUE

setUrl(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the DB connection url.

setUserid(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the user name for the DB connection.

setValue(String) - Method in class org.apache.torque.engine.database.model.IdMethodParameter

Set the parameter value

setVersion(String) - Method in class org.apache.torque.task.TorqueSQLExec

Set the version required

setXmlFile(String) - Method in class org.apache.torque.task.TorqueDataModelTask

Set the xml schema describing the application model.

sqldbmap - Variable in class org.apache.torque.task.TorqueDataModelTask

Name of the properties file that maps an SQL file to a particular database.

startElement(String, String, String, Attributes) - Method in class org.apache.torque.engine.database.transform.XmlToAppData

Handles opening elements of the xml file.

startElement(String, String, String, Attributes) - Method in class org.apache.torque.engine.database.transform.XmlToData

Handles opening elements of the xml file.

T

TIME - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIMESTAMP - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIMESTAMP_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIMESTAMP_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIMESTAMP_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIMESTAMP_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIME_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIME_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIME_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

TIME_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

TINYINT - Static variable in class org.apache.torque.engine.database.model.TypeMap

TINYINT_NATIVE_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

TINYINT_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

TINYINT_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

TINYINT_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

TINYINT_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

TINYINT_VILLAGE_OBJECT_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

Table - class org.apache.torque.engine.database.model.Table.

Data about a table used in an application.

Table() - Constructor for class org.apache.torque.engine.database.model.Table

Default Constructor

Table(String) - Constructor for class org.apache.torque.engine.database.model.Table

Constructs a table object with a name

Token - class org.apache.torque.engine.sql.Token.

A single token returned by SQLScanner.

Token(String) - Constructor for class org.apache.torque.engine.sql.Token

Creates a new token without positioning.

Token(String, int, int) - Constructor for class org.apache.torque.engine.sql.Token

Creates a new token with positioning settings.

TorqueDataDumpTask - class org.apache.torque.task.TorqueDataDumpTask.

An extended Texen task used for dumping data from db into XML

TorqueDataDumpTask() - Constructor for class org.apache.torque.task.TorqueDataDumpTask

TorqueDataDumpTask.TableTool - class org.apache.torque.task.TorqueDataDumpTask.TableTool.

A nasty do-it-all tool class.

TorqueDataDumpTask.TableTool() - Constructor for class org.apache.torque.task.TorqueDataDumpTask.TableTool

Constructor for the TableTool object

TorqueDataDumpTask.TableTool(QueryDataSet) - Constructor for class org.apache.torque.task.TorqueDataDumpTask.TableTool

Constructor for the TableTool object

TorqueDataModelTask - class org.apache.torque.task.TorqueDataModelTask.

A base torque task that uses either a single XML schema representing a data model, or a <fileset> of XML schemas.

TorqueDataModelTask() - Constructor for class org.apache.torque.task.TorqueDataModelTask

TorqueDataSQLTask - class org.apache.torque.task.TorqueDataSQLTask.

An extended Texen task used for generating SQL source from an XML data file

TorqueDataSQLTask() - Constructor for class org.apache.torque.task.TorqueDataSQLTask

TorqueDocumentationTask - class org.apache.torque.task.TorqueDocumentationTask.

An ant task for generating output by using Velocity

TorqueDocumentationTask() - Constructor for class org.apache.torque.task.TorqueDocumentationTask

TorqueJDBCTransformTask - class org.apache.torque.task.TorqueJDBCTransformTask.

This class generates an XML schema of an existing database from JDBC metadata.

TorqueJDBCTransformTask() - Constructor for class org.apache.torque.task.TorqueJDBCTransformTask

TorqueSQLExec - class org.apache.torque.task.TorqueSQLExec.

This task uses an SQL -> Database map in the form of a properties file to insert each SQL file listed into its designated database.

TorqueSQLExec() - Constructor for class org.apache.torque.task.TorqueSQLExec

TorqueSQLExec.DelimiterType - class org.apache.torque.task.TorqueSQLExec.DelimiterType.

TorqueSQLExec.DelimiterType() - Constructor for class org.apache.torque.task.TorqueSQLExec.DelimiterType

TorqueSQLExec.OnError - class org.apache.torque.task.TorqueSQLExec.OnError.

Enumerated attribute with the values "continue", "stop" and "abort" for the onerror attribute.

TorqueSQLExec.OnError() - Constructor for class org.apache.torque.task.TorqueSQLExec.OnError

TorqueSQLExec.Transaction - class org.apache.torque.task.TorqueSQLExec.Transaction.

Contains the definition of a new transaction element.

TorqueSQLExec.Transaction() - Constructor for class org.apache.torque.task.TorqueSQLExec.Transaction

TorqueSQLTask - class org.apache.torque.task.TorqueSQLTask.

An extended Texen task used for generating SQL source from an XML schema describing a database structure.

TorqueSQLTask() - Constructor for class org.apache.torque.task.TorqueSQLTask

TorqueSQLTransformTask - class org.apache.torque.task.TorqueSQLTransformTask.

An ant task for creating an xml schema from an sql schema

TorqueSQLTransformTask() - Constructor for class org.apache.torque.task.TorqueSQLTransformTask

TypeMap - class org.apache.torque.engine.database.model.TypeMap.

A class that maps JDBC types to their corresponding Java object types, and Java native types.

TypeMap() - Constructor for class org.apache.torque.engine.database.model.TypeMap

toString() - Method in class org.apache.torque.engine.database.model.AppData

Creats a string representation of this AppData.

toString() - Method in class org.apache.torque.engine.database.model.Column

String representation of the column.

toString() - Method in class org.apache.torque.engine.database.model.Database

Creats a string representation of this Database.

toString() - Method in class org.apache.torque.engine.database.model.ForeignKey

String representation of the foreign key.

toString() - Method in class org.apache.torque.engine.database.model.IdMethodParameter

XML representation of the foreign key.

toString() - Method in class org.apache.torque.engine.database.model.Index

String representation of the index.

toString() - Method in class org.apache.torque.engine.database.model.Inheritance

String representation of the foreign key.

toString() - Method in class org.apache.torque.engine.database.model.Table

Returns a XML representation of this table.

toString() - Method in class org.apache.torque.engine.database.model.Unique

String representation of the index.

toString() - Method in class org.apache.torque.engine.sql.Token

The same as getStr()

U

Unique - class org.apache.torque.engine.database.model.Unique.

Information about unique columns of a table.

Unique() - Constructor for class org.apache.torque.engine.database.model.Unique

underscoreMethod(String) - Method in class org.apache.torque.engine.database.model.JavaNameGenerator

Converts a database schema name to java object name.

V

VARBINARY - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARBINARY_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARBINARY_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARBINARY_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARBINARY_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARCHAR - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARCHAR_NATIVE_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARCHAR_OBJECT_TYPE - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARCHAR_PP_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

VARCHAR_VILLAGE_METHOD - Static variable in class org.apache.torque.engine.database.model.TypeMap

W

WEB_SITE_DTD - Static variable in class org.apache.torque.engine.database.transform.DTDResolver

Where the DTD is located on the web.

X

XmlToAppData - class org.apache.torque.engine.database.transform.XmlToAppData.

A Class that is used to parse an input xml schema file and creates an AppData java structure.

XmlToAppData(String, String, String) - Constructor for class org.apache.torque.engine.database.transform.XmlToAppData

Creates a new instance for the specified database type.

XmlToData - class org.apache.torque.engine.database.transform.XmlToData.

A Class that is used to parse an input xml schema file and creates and AppData java structure.

XmlToData(Database, String) - Constructor for class org.apache.torque.engine.database.transform.XmlToData

Default custructor

XmlToData.ColumnValue - class org.apache.torque.engine.database.transform.XmlToData.ColumnValue.

XmlToData.ColumnValue(Column, String) - Constructor for class org.apache.torque.engine.database.transform.XmlToData.ColumnValue

XmlToData.DataRow - class org.apache.torque.engine.database.transform.XmlToData.DataRow.

XmlToData.DataRow(Table, List) - Constructor for class org.apache.torque.engine.database.transform.XmlToData.DataRow

xmlFile - Variable in class org.apache.torque.task.TorqueDataModelTask

XML that describes the database model, this is transformed into the application model object.

xmlSchema - Variable in class org.apache.torque.task.TorqueJDBCTransformTask

Name of XML database schema produced.

A B C D E F G H I J L M N O P R S T U V W X