org.datanucleus.store.rdbms.adapter
Class OracleAdapter

java.lang.Object
  org.datanucleus.store.rdbms.adapter.DatabaseAdapter
      org.datanucleus.store.rdbms.adapter.OracleAdapter

All Implemented Interfaces:

org.datanucleus.store.mapped.DatastoreAdapter, org.datanucleus.store.mapped.expression.ExpressionConversionAdapter, org.datanucleus.store.mapped.expression.ExpressionLogicSetAdapter, org.datanucleus.store.mapped.expression.ExpressionMethodAdapter, org.datanucleus.store.mapped.expression.ExpressionOperatorAdapter, org.datanucleus.store.mapped.expression.ExpressionPatternAdapter, RDBMSAdapter

public class OracleAdapter
extends DatabaseAdapter

Provides methods for adapting SQL language elements to the Oracle database.

See Also:

DatabaseAdapter

Field Summary

static java.lang.String	ORACLE_10_RESERVED_WORDS A string containing the list of Oracle keywords This list is normally obtained dynamically from the driver using DatabaseMetaData.getSQLKeywords() Based on database Oracle10g
static java.lang.String	ORACLE_8_RESERVED_WORDS A string containing the list of Oracle keywords This list is normally obtained dynamically from the driver using DatabaseMetaData.getSQLKeywords() Based on database Oracle8
static java.lang.String	ORACLE_9_RESERVED_WORDS A string containing the list of Oracle keywords This list is normally obtained dynamically from the driver using DatabaseMetaData.getSQLKeywords() Based on database Oracle9i

Fields inherited from class org.datanucleus.store.rdbms.adapter.DatabaseAdapter

catalogSeparator, datastoreMajorVersion, datastoreMinorVersion, datastoreProductName, datastoreProductVersion, datastoreRevisionVersion, driverMajorVersion, driverMinorVersion, driverName, driverVersion, identifierQuoteString, LOCALISER, LOCALISER_BASE, maxColumnNameLength, maxConstraintNameLength, maxIndexNameLength, maxTableNameLength, properties, reservedKeywords, supportedOptions

Fields inherited from interface org.datanucleus.store.rdbms.adapter.RDBMSAdapter

ACCESS_PARENTQUERY_IN_SUBQUERY, ALTER_TABLE_DROP_CONSTRAINT_SYNTAX, ALTER_TABLE_DROP_FOREIGN_KEY_CONSTRAINT, ANSI_JOIN_SYNTAX, AUTO_INCREMENT_COLUMN_TYPE_SPECIFICATION, AUTO_INCREMENT_KEYS_NULL_SPECIFICATION, BLOB_SET_USING_SETSTRING, CHAR_COLUMNS_PADDED_WITH_SPACES, CHECK_IN_CREATE_STATEMENTS, CHECK_IN_END_CREATE_STATEMENTS, CLOB_SET_USING_SETSTRING, CREATE_INDEXES_BEFORE_FOREIGN_KEYS, DATETIME_STORES_MILLISECS, DEFAULT_BEFORE_NULL_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_WITH_NOT_NULL_IN_COLUMN_OPTIONS, DEFERRED_CONSTRAINTS, DISTINCT_WITH_SELECT_FOR_UPDATE, EXISTS_SYNTAX, FK_DELETE_ACTION_CASCADE, FK_DELETE_ACTION_DEFAULT, FK_DELETE_ACTION_NULL, FK_DELETE_ACTION_RESTRICT, FK_UPDATE_ACTION_CASCADE, FK_UPDATE_ACTION_DEFAULT, FK_UPDATE_ACTION_NULL, FK_UPDATE_ACTION_RESTRICT, GET_GENERATED_KEYS_STATEMENT, INCLUDE_ORDERBY_COLS_IN_SELECT, LOCK_OPTION_PLACED_AFTER_FROM, LOCK_OPTION_PLACED_WITHIN_JOIN, LOCK_WITH_SELECT_FOR_UPDATE, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, ORDERBY_USING_SELECT_COLUMN_INDEX, PERSIST_OF_UNASSIGNED_CHAR, PRIMARYKEY_IN_CREATE_STATEMENTS, STATEMENT_BATCHING, TX_ISOLATION_NONE, TX_ISOLATION_READ_COMMITTED, TX_ISOLATION_READ_UNCOMMITTED, TX_ISOLATION_REPEATABLE_READ, TX_ISOLATION_SERIALIZABLE, UNION_SYNTAX, UNIQUE_IN_END_CREATE_STATEMENTS, USE_UNION_ALL, VIEWS

