org.openmdx.compatibility.base.dataprovider.layer.persistence.jdbc
Class LayerConfigurationEntries

java.lang.Object
  org.openmdx.compatibility.base.dataprovider.cci.SharedConfigurationEntries
      org.openmdx.compatibility.base.dataprovider.layer.persistence.common.CommonConfigurationEntries
          org.openmdx.compatibility.base.dataprovider.layer.persistence.jdbc.LayerConfigurationEntries

public class LayerConfigurationEntries
extends CommonConfigurationEntries

The PersistenceLayerConfigurationEntries class contains constants identifying the configuration entries of the dataprovider's persistence layer.

Field Summary

static String	ALLOWS_SQL_SEQUENCE_FALLBACK ALLOWS_SQL_SEQUENCE_FALLBACK is set to true, if plugin is allowed to fallback to supportSqlSequence=false mode automatically.
static String	AUTONUM_COLUMN Allows to specify an autonum column.
static String	BOOLEAN_FALSE The value corresponding to Boolean.FALSE, e.g.
static String	BOOLEAN_TRUE The value corresponding to Boolean.TRUE, e.g.
static String	BOOLEAN_TYPE The type used to store boolean values, i.e.
static String	BOOLEAN_TYPE_BOOLEAN
static String	BOOLEAN_TYPE_CHARACTER
static String	BOOLEAN_TYPE_NUMERIC
static String	BOOLEAN_TYPE_STANDARD Stands for the date type specified by the JDBC driver SQL property BOOLEAN.TYPE.STANDARD, i.e.
static String	BOOLEAN_TYPE_YN
static String	COLUMN_NAME_FROM COLUMN_NAME_FROM defines the corresponding 'from' column name for a (from-column-name,to-column-name) mapping.
static String	COLUMN_NAME_LONG Deprecated. COLUMN_NAME_LONG defines the corresponding long column name for a configured COLUMN_NAME_SHORT.
static String	COLUMN_NAME_SHORT Deprecated. COLUMN_NAME_SHORT defines the corresponding short column name for a configured COLUMN_NAME_LONG.
static String	COLUMN_NAME_TO COLUMN_NAME_TO defines the corresponding 'to' column name for a (from-column-name,to-column-name) mapping.
static String	CONNECTION_URL CONNECTION_URL jdbc url which is used to connect to database
static String	DATE_TYPE The type used to store org::w3c::date values, i.e.
static String	DATE_TYPE_CHARACTER Basic ISO 8601 date value, e.g.
static String	DATE_TYPE_DATE SQL DATE value
static String	DATE_TYPE_STANDARD Stands for the date type specified by the JDBC driver SQL property DATE.TYPE.STANDARD, i.e.
static String	DATETIME_TIMEZONE The time zone used to store org::w3c::dateTime values in case of TIMESTAMP WITH TIMEZONE database fields, e.g. UTC GMT+02:00 Europe/Zurich … Defaults to TimeZone.getDefault().getID() in absence of an entry.
static String	DATETIME_TYPE The type used to store org::w3c::dateTime values, i.e.
static String	DATETIME_TYPE_CHARACTER Basic ISO 8601 dateTime value, e.g.
static String	DATETIME_TYPE_NUMERIC Number of seconds that have passed since 1970-01-01 00:00:00.000 UTC
static String	DATETIME_TYPE_STANDARD Stands for the datetime type specified by the JDBC driver SQL property DATETIME.TYPE.STANDARD, i.e.
static String	DATETIME_TYPE_TIMESTAMP SQL TIMESTAMP value
static String	DATETIME_TYPE_TIMESTAMP_WITH_TIMEZONE SQL TIMESTAMP WITH TIMEZONE value
static String	DB_OBJECT 'dbObject' defines the primary table or view name of a database object for the specified type which is used for querying and updating objects.
static String	DB_OBJECT_2 'dbObject2' defines the optional secondary table or view name of a database object for the specified type which is used for querying and updating objects.
static String	DB_OBJECT_FOR_QUERY dbObjectForQuery defines the primary view name of a database object for a the specified type which is used for querying objects.
static String	DB_OBJECT_FOR_QUERY_2 dbObjectForQuery2 defines the optional secondary view name.
static String	DB_OBJECT_FORMAT DB_OBJECT_FORMAT defines the format of DB_OBJECT.
static String	DB_OBJECT_FORMAT_SLICED The sliced format of a DB_OBJECT contains an index-slice of an object in one row.
static String	DB_OBJECT_FORMAT_SLICED_NON_INDEXED The 'slicedNonIndexed' format of a DB_OBJECT contains one object in one row.
static String	DB_OBJECT_FORMAT_SLICED_NON_INDEXED_PARENT_RID_ONLY The 'slicedNonIndexedParentRidOnly' format of a DB_OBJECT contains an index-slice of an object in one row.
static String	DB_OBJECT_FORMAT_SLICED_PARENT_RID_ONLY The 'slicedParentRidOnly' format of a DB_OBJECT contains an index-slice of an object in one row.
static String	DB_OBJECT_FORMAT_SLICED_WITH_ID_AS_KEY The format 'slicedWithIdAsKey' contains object slices.
static String	DB_OBJECT_HINT DB_OBJECT_HINT defines the hint string which is inserted at SELECT statements as follows: SELECT «hint» * FROM ...
static String	DB_OBJECTS_FOR_QUERY_JOIN_COLUMN dbObjectsForQueryJoinColumn specifies the column which is used to join dbObjectForQuery and dbObjectForQuery2.
static String	DURATION_TYPE The type used to store org::w3c::duration values, i.e.
static String	DURATION_TYPE_CHARACTER Basic ISO 8601 interval value, e.g.
static String	DURATION_TYPE_INTERVAL SQL INTERVAL value
static String	DURATION_TYPE_NUMERIC There are two flavours year-month intervals are stored as (integral) numbers of months day-time intervals are stored as (fractional) numbers of seconds
static String	EMBEDDED_FEATURE EMBEDDED_FEATURE[N] allows to embed multi-valued features into the primary dbObject.
static String	FETCH_SIZE FETCH_SIZE allows to set the fetch size for prepared statements.
static String	FORCE_CREATE FORCE_CREATE forces creation of missing references if true.
static String	IGNORE_CHECK_FOR_DUPLICATES IGNORE_CHECK_FOR_DUPLICATES allows to ignore the check-for-duplicate test on object creation.
static String	JOIN_COLUMN_END1
static String	JOIN_COLUMN_END2
static String	JOIN_TABLE joinTable, joinColumnEnd1 and joinColumnEnd2 allow to access the configured db object using a join table.
static String	MAX_REFERENCE_COMPONENTS maxReferenceComponents defines the maximum number of c$i columns to use in REF tables.
static String	MODEL_DRIVEN If MODEL_DRIVEN is set to true, the plugin uses model information to optimize SQL statements.
static String	NON_PERSISTENT_FEATURE NON_PERSISTENT_FEATURE[N] allows to configure non-persistent features.
static String	NULL_AS_CHARACTER NULL_AS_CHARACTER defines the CAST expression which is used to produce a NULL string, e.g.
static String	OBJECT_ID_ATTRIBUTES_SUFFIX The OBJECT_ID_ATTRIBUTES_SUFFIX defines the suffix which is added to attributes which are object id's.
static String	OBJECT_ID_PATTERN OBJECT_ID_PATTERN defines the regexp pattern of an object id.
static String	OBJECT_IDX_COLUMN Configures the column name used to store the object slice index.
static String	OPTIMIZED_TABLE OPTIMIZED_TABLE list of optimized tables.
static String	OPTIMIZED_TYPE OPTIMIZED_TYPE list of optimized types.
static String	PATH_MACRO_NAME Path values are stored by default in the path.toUri() format.
static String	PATH_MACRO_VALUE
static String	PATH_NORMALIZE_LEVEL PATH_NORMALIZE_LEVEL specifies at what level object values of type path are normalized.
static String	PRIVATE_ATTRIBUTES_PREFIX Attributes which are used privately by the plugin are prefixed with the specified prefix.
static String	REFERENCE_ID_ATTRIBUTES_SUFFIX The REFERENCE_ID_ATTRIBUTES_SUFFIX defines the suffix which is added to attributes which are reference id's.
static String	REFERENCE_ID_FORMAT referenceIdFormat allows to define the format of reference ids.
static String	REFERENCE_ID_FORMAT_REF_TABLE With format refTable reference paths are stored in normalized form.
static String	REFERENCE_ID_FORMAT_TYPE_WITH_PATH_COMPONENTS With format typeWithPathComponents the reference path is stored as {"/" c$i}, where is the name of a configured type pattern matching the reference path and c$i are the path components at the wildcard positions of the type pattern.
static String	REFERENCE_LOOKUP_STATEMENT_HINT referenceLookupStatementHint allows to define the hint tag which is added to SELECT statements for the REF table access.
static String	RESULT_SET_TYPE The result set type used for prepareStatement.
static String	RESULT_SET_TYPE_FORWARD_ONLY
static String	RESULT_SET_TYPE_SCROLL_INSENSITIVE
static String	RESULT_SET_TYPE_SCROLL_SENSITIVE
static String	SET_SIZE_COLUMNS The size of multi-valued attributes are stored in their corresponding size columns if the option setSizeColumns is active.
static String	SINGLE_VALUE_ATTRIBUTE SINGLE_VALUE_ATTRIBUTE allows to define single-valued attributes for cases where the attribute multiplicity can not be derived from the model.
static String	STRING_MACRO_COLUMN String replacement macro definition for a specific column.
static String	STRING_MACRO_NAME
static String	STRING_MACRO_VALUE
static String	SUPPORTS_SQL_SEQUENCE Deprecated. the sequence type is auto-detected from now on. The option is not required any more.
static String	TIME_TYPE The type used to store org::w3c::time values, i.e.
static String	TIME_TYPE_CHARACTER Basic ISO 8601 time value
static String	TIME_TYPE_NUMERIC Number of seconds since midnight
static String	TIME_TYPE_STANDARD Stands for the time type specified by the JDBC driver SQL property TIME.TYPE.STANDARD, i.e.
static String	TIME_TYPE_TIME SQL TIME value
static String	TYPE TYPE list of types.
static String	TYPE_NAME TYPE_NAME list of type names.
static String	USE_NORMALIZED_REFERENCES useNormalizedReferences allows to specify whether columns holding stringified object references should be used.

