Package org.eclipse.persistence.platform.database.oracle.annotations

Annotation Type PLSQLTable

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface PLSQLTable
    A PLSQLTable annotation is used to define a database PLSQL TABLE type. This type can be used within PLSQL procedure calls.
    See Also:
    NamedPLSQLStoredProcedureQuery
    Author:
    James Sutherland
    Since:
    EclipseLink 2.3

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String compatibleType
      (Required) The name of the database VARRAY type that mirrors the table's structure.
      java.lang.String name
      (Required) The name of the record type in the database.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean isNestedTable
      (Optional) Indicates a non-associative (nested) table.
      java.lang.Class javaType
      (Optional) The Java Collection class to map the varray to.
      java.lang.String nestedType
      (Required) The name of the database OBJECT TYPE or VARRAY type that mirrors the record's structure.

    • Element Detail

      • name

        java.lang.String name
        (Required) The name of the record type in the database.

      • compatibleType

        java.lang.String compatibleType
        (Required) The name of the database VARRAY type that mirrors the table's structure. The table will be converted to/from this type so it can be passed through JDBC.

      • nestedType

        java.lang.String nestedType
        (Required) The name of the database OBJECT TYPE or VARRAY type that mirrors the record's structure. The record will be converted to/from this type so it can be passed through JDBC.
        Default:
        "VARCHAR_TYPE"

      • javaType

        java.lang.Class javaType
        (Optional) The Java Collection class to map the varray to. This can be any valid Collection implementation.
        Default:
        java.util.ArrayList.class

      • isNestedTable

        boolean isNestedTable
        (Optional) Indicates a non-associative (nested) table. This method would typically be used when generating a constructor for the collection in PL/SQL (as the constructors for associative arrays (Varray) and a non-associative (nested) tables differ).
        Default:
        false