Fields inherited from interface org.datanucleus.store.mapped.DatastoreAdapter

ANALYSIS_METHODS, BIT_IS_REALLY_BOOLEAN, BOOLEAN_COMPARISON, CATALOGS_IN_TABLE_DEFINITIONS, ESCAPE_EXPRESSION_IN_LIKE_PREDICATE, IDENTIFIERS_LOWERCASE, IDENTIFIERS_LOWERCASE_QUOTED, IDENTIFIERS_MIXEDCASE, IDENTIFIERS_MIXEDCASE_QUOTED, IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE, IDENTIFIERS_MIXEDCASE_SENSITIVE, IDENTIFIERS_UPPERCASE, IDENTIFIERS_UPPERCASE_QUOTED, IDENTITY_COLUMNS, PROJECTION_IN_TABLE_REFERENCE_JOINS, SCHEMAS_IN_TABLE_DEFINITIONS, SEQUENCES

Constructor Summary

OracleAdapter(java.sql.DatabaseMetaData metadata)
Constructs an Oracle adapter based on the given JDBC metadata.

Method Summary

java.lang.String	getCatalogName(java.sql.Connection conn) Accessor for the Catalog Name for this datastore.
java.sql.ResultSet	getColumns(java.sql.Connection conn, java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String columnNamePattern) Accessor for table and column information for a catalog/schema in this datastore.
java.lang.String	getDatastoreDateStatement() Accessor for a statement that will return the statement to use to get the datastore date.
java.lang.String	getDropTableStatement(org.datanucleus.store.mapped.DatastoreContainerObject table) Method to return the drop table statement for Oracle.
java.sql.ResultSet	getExistingIndexes(java.sql.Connection conn, java.lang.String catalog, java.lang.String schema, java.lang.String table) Provide the existing indexes in the database for the table.
org.datanucleus.store.mapped.mapping.MappingManager	getMappingManager(org.datanucleus.store.mapped.MappedStoreManager storeMgr) Accessor for a MappingManager suitable for use with this datastore adapter.
java.lang.String	getNonAnsiInnerJoinWhereClause(java.lang.String col1, java.lang.String col2) Accessor for the WHERE clause to add to provide an INNER JOIN using non-ANSI syntax.
java.lang.String	getNonAnsiLeftOuterJoinWhereClause(java.lang.String col1, java.lang.String col2) Accessor for the WHERE clause to add to provide a LEFT OUTER JOIN using non-ANSI syntax.
java.lang.String	getNonAnsiRightOuterJoinWhereClause(java.lang.String col1, java.lang.String col2) Accessor for the WHERE clause to add to provide a LEFT OUTER JOIN using non-ANSI syntax.
org.datanucleus.store.mapped.expression.NumericExpression	getNumericExpressionForMethod(java.lang.String method, org.datanucleus.store.mapped.expression.ScalarExpression expr) Accessor for a numeric expression to represent the method call, with passed argument.
java.lang.String	getSchemaName(java.sql.Connection conn) Accessor for the Schema Name for this datastore.
java.lang.String	getSequenceCreateStmt(java.lang.String sequence_name, java.lang.String min, java.lang.String max, java.lang.String start, java.lang.String increment, java.lang.String cache_size) Accessor for the sequence statement to create the sequence.
java.lang.String	getSequenceNextStmt(java.lang.String sequence_name) Accessor for the statement for getting the next id from the sequence for this datastore.
java.lang.String	getSurrogateForEmptyStrings() Some databases, Oracle, treats an empty string (0 length) equals null
int	getTransactionIsolationForSchemaCreation() Accessor for the transaction isolation level to use during schema creation.
java.lang.String	getVendorID() Accessor for the vendor id
org.datanucleus.store.mapped.expression.NumericExpression	indexOfMethod(org.datanucleus.store.mapped.expression.ScalarExpression source, org.datanucleus.store.mapped.expression.ScalarExpression str, org.datanucleus.store.mapped.expression.NumericExpression from) Returns the appropriate SQL expression for the JDOQL String.indexOf() method.
void	initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler, org.datanucleus.ManagedConnection mconn) Initialise the types for this datastore.
org.datanucleus.store.mapped.expression.NumericExpression	modOperator(org.datanucleus.store.mapped.expression.ScalarExpression operand1, org.datanucleus.store.mapped.expression.ScalarExpression operand2) Method to generate a modulus expression.
org.datanucleus.store.mapped.expression.QueryExpression	newQueryStatement(org.datanucleus.store.mapped.DatastoreContainerObject table, org.datanucleus.store.mapped.DatastoreIdentifier rangeVar, org.datanucleus.ClassLoaderResolver clr) Accessor for a new query statement.
RDBMSColumnInfo	newRDBMSColumnInfo(java.sql.ResultSet rs) Method to create a column info for the current row.
SQLTypeInfo	newSQLTypeInfo(java.sql.ResultSet rs) Create a new SQL type info from the current row of the passed ResultSet.
org.datanucleus.store.mapped.expression.LogicSetExpression	newTableExpression(org.datanucleus.store.mapped.expression.QueryExpression qs, org.datanucleus.store.mapped.DatastoreContainerObject table, org.datanucleus.store.mapped.DatastoreIdentifier rangeVar) Returns a new TableExpression object appropriate for this DBMS.
org.datanucleus.store.mapped.expression.StringExpression	substringMethod(org.datanucleus.store.mapped.expression.StringExpression str, org.datanucleus.store.mapped.expression.NumericExpression begin) Returns the appropriate SQL expression for the JDOQL String.substring(str,begin) method.
org.datanucleus.store.mapped.expression.StringExpression	substringMethod(org.datanucleus.store.mapped.expression.StringExpression str, org.datanucleus.store.mapped.expression.NumericExpression begin, org.datanucleus.store.mapped.expression.NumericExpression end) Returns the appropriate SQL expression for the JDOQL String.substring(str,begin,end) method.