Fields inherited from class org.openmdx.compatibility.base.dataprovider.layer.persistence.common.CommonConfigurationEntries

CHUNNK_SIZE, STREAM_BUFFER_DIRECTORY

Fields inherited from class org.openmdx.compatibility.base.dataprovider.cci.SharedConfigurationEntries

BATCH_SIZE, BYPASSED_BY_LENIENT_REQUESTS, COMPRESS_UID, DATABASE_CONNECTION_FACTORY, DATAPROVIDER_CONNECTION, DELEGATION_PATH, EXPOSED_PATH, LAYER_STATISTICS, MODEL, MODEL_PACKAGE, NAMESPACE_ID, PACKAGE_IMPL, SEQUENCE_SUPPORTED, SERVER_ID, THIS_DATAPROVIDER, WORK_AROUND_SUN_APPLICATION_SERVER_BINDINGS, XML_DATATYPES

Constructor Summary

protected

LayerConfigurationEntries()

Method Summary

static int	fromString(String code) Returns the code of the passed code's string representation.
static int	max() Returns the biggest defined integer constant or Integer.MIN_VALUE if no integer constant is defined.
static int	min() Returns the smallest defined integer constant or Integer.MAX_VALUE if no integer constant is defined.
static String	toString(int code) Returns a string representation of the passed code

