Package org.eclipse.persistence.platform.database

Class SymfowarePlatform

  • All Implemented Interfaces:
    Serializable, Cloneable, CorePlatform<ConversionManager>, Platform
    public class SymfowarePlatform
extends DatabasePlatform
    Symfoware Server
    http://wiki.eclipse.org/EclipseLink/Development/Incubator/Extensions/SymfowarePlatform
    Test results: http://wiki.eclipse.org/EclipseLink/Development/DatabasePlatform/SymfowarePlatform/TestResults
    Contributed by: Fujitsu Ltd.
    Contributed under bug: 288715

    Developed on Symfoware Server V10
    Initial SRG Passes on Symfoware Server V10

    Feature Testing
    ----------------------

    • DDL Generation - Succeeds
    • Outer Join - Succeeds
    • Subquery - Succeeds with Limitations
    • Stored Procedure Calls - Succeeds
    • Stored Procedure Generation - Succeeds
    • Native Sequences/Identifier fields - Succeeds
    • JPA Bulk Update/Delete - Succeeds with Limitations
    • Batch Reading - Succeeds
    • Batch Writing - Succeeds
    • Pessimistic Locking - Succeeds with Limitations
    • First Result/Limit - Succeeds with Limitations
    • Expression Framework - Succeeds with Limitations
    • Delimiters - Succeeds
    • Auto Detection - Succeeds

    Limitations
    ----------------

    • Reserved SQL keywords cannot be used as table, column or sequence names. Use a different name, or enclose the name in double quotes. For example: @Column(name="\"LANGUAGE\"")
    • Spaces cannot be used in table, column or sequence names. (bug 304906)
    • Input parameters cannot be used as first two arguments to the LOCATE function at the same time. (bug 304897)
    • The first argument to the SUBSTRING function cannot be an input parameter. (bug 304897)
    • Input parameters cannot be used as adjacent arguments to the CONCAT function. Concatenate the values in Java code first and pass the result to the query instead. (bug 304897)
    • Input parameters cannot be used at both sides of an operand at the same time in an SQL statement (e.g. '? * ?'). Perform the operation in Java code first and pass the result to the query instead.
    • Identity fields cannot be used. When primary key generation type IDENTITY is specified, a database sequence will be used instead.
    • Pessimistic Locking adds 'FOR UPDATE' to the SELECT statement, and cannot be used with queries that use DISTINCT. (bug 304903)
    • Pessimistic Locking cannot be used with queries that select from multiple tables. (bug 304903)
    • The LockNoWait option of Pessimistic Locking cannot be used; it is ignored when specified (i.e. only 'FOR UPDATE' is added to the SELECT statement).
    • Query timeout cannot be used; the timeout value is silently ignored. (bug 304905)
    • Bulk update and delete operations that require multiple tables to be accessed cannot be used (e.g. bulk operation on an entity that is part of an inheritance hierarchy, UpdateAll and DeleteAll queries). (See bug 298193).
    • Dropping of tables, sequences and procedures while the database connection is still open can fail due to unreleased locks. Shut down the Java process that executed the create operation before performing the drop operation, or have the create operation use an unpooled connection that is closed after use (GlassFish's deploy-time table generation function uses an unpooled connection).
    • The standard deviation (STDDEV) and variance (VARIANCE) functions cannot be used. (bug 304909)
    • '= NULL' and '<> NULL' cannot be used for null comparisons in the WHERE clause. Use 'IS (NOT) NULL' instead.
    • A scrollable cursor policy of CONCUR_UPDATABLE mode cannot be used with queries that select from multiple tables.
    • Columns and literals of different type may need casting to allow them to be compared or assigned. (bug 372178) For example: 'SELECT ... WHERE CAST(PHONE_ORDER_VARCHAR AS INTEGER) BETWEEN 0 AND 1'
    • Subqueries with joins to the outer query are not supported. (see rfe 298193)
    • Stored functions are not supported. (bug 342409)
    • Using subquery in select list for query specification or single-row SELECT statement is not allowed. (bug 372172)
    • The CascadeOnDelete doesn't work on a relation where CascadeType.Remove or CascadeType.All is specified. (bug 342413)
    • A subquery cannot be specified on both sides of a comparison predicate or a quantified predicate. (bug 378313)
    • A base table name to be updated cannot be identical to table name in from clause in query or subquery specification (bug 381302)

    Additional Notes
    ----------------

    • When using DDL generation, indices are automatically generated for primary and unique keys.
    • The MOD(x, y) function is executed as 'CASE WHEN y = 0 THEN x ELSE (x - y * TRUNC( x / y )) END' on Symfoware database, which gives the same result as the MOD function on Oracle database. Input parameters cannot be used for both its arguments at the same time. In such case, calculate the modulus in Java code first and pass the result to the query instead.
    • When input parameters are used as arguments to the TRIM function, they are substituted with their values before the SQL statement is sent to the JDBC driver.
    • When an input parameter is used as argument to the UPPER, LOWER or LENGTH functions, it is substituted with its value before the SQL statement is sent to the JDBC driver.

    Since:
    EclipseLink 2.1
    Author:
    Dies Koper, Wu Jie
    See Also:
    Serialized Form

    • Constructor Detail

      • SymfowarePlatform

        public SymfowarePlatform()

    • Method Detail

      • appendTimestamp

        protected void appendTimestamp​(Timestamp timestamp,
                               Writer writer)
                        throws IOException
        Appends a TimeStamp in Symfoware specific format.
        Note that Symfoware does not support the milli- and nanoseconds.
        Symfoware: TIMESTAMP'YYYY-MM-DD hh:mm:ss'
        Overrides:
        appendTimestamp in class DatabasePlatform
        Throws:
        IOException

      • appendCalendar

        protected void appendCalendar​(Calendar calendar,
                              Writer writer)
                       throws IOException
        Write a Calendar in Symfoware specific format.
        Note that Symfoware does not support nanoseconds.
        Symfoware: CNV_TIMESTAMP(calendar, 'YYYY-MM-DD hh24:mm:ss')
        Overrides:
        appendCalendar in class DatabasePlatform
        Throws:
        IOException

      • buildFieldTypes

        protected Hashtable<Class<?>,​FieldTypeDefinition> buildFieldTypes()
        Return the mapping of Java class types to database types for the schema framework.
        Overrides:
        buildFieldTypes in class DatabasePlatform
        Returns:
        hashtable of Java types to FieldTypeDefinition instances containing Symfoware SQL types.

      • addNonBindingOperator

        protected void addNonBindingOperator​(ExpressionOperator operator)
        Symfoware does not support the use of parameters in certain functions.
        This adds the operator and disables binding support at the same time.
        See Also:
        DatasourcePlatform.addOperator(ExpressionOperator), ExpressionOperator#setIsBindingSupported(boolean)

      • isDynamicSQLRequiredForFunctions

        public boolean isDynamicSQLRequiredForFunctions()
        Symfoware does not support the use of multiple parameters in certain functions.
        This allows statements to disable binding only in these cases.
        Overrides:
        isDynamicSQLRequiredForFunctions in class DatabasePlatform

      • isForUpdateCompatibleWithDistinct

        public boolean isForUpdateCompatibleWithDistinct()
        Indicates whether SELECT DISTINCT ... FOR UPDATE is allowed by the platform. (Symfoware doesn't allow this).
        Overrides:
        isForUpdateCompatibleWithDistinct in class DatabasePlatform

      • length

        protected static ExpressionOperator length()
        Obtains the number of characters in the data string value expression.
        Builds Symfoware equivalent to length(string_exp).
        Symfoware: CHAR_LENGTH(string_exp)
        Returns:
        the defined expression operator.

      • charLength

        protected static ExpressionOperator charLength()
        Obtains the number of characters in the data string value expression.
        Builds Symfoware equivalent to length(string_exp).
        Symfoware: CHAR_LENGTH(string_exp)
        Returns:
        the defined expression operator.

      • locate

        protected static ExpressionOperator locate()
        Evaluates the location of the "tofind" text within the string_exp text.
        Builds Symfoware equivalent to locate(string_exp, tofind).
        Symfoware: POSITION(tofind IN string_exp)
        Returns:
        the defined expression operator.

      • locate2

        protected static ExpressionOperator locate2()
        Evaluates the location of the "tofind" text within the "string_exp" text, starting from the given start position.
        Builds Symfoware equivalent to locate(string_exp, tofind, startpos).
        Symfoware: LOCATE(tofind IN string_exp, startpos)
        Returns:
        the defined expression operator.

      • logOperator

        protected static ExpressionOperator logOperator()
        Returns the log10 operator.
        Builds Symfoware equivalent to LOG(x).
        Symfoware: (LN(x)/LN(10))
        Returns:
        the defined expression operator.

      • leftTrim

        protected static ExpressionOperator leftTrim()
        Returns the string left trimmed for white space.
        Builds Symfoware equivalent to LTRIM(string_exp).
        Symfoware: TRIM(LEADING FROM string_exp)
        Returns:
        the defined expression operator.

      • leftTrim2

        protected static ExpressionOperator leftTrim2()
        Returns the string left trimmed for white space.
        Builds Symfoware equivalent to LTRIM(string_exp, character).
        Symfoware: TRIM(LEADING character FROM string_exp)
        Returns:
        the defined expression operator.

      • mod

        protected static ExpressionOperator mod()
        Returns the remainder of a division.
        Builds Symfoware equivalent to Oracle's MOD(x, y).
        Note that it returns x when y is 0, and the sign of the remainder is taken from x. Symfoware: CASE WHEN y = 0 THEN x ELSE (x - y * TRUNC( x / y )) END
        Returns:
        the defined expression operator.

      • rightTrim

        protected static ExpressionOperator rightTrim()
        Returns the string right trimmed for white space.
        Builds Symfoware equivalent to RTRIM(character).
        Symfoware: TRIM(TRAILING FROM string_exp)
        Returns:
        the defined expression operator.

      • rightTrim2

        protected static ExpressionOperator rightTrim2()
        Returns the string right trimmed for white space.
        Builds Symfoware equivalent to RTRIM(string_exp, character).
        Symfoware: TRIM(TRAILING character FROM string_exp)
        Returns:
        the defined expression operator.

      • substring

        protected static ExpressionOperator substring()
        Gets the substring of source bounded by start location to end location.
        Builds Symfoware equivalent to SUBSTRING(string_exp, startpos, length).
        Symfoware: SUBSTRING(string_exp FROM startpos FOR length)
        Returns:
        the defined expression operator.

      • singleArgumentSubstring

        protected static ExpressionOperator singleArgumentSubstring()
        Gets the substring of a string starting from the specified start position.
        Builds Symfoware equivalent to SUBSTRING(string_exp, startpos).
        Symfoware: SUBSTRING(string_exp FROM startpos)
        Returns:
        the defined expression operator.

      • toNumber

        protected static ExpressionOperator toNumber()
        Returns the number converted from the string.
        Builds Symfoware equivalent to ToNumber(string_exp).
        Symfoware: CAST(string_exp AS SMALLINT)
        Returns:
        the defined expression operator.

      • instring

        protected static ExpressionOperator instring()
        Evaluates the location of the "tofind" text within the string_exp text.
        Builds Symfoware equivalent to Instring(string_exp, tofind).
        Symfoware: POSITION(tofind In string_exp)
        Returns:
        the defined expression operator.

      • monthsBetween

        protected static ExpressionOperator monthsBetween()
        Returns the decimal number of months between the two dates.
        Builds Symfoware equivalent to monthsBetween(Date, Date).
        Symfoware: SPAN_DATE(Date, Date, 'MONTH')
        Returns:
        the defined expression operator.

      • roundDate

        protected static ExpressionOperator roundDate()
        Returns the date rounded to the year, month or day.
        Builds Symfoware equivalent to ROUNDDATE(Date, rounded).
        Symfoware: ROUND_DATE(Date, rounded)
        Returns:
        the defined expression operator.

      • toDate

        protected static ExpressionOperator toDate()
        Converts the character value expression of the conversion source to the DATE type in accordance.
        Builds Symfoware equivalent to toDate(Date, format).
        Symfoware: CNV_DATE(Date, 'YYYY-MM-DD')
        Returns:
        the defined expression operator.

      • addDate

        protected static ExpressionOperator addDate()
        Adds to a date the specified addition number as the specified interval unit and returns the resulting date.
        Builds Symfoware equivalent to addDate(unit, number).
        Symfoware: ADD_DATE(date, number, unit)
        Returns:
        the defined expression operator.

      • truncateDate

        protected static ExpressionOperator truncateDate()
        Truncates a date by using the truncating unit.
        Builds Symfoware equivalent to truncateDate(date, unit).
        Symfoware: TRUNC_DATE(date, unit)
        Returns:
        the defined expression operator.

      • nvl

        protected static ExpressionOperator nvl()
        Substitute a value when a null value is encountered.
        Builds Symfoware equivalent to NVL(string, replace_with).
        Symfoware: COALESCE(string, replace_with)
        Returns:
        the defined expression operator.

      • greatest

        protected static ExpressionOperator greatest()
        Returns the greatest of two values.
        Builds Symfoware equivalent to GREATEST(x, y).
        Symfoware: CASE WHEN x >= y THEN x ELSE y END
        Returns:
        the defined expression operator.

      • least

        protected static ExpressionOperator least()
        Returns the smallest of two values.
        Builds Symfoware equivalent to LEAST(x, y).
        Symfoware: CASE WHEN x <= y THEN x ELSE y END
        Returns:
        the defined expression operator.

      • computeMaxRowsForSQL

        public int computeMaxRowsForSQL​(int firstResultIndex,
                                int maxResults)
        Use the JDBC maxResults and firstResultIndex setting to compute a value to use when limiting the results of a query in SQL. These limits tend to be used in two ways. 
         1. MaxRows is the index of the last row to be returned (like JDBC
 maxResults)
 2. MaxRows is the number of rows to be returned
        Symfoware uses case #2 and therefore the maxResults has to be altered based on the firstResultIndex.
        Overrides:
        computeMaxRowsForSQL in class DatabasePlatform
        See Also:
        MySQLPlatform

      • buildSelectQueryForSequenceObject

        public ValueReadQuery buildSelectQueryForSequenceObject​(String seqName,
                                                        Integer size)
        Produce a DataReadQuery which updates(!) the sequence number in the DB and returns it.
        Overrides:
        buildSelectQueryForSequenceObject in class DatasourcePlatform
        Parameters:
        seqName - known by Symfoware to be a defined sequence
        size - size of sequence
        Returns:
        ValueReadQuery class to perform a read of a single data value.

      • buildCreateIndex

        public String buildCreateIndex​(String fullTableName,
                               String indexName,
                               String qualifier,
                               boolean isUnique,
                               String... columnNames)
        Return the CREATE INDEX string for this platform.
        Overrides:
        buildCreateIndex in class DatabasePlatform
        Parameters:
        fullTableName - qualified name of the table the index is to be created on
        indexName - name of the index
        qualifier - qualifier to construct qualified name of index if needed
        isUnique - Indicates whether uniqe index is created
        columnNames - one or more columns the index is created for

      • buildDropIndex

        public String buildDropIndex​(String fullTableName,
                             String indexName,
                             String qualifier)
        Return the DROP INDEX string for this platform.
        Overrides:
        buildDropIndex in class DatabasePlatform
        Parameters:
        fullTableName - qualified name of the table the index is to be created on
        indexName - name of the index
        qualifier - qualifier to construct qualified name of index if needed

      • getCreateTempTableSqlSuffix

        protected String getCreateTempTableSqlSuffix()
        Returns the ending of the SQL string to create a temporary table.
        Symfoware V10 requires table space name and number of concurrent users.
        Maybe this will be implemented in the future, for now it invokes the super class's method.
        Overrides:
        getCreateTempTableSqlSuffix in class DatabasePlatform

      • getDefaultSequenceTableName

        public String getDefaultSequenceTableName()
        Returns the table name used by TableSequence by default. Symfoware does not allow reserved keyword 'SEQUENCE' as table name, so returns "SEQUENCE" (with double-quotes) instead.
        Overrides:
        getDefaultSequenceTableName in class DatabasePlatform

      • getIndexNamePrefix

        public String getIndexNamePrefix​(boolean isUniqueSetOnField)
        Used to allow platforms to define their own index prefixes
        Overrides:
        getIndexNamePrefix in class DatabasePlatform
        Parameters:
        isUniqueSetOnField -
        Returns:

      • getMaxFieldNameSize

        public int getMaxFieldNameSize()
        Returns the maximum number of single byte characters that can be used in a field name on this platform, assuming DEFAULT_DSI_NAME=CODE is specified in Symfoware's operating environment file for the system (see Symfoware manual).
        Overrides:
        getMaxFieldNameSize in class DatabasePlatform

      • minimumTimeIncrement

        public long minimumTimeIncrement()
        INTERNAL: Returns the minimum time increment supported by the platform.
        Overrides:
        minimumTimeIncrement in class DatabasePlatform

      • printSQLSelectStatement

        public void printSQLSelectStatement​(DatabaseCall call,
                                    ExpressionSQLPrinter printer,
                                    SQLSelectStatement statement)
        Print the pagination SQL using Symfoware syntax " WITH OPTION LIMIT ( <max>)". There is no equivalent to 'OFFSET'.
        Even though most performance benefit comes from including the offset in the SQL statement, for this platform the benefit of including LIMIT is that it allows pagination with result sets with scrollable cursors too (which the Symfoware JDBC driver's setMaxRows method does not support).
        Overrides:
        printSQLSelectStatement in class DatabasePlatform

      • requiresProcedureBrackets

        public boolean requiresProcedureBrackets()
        Used for stored procedure creation: Symfoware needs brackets around arguments declaration even if no arguments exist, and so returns true.
        Overrides:
        requiresProcedureBrackets in class DatabasePlatform

      • requiresUniqueConstraintCreationOnTableCreate

        public boolean requiresUniqueConstraintCreationOnTableCreate()
        Used for table creation. Symfoware does not support the ALTER TABLE syntax to add/drop unique constraints, but it does allow declaration of (single and multi-column) unique constraints as part of the CREATE TABLE statement.
        Overrides:
        requiresUniqueConstraintCreationOnTableCreate in class DatabasePlatform
        Returns:
        whether unique constraints should be declared as part of the CREATE TABLE statement instead of in separate ALTER TABLE ADD/DROP statements.

      • retrieveFirstPrimaryKeyOrOne

        public void retrieveFirstPrimaryKeyOrOne​(ReportQuery subselect)
        INTERNAL: Used by Exists queries because they just need to select a single row. In most databases, we will select one of the primary key fields. On Syfoware, there are situations where the key cannot be used. See: https://bugs.eclipse.org/bugs/show_bug.cgi?id=303396
        Overrides:
        retrieveFirstPrimaryKeyOrOne in class DatabasePlatform
        Parameters:
        subselect -
        See Also:
        SymfowarePlatform

      • shouldAlwaysUseTempStorageForModifyAll

        public boolean shouldAlwaysUseTempStorageForModifyAll()
        Symfoware does not support the default syntax generated for update-all and delete-all queries as they can include the same table in the FROM clause of the main and the sub-queries. However, the alternative of using global temporary tables leads to table locking issues, so returns false to prevent the use of global temporary tables.
        Overrides:
        shouldAlwaysUseTempStorageForModifyAll in class DatabasePlatform

      • shouldBindLiterals

        public boolean shouldBindLiterals()
        Allows platform to choose whether to bind literals in SQL statements or not.
        Literal binding is enabled for Symfoware in general. As a number of functions and operators have restrictions on the use of input parameters, it is disabled for those.
        Overrides:
        shouldBindLiterals in class DatabasePlatform
        See Also:
        isDynamicSQLRequiredForFunctions()

      • shouldCreateIndicesForPrimaryKeys

        public boolean shouldCreateIndicesForPrimaryKeys()
        Used for table creation. Symfoware needs an index to be created explicitly for columns with a primary key constraint.
        Overrides:
        shouldCreateIndicesForPrimaryKeys in class DatabasePlatform
        Returns:
        true: indices should be created during table generation

      • shouldCreateIndicesOnUniqueKeys

        public boolean shouldCreateIndicesOnUniqueKeys()
        Used for table creation. Symfoware needs an index to be created explicitly for columns with a unique constraint.
        Overrides:
        shouldCreateIndicesOnUniqueKeys in class DatabasePlatform
        Returns:
        true: indices should be created during table generation

      • shouldPrintInputTokenAtStart

        public boolean shouldPrintInputTokenAtStart()
        Used for stored procedure creation: Some platforms want to print prefix for INPUT arguments BEFORE NAME. If wanted, override and return true.
        Overrides:
        shouldPrintInputTokenAtStart in class DatabasePlatform

      • shouldPrintOutputTokenBeforeType

        public boolean shouldPrintOutputTokenBeforeType()
        This is required in the construction of the stored procedures with output parameters
        Overrides:
        shouldPrintOutputTokenBeforeType in class DatabasePlatform

      • shouldPrintOutputTokenAtStart

        public boolean shouldPrintOutputTokenAtStart()
        This is required in the construction of the stored procedures with output parameters
        Overrides:
        shouldPrintOutputTokenAtStart in class DatabasePlatform

      • shouldPrintStoredProcedureArgumentNameInCall

        public boolean shouldPrintStoredProcedureArgumentNameInCall()
        Symfoware stored procedure calls do not require the argument name be printed in the call string.
        E.g. call MyStoredProc(?) instead of call MyStoredProc(myvariable = ?)
        Overrides:
        shouldPrintStoredProcedureArgumentNameInCall in class DatabasePlatform

      • supportsANSIInnerJoinSyntax

        public boolean supportsANSIInnerJoinSyntax()
        Indicates whether the ANSI syntax for inner joins (e.g. SELECT FROM t1 JOIN t2 ON t1.pk = t2.fk) is supported by this platform. Symfoware does not.
        Overrides:
        supportsANSIInnerJoinSyntax in class DatabasePlatform

      • supportsForeignKeyConstraints

        public boolean supportsForeignKeyConstraints()
        Symfoware does not support foreign key constraint syntax, so returns false.
        Overrides:
        supportsForeignKeyConstraints in class DatabasePlatform

      • supportsIndividualTableLocking

        public boolean supportsIndividualTableLocking()
        Indicates whether locking clause could be selectively applied only to some tables in a ReadQuery.
        Symfoware platform currently only supports FOR UPDATE locking, which cannot be applied to queries that select from multiple tables. Use of other locking strategies (LOCK_MODE) are yet to be explored.
        Overrides:
        supportsIndividualTableLocking in class DatabasePlatform

      • supportsLockingQueriesWithMultipleTables

        public boolean supportsLockingQueriesWithMultipleTables()
        Indicates whether locking clause could be applied to the query that has more than one table.
        Symfoware platform currently only supports FOR UPDATE locking, which cannot be applied to queries that select from multiple tables. Use of other locking strategies (LOCK_MODE) are yet to be explored.
        Overrides:
        supportsLockingQueriesWithMultipleTables in class DatabasePlatform

      • supportsSequenceObjects

        public boolean supportsSequenceObjects()
        Indicates whether the platform supports sequence objects.
        Symfoware does through global sequence objects.
        Overrides:
        supportsSequenceObjects in class DatasourcePlatform

      • supportsStoredFunctions

        public boolean supportsStoredFunctions()
        Indicates whether the platform supports stored functions.
        Although Symfoware supports some stored functions as function routines, their functionality is incompatible with the one EclipseLink provides. So, return false;
        Overrides:
        supportsStoredFunctions in class DatabasePlatform