Methods inherited from class org.datanucleus.store.rdbms.adapter.DatabaseAdapter

addSQLTypeForJDBCType, cartersianProduct, concatOperator, endsWithMethod, getAdapterTime, getAddCandidateKeyStatement, getAddColumnStatement, getAddForeignKeyStatement, getAddPrimaryKeyStatement, getAutoIncrementKeyword, getAutoIncrementStmt, getCatalogSeparator, getCheckConstraintForValues, getConnection, getContinuationString, getCreateIndexStatement, getCreateTableStatement, getCurrentDateMethod, getCurrentTimeMethod, getCurrentTimestampMethod, getDatastoreIdentifierMaxLength, getDatastoreMajorVersion, getDatastoreMinorVersion, getDriverMajorVersion, getDriverMinorVersion, getDropViewStatement, getEscapeCharacter, getEscapedPatternExpression, getEscapePatternExpression, getIdentifierQuoteString, getInsertStatementForNoColumns, getMapping, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNewUUIDFunction, getNumericConversionFunction, getOperatorConcat, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getRangeByLimitSelectClause, getRangeByLimitWhereClause, getRangeByRowNumberColumn, getRequiredTransactionIsolationLevel, getSelectForUpdateText, getSelectNewUUIDStmt, getSelectWithLockOption, getSupportedOptions, getTime, getUnlimitedLengthPrecisionValue, getValueForProperty, initialiseDatastore, isIdentityFieldDataType, isKeyword, isReservedKeyword, isValidPrimaryKeyType, iteratorReservedWords, logConfiguration, lowerMethod, matchesMethod, newFKInfo, parseKeywordList, removeUnsupportedMappings, setProperties, startsWithMethod, supportsOption, supportsQueryFetchSize, supportsTransactionIsolation, toNumericExpression, toString, toStringExpression, toStringExpression, translateMethod, trimMethod, upperMethod