Methods inherited from class java.lang.Object

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

Field Detail

FORCE_CREATE

public static final String FORCE_CREATE

FORCE_CREATE forces creation of missing references if true. Allows to create objects which do not have no parents.

See Also:

Constant Field Values

OPTIMIZED_TYPE

public static final String OPTIMIZED_TYPE

OPTIMIZED_TYPE list of optimized types. Objects with matching paths are stored in optimized tables (attributes in separate rows).

See Also:

Constant Field Values

OPTIMIZED_TABLE

public static final String OPTIMIZED_TABLE

OPTIMIZED_TABLE list of optimized tables. For each optimizedType there must be a corresponding optimized table. An optimized table can be any string which is a valid SQL table name.

See Also:

Constant Field Values

CONNECTION_URL

public static final String CONNECTION_URL

CONNECTION_URL jdbc url which is used to connect to database

See Also:

Constant Field Values

MODEL_DRIVEN

public static final String MODEL_DRIVEN

If MODEL_DRIVEN is set to true, the plugin uses model information to optimize SQL statements. Model information can be useful in case of find operations to determine the multiplicity of filter attributes. In case of 0..1 or 1..1 multiplicity queries can typically be optimized.

See Also:

Constant Field Values

COLUMN_NAME_LONG

public static final String COLUMN_NAME_LONG

Deprecated. COLUMN_NAME_LONG defines the corresponding long column name for a configured COLUMN_NAME_SHORT.

See Also:

Constant Field Values

COLUMN_NAME_SHORT

public static final String COLUMN_NAME_SHORT

Deprecated. COLUMN_NAME_SHORT defines the corresponding short column name for a configured COLUMN_NAME_LONG.

See Also:

Constant Field Values

COLUMN_NAME_FROM

public static final String COLUMN_NAME_FROM

COLUMN_NAME_FROM defines the corresponding 'from' column name for a (from-column-name,to-column-name) mapping.

See Also:

Constant Field Values

COLUMN_NAME_TO

public static final String COLUMN_NAME_TO