Methods inherited from class java.lang.Object

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

Field Detail

ORACLE_8_RESERVED_WORDS

public static final java.lang.String ORACLE_8_RESERVED_WORDS

A string containing the list of Oracle keywords This list is normally obtained dynamically from the driver using DatabaseMetaData.getSQLKeywords() Based on database Oracle8

See Also:

Constant Field Values

ORACLE_9_RESERVED_WORDS

public static final java.lang.String ORACLE_9_RESERVED_WORDS

A string containing the list of Oracle keywords This list is normally obtained dynamically from the driver using DatabaseMetaData.getSQLKeywords() Based on database Oracle9i

See Also:

Constant Field Values

ORACLE_10_RESERVED_WORDS

public static final java.lang.String ORACLE_10_RESERVED_WORDS

A string containing the list of Oracle keywords This list is normally obtained dynamically from the driver using DatabaseMetaData.getSQLKeywords() Based on database Oracle10g

See Also:

Constant Field Values

Constructor Detail

OracleAdapter

public OracleAdapter(java.sql.DatabaseMetaData metadata)

Constructs an Oracle adapter based on the given JDBC metadata.

Parameters:

metadata - the database metadata.

Method Detail

initialiseTypes

public void initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler,
                            org.datanucleus.ManagedConnection mconn)

Initialise the types for this datastore.

Specified by:

initialiseTypes in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

initialiseTypes in class DatabaseAdapter

Parameters:

handler - SchemaHandler that we initialise the types for

mconn - Managed connection to use

newSQLTypeInfo

public SQLTypeInfo newSQLTypeInfo(java.sql.ResultSet rs)

Description copied from interface: RDBMSAdapter

Create a new SQL type info from the current row of the passed ResultSet. Allows an adapter to override particular types where the JDBC driver is known to be buggy.

Specified by:

newSQLTypeInfo in interface RDBMSAdapter

Overrides:

newSQLTypeInfo in class DatabaseAdapter

Parameters:

rs - ResultSet

Returns:

The SQL type info

getMappingManager

public org.datanucleus.store.mapped.mapping.MappingManager getMappingManager(org.datanucleus.store.mapped.MappedStoreManager storeMgr)

Accessor for a MappingManager suitable for use with this datastore adapter.

Specified by:

getMappingManager in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

getMappingManager in class DatabaseAdapter

Parameters:

storeMgr - The StoreManager

Returns:

the MappingManager

getVendorID

public java.lang.String getVendorID()

Accessor for the vendor id

Specified by:

getVendorID in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

getVendorID in class DatabaseAdapter

Returns:

The Oracle vendor id

getSurrogateForEmptyStrings

public java.lang.String getSurrogateForEmptyStrings()

Some databases, Oracle, treats an empty string (0 length) equals null

Specified by:

getSurrogateForEmptyStrings in interface RDBMSAdapter

Overrides:

getSurrogateForEmptyStrings in class DatabaseAdapter

Returns:

returns a surrogate to replace the empty string in the database otherwise it would be treated as null

getCatalogName

public java.lang.String getCatalogName(java.sql.Connection conn)
                                throws java.sql.SQLException

Description copied from class: DatabaseAdapter

Accessor for the Catalog Name for this datastore.

Specified by:

getCatalogName in interface RDBMSAdapter

Overrides:

getCatalogName in class DatabaseAdapter

Parameters:

conn - Connection to the datastore

Returns:

null, because oracle does not have catalogs

Throws:

java.sql.SQLException - Thrown if error occurs in determining the catalog name.

getSchemaName

public java.lang.String getSchemaName(java.sql.Connection conn)
                               throws java.sql.SQLException

Description copied from class: DatabaseAdapter

Accessor for the Schema Name for this datastore.

Specified by:

getSchemaName in interface RDBMSAdapter

Overrides:

getSchemaName in class DatabaseAdapter

Parameters:

conn - Connection to the datastore

Returns:

The schema name

Throws:

java.sql.SQLException - Thrown if error occurs in determining the schema name.

getNonAnsiInnerJoinWhereClause

public java.lang.String getNonAnsiInnerJoinWhereClause(java.lang.String col1,
                                                       java.lang.String col2)

Accessor for the WHERE clause to add to provide an INNER JOIN using non-ANSI syntax.

Specified by:

getNonAnsiInnerJoinWhereClause in interface RDBMSAdapter

Overrides:

getNonAnsiInnerJoinWhereClause in class DatabaseAdapter

Parameters:

col1 - The main datastore column

col2 - The secondary column to join to

Returns:

The Inner Join WHERE clause.

getNonAnsiLeftOuterJoinWhereClause

public java.lang.String getNonAnsiLeftOuterJoinWhereClause(java.lang.String col1,
                                                           java.lang.String col2)

Accessor for the WHERE clause to add to provide a LEFT OUTER JOIN using non-ANSI syntax.

Specified by:

getNonAnsiLeftOuterJoinWhereClause in interface RDBMSAdapter

Overrides:

getNonAnsiLeftOuterJoinWhereClause in class DatabaseAdapter

Parameters:

col1 - The main datastore column

col2 - The secondary column to join to

Returns:

The Left Outer Join WHERE clause.

getNonAnsiRightOuterJoinWhereClause

public java.lang.String getNonAnsiRightOuterJoinWhereClause(java.lang.String col1,
                                                            java.lang.String col2)

Accessor for the WHERE clause to add to provide a LEFT OUTER JOIN using non-ANSI syntax.

Overrides:

getNonAnsiRightOuterJoinWhereClause in class DatabaseAdapter

Parameters:

col1 - The main datastore column

col2 - The secondary column to join to

Returns:

The Left Outer Join WHERE clause.

getExistingIndexes

public java.sql.ResultSet getExistingIndexes(java.sql.Connection conn,
                                             java.lang.String catalog,
                                             java.lang.String schema,
                                             java.lang.String table)
                                      throws java.sql.SQLException

Provide the existing indexes in the database for the table. This is implemented if and only if the datastore has its own way of getting indexes. In this implementation we provide an alternate method for Oracle JDBC driver < 10.2.0.1.0 only. All other versions of Oracle will use the default. The schemaName MUST BE PROVIDED.

Specified by:

getExistingIndexes in interface RDBMSAdapter

Overrides:

getExistingIndexes in class DatabaseAdapter

Parameters:

conn - the JDBC connection

catalog - the catalog name

schema - the schema name.

table - the table name

Returns:

a ResultSet with the format @see DatabaseMetaData#getIndexInfo(java.lang.String, java.lang.String, java.lang.String, boolean, boolean)

Throws:

java.sql.SQLException

getDropTableStatement

public java.lang.String getDropTableStatement(org.datanucleus.store.mapped.DatastoreContainerObject table)

Method to return the drop table statement for Oracle.

Specified by:

getDropTableStatement in interface RDBMSAdapter

Overrides:

getDropTableStatement in class DatabaseAdapter

Parameters:

table - The table

Returns:

The statement text

getSequenceCreateStmt

public java.lang.String getSequenceCreateStmt(java.lang.String sequence_name,
                                              java.lang.String min,
                                              java.lang.String max,
                                              java.lang.String start,
                                              java.lang.String increment,
                                              java.lang.String cache_size)

Accessor for the sequence statement to create the sequence.

Specified by:

getSequenceCreateStmt in interface RDBMSAdapter

Overrides:

getSequenceCreateStmt in class DatabaseAdapter

Parameters:

sequence_name - Name of the sequence

min - Minimum value for the sequence

max - Maximum value for the sequence

start - Start value for the sequence

increment - Increment value for the sequence

cache_size - Cache size for the sequence

Returns:

The statement for getting the next id from the sequence

getSequenceNextStmt

public java.lang.String getSequenceNextStmt(java.lang.String sequence_name)

Accessor for the statement for getting the next id from the sequence for this datastore.

Specified by:

getSequenceNextStmt in interface RDBMSAdapter