COLUMN_NAME_TO defines the corresponding 'to' column name for a (from-column-name,to-column-name) mapping.

See Also:

Constant Field Values

AUTONUM_COLUMN

public static final String AUTONUM_COLUMN

Allows to specify an autonum column. The format is dbObject.columnName [AS format], The database plugin handles autonum colums as follows:

• autonum is applied for object slice creation with index 0
• when a column is specified as autonum and no value is supplied with the create request, a value of the form NEXTVAL(sequence name) is generated in the VALUES clause of the INSERT statement
• a corresponding sequence with name namespace_columnName_SEQ must exist. For databases which do not support sequences a table namespace_columnName_SEQ must exist with column nextval.
• if the optional format is specified with AS format a cast is applied to the sequence value, e.g. CAST(sequence name AS CHAR(20)).

  See Also:

  Constant Field Values

TYPE

public static final String TYPE

TYPE list of types. Objects with matching paths are stored in optimized tables (attributes in separate rows).

See Also:

Constant Field Values

TYPE_NAME

public static final String TYPE_NAME

TYPE_NAME list of type names. Path references are stored as {"/" } where path-component[i] is non-wildcard.

See Also:

Constant Field Values

DB_OBJECT

public static final String DB_OBJECT

'dbObject' defines the primary table or view name of a database object for the specified type which is used for querying and updating objects. The DB_OBJECT must either be of format generic or optimized, i.e. DB_OBJECT_FORMAT_GENERIC or DB_OBJECT_FORMAT_OPTIMIZED, respectively.

See Also:

Constant Field Values

DB_OBJECT_2

public static final String DB_OBJECT_2

'dbObject2' defines the optional secondary table or view name of a database object for the specified type which is used for querying and updating objects. The configuration of a secondary object is optional and is used to store multi-valued attributes.

See Also:

Constant Field Values

DB_OBJECT_FORMAT

public static final String DB_OBJECT_FORMAT

DB_OBJECT_FORMAT defines the format of DB_OBJECT.

See Also:

Constant Field Values

DB_OBJECT_HINT

public static final String DB_OBJECT_HINT

DB_OBJECT_HINT defines the hint string which is inserted at SELECT statements as follows: SELECT «hint» * FROM ...

See Also:

Constant Field Values

DB_OBJECT_FOR_QUERY

public static final String DB_OBJECT_FOR_QUERY

dbObjectForQuery defines the primary view name of a database object for a the specified type which is used for querying objects. The view must return the single-valued attributes of an object if a secondary object for query is configured. It must return object slices if no secondary object for query is configured.

See Also:

Constant Field Values

DB_OBJECT_FOR_QUERY_2

public static final String DB_OBJECT_FOR_QUERY_2

dbObjectForQuery2 defines the optional secondary view name. The view must return the multi-valued attributes of an object.

See Also:

Constant Field Values

DB_OBJECTS_FOR_QUERY_JOIN_COLUMN

public static final String DB_OBJECTS_FOR_QUERY_JOIN_COLUMN

dbObjectsForQueryJoinColumn specifies the column which is used to join dbObjectForQuery and dbObjectForQuery2. If not specified the default join column is object_id. The SELECT is constructed as SELECT * FROM 'dbObject' WHERE 'join column' IN (SELECT object_id FROM 'dbObject2' WHERE 'filter criteria').

See Also:

Constant Field Values

DB_OBJECT_FORMAT_SLICED

public static final String DB_OBJECT_FORMAT_SLICED

The sliced format of a DB_OBJECT contains an index-slice of an object in one row. The schema of a DB_OBJECT with format 'sliced' is: object_objectId, object_referenceId, object_idx, «a0», ..., «an»$

See Also:

Constant Field Values

DB_OBJECT_FORMAT_SLICED_NON_INDEXED

public static final String DB_OBJECT_FORMAT_SLICED_NON_INDEXED

The 'slicedNonIndexed' format of a DB_OBJECT contains one object in one row. The schema of a DB_OBJECT with format 'slicedNonIndexed' is: object_objectId, object_referenceId, «a0», ..., «an»$

See Also:

Constant Field Values

DB_OBJECT_FORMAT_SLICED_PARENT_RID_ONLY

public static final String DB_OBJECT_FORMAT_SLICED_PARENT_RID_ONLY

The 'slicedParentRidOnly' format of a DB_OBJECT contains an index-slice of an object in one row. The schema is: 0 as object_rid, object_oid, p$$parent_object__rid, p$$parent_object__oid ... The sliced does NOT contain the column object_rid. Instead, it provides rid and oid for the parent object. This format is useful when the calculation of the column object_rid is expensive compared to the calculation of the parent object rid|oid.

See Also:

Constant Field Values

DB_OBJECT_FORMAT_SLICED_NON_INDEXED_PARENT_RID_ONLY

public static final String DB_OBJECT_FORMAT_SLICED_NON_INDEXED_PARENT_RID_ONLY

The 'slicedNonIndexedParentRidOnly' format of a DB_OBJECT contains an index-slice of an object in one row. The schema is: 0 as object_rid, object_oid, p$$parent_object__rid, p$$parent_object__oid ... The sliced does NOT contain the column object_rid. Instead, it provides rid and oid for the parent object. This format is useful when the calculation of the column object_rid is expensive compared to the calculation of the parent object rid|oid.

The 'slicedNonIndexedParentRidOnly' format of a DB_OBJECT contains one object in one row. The schema of a DB_OBJECT with format 'slicedNonIndexed' is: object_objectId, object_referenceId, «a0», ..., «an»$

See Also:

Constant Field Values

DB_OBJECT_FORMAT_SLICED_WITH_ID_AS_KEY

public static final String DB_OBJECT_FORMAT_SLICED_WITH_ID_AS_KEY

The format 'slicedWithIdAsKey' contains object slices. The schema is: object_id, p$$parent, . Object references are mapped to a single column. Object collections are accessed with the clause object_id LIKE /%.

See Also:

Constant Field Values

OBJECT_ID_ATTRIBUTES_SUFFIX

public static final String OBJECT_ID_ATTRIBUTES_SUFFIX

The OBJECT_ID_ATTRIBUTES_SUFFIX defines the suffix which is added to attributes which are object id's. Default value is 'objectId'. Typical value is 'oid'.

See Also:

Constant Field Values

REFERENCE_ID_ATTRIBUTES_SUFFIX

public static final String REFERENCE_ID_ATTRIBUTES_SUFFIX

The REFERENCE_ID_ATTRIBUTES_SUFFIX defines the suffix which is added to attributes which are reference id's. Default value is 'referenceId'. Typical value is 'rid'.

See Also:

Constant Field Values

PRIVATE_ATTRIBUTES_PREFIX

public static final String PRIVATE_ATTRIBUTES_PREFIX

Attributes which are used privately by the plugin are prefixed with the specified prefix. Default value is 'p$$'.

See Also:

Constant Field Values

OBJECT_IDX_COLUMN

public static final String OBJECT_IDX_COLUMN

Configures the column name used to store the object slice index. The default is 'object_idx'.

See Also:

Constant Field Values

PATH_NORMALIZE_LEVEL

public static final String PATH_NORMALIZE_LEVEL

PATH_NORMALIZE_LEVEL specifies at what level object values of type path are normalized. The following levels are defined:

• 0 - none
• 1 - add parent --> adds the attributes p$$object_parent_refId, p$$object_parent_objId
• 2 - normalize object paths --> level 1 plus adds the attributes p$$«a»_objId, p$$«a»_refId
• 3 - normalize object parent paths --> level 2 plus adds the attributes p$$«a»_parent_objId, p$$«a»_parent_refId

See Also:

Constant Field Values

SUPPORTS_SQL_SEQUENCE

public static final String SUPPORTS_SQL_SEQUENCE

Deprecated. the sequence type is auto-detected from now on. The option is not required any more.

SUPPORTS_SQL_SEQUENCE is set to true, if database supports SQL sequences for autoincrement columns. Default value is true.

See Also:

Constant Field Values

ALLOWS_SQL_SEQUENCE_FALLBACK

public static final String ALLOWS_SQL_SEQUENCE_FALLBACK

ALLOWS_SQL_SEQUENCE_FALLBACK is set to true, if plugin is allowed to fallback to supportSqlSequence=false mode automatically. Default value is false.

See Also:

Constant Field Values

IGNORE_CHECK_FOR_DUPLICATES

public static final String IGNORE_CHECK_FOR_DUPLICATES

IGNORE_CHECK_FOR_DUPLICATES allows to ignore the check-for-duplicate test on object creation. By default, the persistence plugin asserts that no two objects with the same identity are created. An object is only created an object retrieval with the same identity throws NOT_FOUND. The check is not performed if the option is set to true. In this case it is strongly recommended to set primary key constraints on the object_id / idx columns.

See Also:

Constant Field Values

SINGLE_VALUE_ATTRIBUTE

public static final String SINGLE_VALUE_ATTRIBUTE