Overrides:

getSequenceNextStmt in class DatabaseAdapter

Parameters:

sequence_name - Name of the sequence

Returns:

The statement for getting the next id for the sequence

newRDBMSColumnInfo

public RDBMSColumnInfo newRDBMSColumnInfo(java.sql.ResultSet rs)

Method to create a column info for the current row. Overrides the dataType to cater for Oracle particularities.

Specified by:

newRDBMSColumnInfo in interface RDBMSAdapter

Overrides:

newRDBMSColumnInfo in class DatabaseAdapter

Parameters:

rs - ResultSet from DatabaseMetaData.getColumns()

Returns:

column info

getTransactionIsolationForSchemaCreation

public int getTransactionIsolationForSchemaCreation()

Accessor for the transaction isolation level to use during schema creation.

Specified by:

getTransactionIsolationForSchemaCreation in interface RDBMSAdapter

Overrides:

getTransactionIsolationForSchemaCreation in class DatabaseAdapter

Returns:

The transaction isolation level for schema generation process

getColumns

public java.sql.ResultSet getColumns(java.sql.Connection conn,
                                     java.lang.String catalog,
                                     java.lang.String schema,
                                     java.lang.String table,
                                     java.lang.String columnNamePattern)
                              throws java.sql.SQLException

Accessor for table and column information for a catalog/schema in this datastore. An override for the DatabaseMetaData.getColumns() method call as referenced in superclass. The default Oracle-provided getColumns() method is VERY slow for large schemas, particularly due to REMARKS and COLUMN_DEF (column defaults) columns (outer-joins in data dictionary views) Note: This method DOES NOT return default column value (meta-data ResultSet column COLUMN_DEF) as this column causes MAJOR slowdown in meta-data retrieval performance.

Specified by:

getColumns in interface RDBMSAdapter

Overrides:

getColumns in class DatabaseAdapter

Parameters:

conn - Connection to use

catalog - The catalog (null if none)

schema - The schema (null if none)

table - The table (null if all)

columnNamePattern - Col name(s) (null if all) NOT USED

Returns:

ResultSet containing the table/column information

Throws:

java.sql.SQLException - Thrown if an error occurs

getDatastoreDateStatement

public java.lang.String getDatastoreDateStatement()

Accessor for a statement that will return the statement to use to get the datastore date.

Specified by:

getDatastoreDateStatement in interface RDBMSAdapter

Overrides:

getDatastoreDateStatement in class DatabaseAdapter

Returns:

SQL statement to get the datastore date

newQueryStatement

public org.datanucleus.store.mapped.expression.QueryExpression newQueryStatement(org.datanucleus.store.mapped.DatastoreContainerObject table,
                                                                                 org.datanucleus.store.mapped.DatastoreIdentifier rangeVar,
                                                                                 org.datanucleus.ClassLoaderResolver clr)

Accessor for a new query statement.

Specified by:

newQueryStatement in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

newQueryStatement in class DatabaseAdapter

Parameters:

table - The table to query

rangeVar - A range variable for the query

clr - The ClassLoaderResolver

Returns:

The Query Statement

newTableExpression

public org.datanucleus.store.mapped.expression.LogicSetExpression newTableExpression(org.datanucleus.store.mapped.expression.QueryExpression qs,
                                                                                     org.datanucleus.store.mapped.DatastoreContainerObject table,
                                                                                     org.datanucleus.store.mapped.DatastoreIdentifier rangeVar)

Description copied from class: DatabaseAdapter

Returns a new TableExpression object appropriate for this DBMS. This should be an instance of one of the three built-in styles of table expression:

• TableExprAsJoins
• TableExprAsSubjoins
• TableExprAsSubquery

TableExprAsSubjoins is the default, which arguably produces the most readable SQL but doesn't work on all DBMS's. TableExprAsSubjoins should work anywhere, but may be less efficient.

Specified by:

newTableExpression in interface RDBMSAdapter

Overrides:

newTableExpression in class DatabaseAdapter

Parameters:

qs - The query statement in which the table expression will be included.

table - The main table in the expression.

rangeVar - The SQL alias, or "range variable", to assign to the expression or to the main table.

Returns:

The expression

getNumericExpressionForMethod

public org.datanucleus.store.mapped.expression.NumericExpression getNumericExpressionForMethod(java.lang.String method,
                                                                                               org.datanucleus.store.mapped.expression.ScalarExpression expr)

Accessor for a numeric expression to represent the method call, with passed argument.

Specified by:

getNumericExpressionForMethod in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

getNumericExpressionForMethod in class DatabaseAdapter

Parameters:

method - The method (case insensitive)

expr - The argument to the method

Returns:

The numeric expression that results

substringMethod

public org.datanucleus.store.mapped.expression.StringExpression substringMethod(org.datanucleus.store.mapped.expression.StringExpression str,
                                                                                org.datanucleus.store.mapped.expression.NumericExpression begin)

Description copied from class: DatabaseAdapter

Returns the appropriate SQL expression for the JDOQL String.substring(str,begin) method. It should return something like:

 SUBSTRING(str FROM begin)
 

Note that the value of begin is base 0(Java-style), while most SQL string functions use base 1.

Specified by:

substringMethod in interface org.datanucleus.store.mapped.expression.ExpressionMethodAdapter

Overrides:

substringMethod in class DatabaseAdapter

Parameters:

str - The first argument to the substring() method.

begin - The second argument to the substring() method.

Returns:

The text of the SQL expression.

substringMethod

public org.datanucleus.store.mapped.expression.StringExpression substringMethod(org.datanucleus.store.mapped.expression.StringExpression str,
                                                                                org.datanucleus.store.mapped.expression.NumericExpression begin,
                                                                                org.datanucleus.store.mapped.expression.NumericExpression end)

Description copied from class: DatabaseAdapter

Returns the appropriate SQL expression for the JDOQL String.substring(str,begin,end) method. It should return something like:

 SUBSTRING(str FROM begin FOR len)
 

Note that the value of begin is base 0 (Java-style), while most SQL string functions use base 1. Note also that an end position is given, while most SQL substring functions take a length.

Specified by:

substringMethod in interface org.datanucleus.store.mapped.expression.ExpressionMethodAdapter

Overrides:

substringMethod in class DatabaseAdapter

Parameters:

str - The first argument to the substring() method.

begin - The second argument to the substring() method.

end - The third argument to the substring() method.

Returns:

The text of the SQL expression.

modOperator

public org.datanucleus.store.mapped.expression.NumericExpression modOperator(org.datanucleus.store.mapped.expression.ScalarExpression operand1,
                                                                             org.datanucleus.store.mapped.expression.ScalarExpression operand2)

Method to generate a modulus expression. The binary % operator is said to yield the remainder of its operands from an implied division; the left-hand operand is the dividend and the right-hand operand is the divisor. This returns MOD(expr1, expr2).

Specified by:

modOperator in interface org.datanucleus.store.mapped.DatastoreAdapter

Specified by:

modOperator in interface org.datanucleus.store.mapped.expression.ExpressionOperatorAdapter

Overrides:

modOperator in class DatabaseAdapter

Parameters:

operand1 - the left expression

operand2 - the right expression

Returns:

The Expression for modulus

indexOfMethod

public org.datanucleus.store.mapped.expression.NumericExpression indexOfMethod(org.datanucleus.store.mapped.expression.ScalarExpression source,
                                                                               org.datanucleus.store.mapped.expression.ScalarExpression str,
                                                                               org.datanucleus.store.mapped.expression.NumericExpression from)

Returns the appropriate SQL expression for the JDOQL String.indexOf() method. It should return something like:

 INSTR(str, substr [,pos])-1
 

since INSTR returns the first character as position 1. Similarly the "pos" is based on the first position being 1.

Specified by:

indexOfMethod in interface org.datanucleus.store.mapped.expression.ExpressionMethodAdapter

Overrides:

indexOfMethod in class DatabaseAdapter

Parameters:

source - The expression we want to search.

str - The argument to the indexOf() method.

from - The from position

Returns:

The text of the SQL expression.