SINGLE_VALUE_ATTRIBUTE allows to define single-valued attributes for cases where the attribute multiplicity can not be derived from the model. This is often the case when plugins add implementation dependent attributes (e.g. object_stateId added by state plugin

See Also:

Constant Field Values

EMBEDDED_FEATURE

public static final String EMBEDDED_FEATURE

EMBEDDED_FEATURE[N] allows to embed multi-valued features into the primary dbObject. If the multi-valued feature F is embedded it is stored in the primary table as F_0, ..., F_N.

See Also:

Constant Field Values

NON_PERSISTENT_FEATURE

public static final String NON_PERSISTENT_FEATURE

NON_PERSISTENT_FEATURE[N] allows to configure non-persistent features. By default all non-derived features of a class are made persistent. The option allows to override this default behaviour. The fully qualified model name must be configured.

See Also:

Constant Field Values

OBJECT_ID_PATTERN

public static final String OBJECT_ID_PATTERN

OBJECT_ID_PATTERN defines the regexp pattern of an object id. If specified, the the pattern is used for the view creation in get and find operations and for generating the where clause in get operations:

• without objectIdPattern

    SELECT v1.*, v2.«mixin attributes» FROM
    (SELECT * FROM «db object») v1,
    (SELECT object_oid, object_rid, «mixin attributes» FROM «db object») v2
    WHERE
    v1.object_rid = v2.object_rid AND
    v1.object_oid = v2.object_oid
   

• with objectIdPattern

    SELECT v1.*, v2.«mixin attributes» FROM
    (SELECT * FROM «db object») v1,
    (SELECT object_oid, object_rid, «mixin attributes» FROM «db object) v2
    WHERE
    v1.object_rid = v2.object_rid AND
    v1.p$$object_oid$0 = v2.p$$object_oid$0 AND v1.p$$object_oid$1 = v2.p$$object_oid$1
   

p$$object_oid$0, $1, etc. represent the object_oid of the underlying «db object» parsed into object components.

See Also:

Constant Field Values

NULL_AS_CHARACTER

public static final String NULL_AS_CHARACTER

NULL_AS_CHARACTER defines the CAST expression which is used to produce a NULL string, e.g. CAST(NULL AS CHARACTER). Default value is 'NULL'.

See Also:

Constant Field Values

FETCH_SIZE

public static final String FETCH_SIZE

FETCH_SIZE allows to set the fetch size for prepared statements. If defined the method ps.setFetchSize(fetchSize) is called. This option can improve dramatically performance of some JDBC drivers. The default is set to 100.

See Also:

Constant Field Values

PATH_MACRO_NAME

public static final String PATH_MACRO_NAME

Path values are stored by default in the path.toUri() format. The path macros allow to modify path values before they are stored. E.g. a path of the form xri:@openmdx:org.openmdx.test.app1/provider/Sliced/segment/Standard/... can be modified to be stored as xri:*app1.Sliced.Standard/... with a macro with name = app1.Sliced.Standard and the value = xri:@openmdx:org.openmdx.test.app1/provider/Sliced/segment/Standard. This feature can be used e.g. for path compression and therefore to save space on database tables.

Macro names at the beginning of the path value are of the form xri:*M and (xri:*M) at all other positions.

The macro replacement operates on the XRI notation of the path value.

The macro name should have the same ordering as the macro value, i.e. m1.value >= m2.value ==> m1.name >= m2.name.

See Also:

Constant Field Values

PATH_MACRO_VALUE

public static final String PATH_MACRO_VALUE

See Also:

Constant Field Values

STRING_MACRO_COLUMN

public static final String STRING_MACRO_COLUMN

String replacement macro definition for a specific column. If the value of the specified column stringMacroColumn is equal to the value stringMacroValue then it is replace with stringMacroName. Multiple replacements can be defined for one column.

stringMacroColumn[0] = object_class stringMacroName[0] = CompoundBooking stringMacroValue[0] = org:openmdx:booking1:CompoundBooking

stringMacroColumn[0] = object_class stringMacroName[0] = SingleLegBooking stringMacroValue[0] = org:openmdx:booking1:SingleLegBooking

See Also:

Constant Field Values

STRING_MACRO_NAME

public static final String STRING_MACRO_NAME

See Also:

Constant Field Values

STRING_MACRO_VALUE

public static final String STRING_MACRO_VALUE

See Also:

Constant Field Values

MAX_REFERENCE_COMPONENTS

public static final String MAX_REFERENCE_COMPONENTS

maxReferenceComponents defines the maximum number of c$i columns to use in REF tables. c$i columns must be defined as NOT NULL. Unused columns for a specific reference entry are set to ''. This allows to define a unique constraint on the c$i columns.

See Also:

Constant Field Values

REFERENCE_LOOKUP_STATEMENT_HINT

public static final String REFERENCE_LOOKUP_STATEMENT_HINT

referenceLookupStatementHint allows to define the hint tag which is added to SELECT statements for the REF table access.

See Also:

Constant Field Values

REFERENCE_ID_FORMAT

public static final String REFERENCE_ID_FORMAT

referenceIdFormat allows to define the format of reference ids. referenceIdFormatRefTable is the default.

See Also:

Constant Field Values

REFERENCE_ID_FORMAT_REF_TABLE

public static final String REFERENCE_ID_FORMAT_REF_TABLE

With format refTable reference paths are stored in normalized form. The reference path is stored in a reference table with the following schema: CREATE TABLE _REF ( object_rid BIGINT IDENTITY NOT NULL, n INTEGER NOT NULL , c$0 VARCHAR(120) NOT NULL , c$1 VARCHAR(120) NOT NULL, c$2 VARCHAR(120) NOT NULL, c$3 VARCHAR(120) NOT NULL, c$4 VARCHAR(120) NOT NULL, c$5 VARCHAR(120) NOT NULL, c$6 VARCHAR(120) NOT NULL, c$7 VARCHAR(120) NOT NULL, c$8 VARCHAR(120) NOT NULL, c$9 VARCHAR(120) NOT NULL, c$10 VARCHAR(120) NOT NULL, c$11 VARCHAR(120) NOT NULL, c$12 VARCHAR(120) NOT NULL, c$13 VARCHAR(120) NOT NULL, c$14 VARCHAR(120) NOT NULL, c$15 VARCHAR(120) NOT NULL ); c$i hold the path components, n the number of components. object_rid holds an auto-generated id which is used as foreign key to store the reference.

See Also:

Constant Field Values

REFERENCE_ID_FORMAT_TYPE_WITH_PATH_COMPONENTS

public static final String REFERENCE_ID_FORMAT_TYPE_WITH_PATH_COMPONENTS

With format typeWithPathComponents the reference path is stored as {"/" c$i}, where is the name of a configured type pattern matching the reference path and c$i are the path components at the wildcard positions of the type pattern. This format requires pathNormalizeLevel >= 2 for all configured types.

See Also:

Constant Field Values

USE_NORMALIZED_REFERENCES

public static final String USE_NORMALIZED_REFERENCES

useNormalizedReferences allows to specify whether columns holding stringified object references should be used. With pathNormalizeLevel=2 references are stored in normalized form in the columns , p$$, p$$. If set to false, the column is leading and is used for query and update operations. If set to true, the columns p$$, p$$ are leading and used for all DB operations. The default value is false. true requires a pathNormalizeLevel >= 2 for all configured DB objects.

See Also:

Constant Field Values

JOIN_TABLE

public static final String JOIN_TABLE

joinTable, joinColumnEnd1 and joinColumnEnd2 allow to access the configured db object using a join table. The view to access the configured db object is constructed as SELECT T v INNER JOIN joinTable vj ON v.object_id = vj.joinColumnEnd2 Normally a find request results (depending on the configured db object type) in SELECT T v WHERE p$$parent = ?. With a join table the find request looks as SELECT T v INNER JOIN joinTable vj ON v.object_id = vj.joinColumnEnd2 WHERE vj.joinColumnEnd1 = ?.

See Also:

Constant Field Values

JOIN_COLUMN_END1

public static final String JOIN_COLUMN_END1

See Also:

Constant Field Values

JOIN_COLUMN_END2

public static final String JOIN_COLUMN_END2

See Also:

Constant Field Values

SET_SIZE_COLUMNS

public static final String SET_SIZE_COLUMNS

The size of multi-valued attributes are stored in their corresponding size columns if the option setSizeColumns is active. The size of a multi-valued attribute stored in column C is stored in column C_.

See Also:

Constant Field Values

BOOLEAN_TYPE

public static final String BOOLEAN_TYPE

The type used to store boolean values, i.e. one of

• BOOLEAN (ignore booleanFalse and booleanTrue configurations)
• CHARACTER (default)
• NUMERIC

See Also:

Constant Field Values

BOOLEAN_TYPE_BOOLEAN

public static final String BOOLEAN_TYPE_BOOLEAN

See Also:

Constant Field Values

BOOLEAN_TYPE_YN

public static final String BOOLEAN_TYPE_YN

See Also:

Constant Field Values

BOOLEAN_TYPE_CHARACTER

public static final String BOOLEAN_TYPE_CHARACTER

See Also:

Constant Field Values

BOOLEAN_TYPE_NUMERIC

public static final String BOOLEAN_TYPE_NUMERIC

See Also:

Constant Field Values

BOOLEAN_TYPE_STANDARD

public static final String BOOLEAN_TYPE_STANDARD

Stands for the date type specified by the JDBC driver SQL property BOOLEAN.TYPE.STANDARD, i.e. one of

• BOOLEAN
• YN
• CHARACTER
• NUMERIC

See Also:

BOOLEAN_TYPE_BOOLEAN, BOOLEAN_TYPE_YN, BOOLEAN_TYPE_CHARACTER, BOOLEAN_TYPE_NUMERIC, Constant Field Values

BOOLEAN_FALSE

public static final String BOOLEAN_FALSE

The value corresponding to Boolean.FALSE, e.g.

• false (fix in case of booleanType BOOLEAN
• ##false## (default in case of booleanType CHARACTER)
• 0 (default in case of booleanType NUMERIC)

See Also:

Constant Field Values

BOOLEAN_TRUE

public static final String BOOLEAN_TRUE

The value corresponding to Boolean.TRUE, e.g.

• true (fix in case of booleanType BOOLEAN
• ##true## (default in case of booleanType CHARACTER)
• 1 (default in case of booleanType NUMERIC)

See Also:

Constant Field Values

DURATION_TYPE

public static final String DURATION_TYPE

The type used to store org::w3c::duration values, i.e. one of

• INTERVAL (domain defined by the database field definition)
• CHARACTER (default)
• NUMERIC (domain either year-month or day-time intervals!)

See Also:

DURATION_TYPE_INTERVAL, DURATION_TYPE_CHARACTER, DURATION_TYPE_NUMERIC, Constant Field Values

DURATION_TYPE_INTERVAL

public static final String DURATION_TYPE_INTERVAL

SQL INTERVAL value

See Also:

Constant Field Values

DURATION_TYPE_CHARACTER

public static final String DURATION_TYPE_CHARACTER

Basic ISO 8601 interval value, e.g. "P2Y6M" or "P2DT12H".

See Also:

Constant Field Values

DURATION_TYPE_NUMERIC

public static final String DURATION_TYPE_NUMERIC

There are two flavours

• year-month intervals are stored as (integral) numbers of months
• day-time intervals are stored as (fractional) numbers of seconds

See Also:

Constant Field Values

DATE_TYPE

public static final String DATE_TYPE

The type used to store org::w3c::date values, i.e. one of

• STANDARD
• DATE
• CHARACTER (default)

See Also:

DATE_TYPE_STANDARD, DATE_TYPE_DATE, DATE_TYPE_CHARACTER, Constant Field Values

DATE_TYPE_STANDARD

public static final String DATE_TYPE_STANDARD

Stands for the date type specified by the JDBC driver SQL property DATE.TYPE.STANDARD, i.e. one of

• DATE
• CHARACTER (default)

See Also:

DATE_TYPE_DATE, DATE_TYPE_CHARACTER, Constant Field Values

DATE_TYPE_DATE

public static final String DATE_TYPE_DATE

SQL DATE value

See Also:

Constant Field Values

DATE_TYPE_CHARACTER

public static final String DATE_TYPE_CHARACTER

Basic ISO 8601 date value, e.g. "19700101"

See Also:

Constant Field Values

DATETIME_TYPE

public static final String DATETIME_TYPE

The type used to store org::w3c::dateTime values, i.e. one of

• STANDARD
• TIMESTAMP
• TIMESTAMP_WITH_TIMEZONE
• CHARACTER (default)
• NUMERIC

See Also:

DATETIME_TYPE_STANDARD, DATETIME_TYPE_TIMESTAMP, DATETIME_TYPE_TIMESTAMP_WITH_TIMEZONE, DATETIME_TYPE_CHARACTER, DATETIME_TYPE_NUMERIC, Constant Field Values

DATETIME_TYPE_STANDARD

public static final String DATETIME_TYPE_STANDARD

Stands for the datetime type specified by the JDBC driver SQL property DATETIME.TYPE.STANDARD, i.e. one of

• TIMESTAMP
• TIMESTAMP_WITH_TIMEZONE
• CHARACTER (default)
• NUMERIC

See Also:

DATETIME_TYPE_TIMESTAMP, DATETIME_TYPE_TIMESTAMP_WITH_TIMEZONE, DATETIME_TYPE_CHARACTER, DATETIME_TYPE_NUMERIC, Constant Field Values

DATETIME_TYPE_TIMESTAMP

public static final String DATETIME_TYPE_TIMESTAMP

SQL TIMESTAMP value

See Also:

Constant Field Values

DATETIME_TYPE_TIMESTAMP_WITH_TIMEZONE

public static final String DATETIME_TYPE_TIMESTAMP_WITH_TIMEZONE

SQL TIMESTAMP WITH TIMEZONE value

See Also:

Constant Field Values

DATETIME_TYP