2011/01/16 - Apache ObJectRelationalBridge has been retired.

For more information, please explore the Attic.

HomeDocumentation
 

DTD documentation

Top-level element(s)

List of elements

Element declarations

descriptor-repository
Content model ( documentation ? , attribute * , jdbc-connection-descriptor * , class-descriptor * )
Attributes
version     required attribute
possible values: 1.0
isolation-level     default value: read-uncommitted
possible values: read-uncommitted read-committed repeatable-read serializable optimistic none
proxy-prefetching-limit     type: CDATA
default value: 50

documentation
Content model ( #PCDATA )
Used insidedescriptor-repository | jdbc-connection-descriptor | object-cache | connection-pool | sequence-manager | class-descriptor | extent-class | field-descriptor | attribute | reference-descriptor | foreignkey | collection-descriptor | orderby | inverse-foreignkey | fk-pointing-to-this-class | fk-pointing-to-element-class | query-customizer | index-descriptor | index-column | insert-procedure | update-procedure | delete-procedure | runtime-argument | constant-argument
 

jdbc-connection-descriptor
Content model ( documentation ? , attribute * , object-cache ? , connection-pool ? , sequence-manager ? )
Attributes
jcd-alias     type: CDATA
required attribute
default-connection     default value: false
possible values: true false
platform     default value: Hsqldb
possible values: Db2 Hsqldb Informix MsAccess MsSQLServer MySQL Oracle PostgreSQL Sybase SybaseASE SybaseASA Sapdb Firebird Axion NonstopSql Oracle9i MaxDB
jdbc-level     default value: 1.0
possible values: 1.0 2.0 3.0
eager-release     default value: false
possible values: true false
batch-mode     default value: false
possible values: true false
useAutoCommit     default value: 1
possible values: 0 1 2
ignoreAutoCommitExceptions     default value: false
possible values: true false
jndi-datasource-name     type: CDATA
driver     type: CDATA
protocol     type: CDATA
subprotocol     type: CDATA
dbalias     type: CDATA
username     type: CDATA
password     type: CDATA
Used insidedescriptor-repository
 

object-cache
Content model ( documentation ? , attribute * )
Attributes
class     type: CDATA
required attribute
Used insidejdbc-connection-descriptor | class-descriptor
 

connection-pool
Content model ( documentation ? , attribute * )
Attributes
maxActive     type: CDATA
minIdle     type: CDATA
maxIdle     type: CDATA
maxWait     type: CDATA
minEvictableIdleTimeMillis     type: CDATA
numTestsPerEvictionRun     type: CDATA
testOnBorrow     possible values: true false
testOnReturn     possible values: true false
testWhileIdle     possible values: true false
timeBetweenEvictionRunsMillis     type: CDATA
whenExhaustedAction     possible values: 0 1 2
validationQuery     type: CDATA
removeAbandoned     possible values: true false
removeAbandonedTimeout     type: CDATA
logAbandoned     possible values: true false
Used insidejdbc-connection-descriptor
 

sequence-manager
Content model ( documentation ? , attribute * )
Attributes
className     type: CDATA
required attribute
Used insidejdbc-connection-descriptor
 

class-descriptor
Content model ( ( documentation ? , object-cache ? , extent-class + , attribute * ) | ( documentation ? , object-cache ? , extent-class * , field-descriptor + , reference-descriptor * , collection-descriptor * , index-descriptor * , attribute * , insert-procedure ? , update-procedure ? , delete-procedure ? ) )
Attributes
class     type: ID
required attribute
isolation-level     possible values: read-uncommitted read-committed repeatable-read serializable optimistic none
proxy     type: CDATA
proxy-prefetching-limit     type: CDATA
schema     type: CDATA
table     type: CDATA
row-reader     type: CDATA
extends     type: IDREF
accept-locks     default value: true
possible values: true false
initialization-method     type: CDATA
factory-class     type: CDATA
factory-method     type: CDATA
refresh     default value: false
possible values: true false
Used insidedescriptor-repository
 

extent-class
Content model ( documentation ? )
Attributes
class-ref     type: IDREF
required attribute
Used insideclass-descriptor
 

field-descriptor
Content model ( documentation ? , attribute * )
Attributes
id     type: CDATA
name     type: CDATA
required attribute
table     type: CDATA
column     type: CDATA
required attribute
jdbc-type     possible values: BIT TINYINT SMALLINT INTEGER BIGINT DOUBLE FLOAT REAL NUMERIC DECIMAL CHAR VARCHAR LONGVARCHAR DATE TIME TIMESTAMP BINARY VARBINARY LONGVARBINARY CLOB BLOB STRUCT ARRAY REF BOOLEAN DATALINK
primarykey     default value: false
possible values: true false
nullable     default value: true
possible values: true false
indexed     default value: false
possible values: true false
autoincrement     default value: false
possible values: true false
sequence-name     type: CDATA
locking     default value: false
possible values: true false
update-lock     default value: true
possible values: true false
default-fetch     default value: false
possible values: true false
conversion     type: CDATA
length     type: CDATA
precision     type: CDATA
scale     type: CDATA
access     default value: readwrite
possible values: readonly readwrite anonymous
Used insideclass-descriptor
 

attribute
Content model ( documentation ? )
Attributes
attribute-name     type: CDATA
required attribute
attribute-value     type: CDATA
required attribute
Used insidedescriptor-repository | jdbc-connection-descriptor | object-cache | connection-pool | sequence-manager | class-descriptor | field-descriptor | reference-descriptor | collection-descriptor | query-customizer | insert-procedure | update-procedure | delete-procedure | runtime-argument | constant-argument
 

reference-descriptor
Content model ( documentation ? , foreignkey + , attribute * )
Attributes
name     type: CDATA
required attribute
class-ref     type: IDREF
required attribute
proxy     default value: false
possible values: true false
proxy-prefetching-limit     type: CDATA
refresh     default value: false
possible values: true false
auto-retrieve     default value: true
possible values: true false
auto-update     default value: false
possible values: none link object true false
auto-delete     default value: false
possible values: none link object true false
otm-dependent     default value: false
possible values: true false
Used insideclass-descriptor
 

foreignkey
Content model ( documentation ? )
Attributes
field-id-ref     type: CDATA
field-ref     type: CDATA
Used insidereference-descriptor
 

collection-descriptor
Content model ( documentation ? , orderby * , inverse-foreignkey * , fk-pointing-to-this-class * , fk-pointing-to-element-class * , query-customizer ? , attribute * )
Attributes
name     type: CDATA
collection-class     type: CDATA
element-class-ref     type: IDREF
required attribute
orderby     type: CDATA
sort     default value: ASC
possible values: ASC DESC
indirection-table     type: CDATA
proxy     default value: false
possible values: true false
proxy-prefetching-limit     type: CDATA
refresh     default value: false
possible values: true false
auto-retrieve     default value: true
possible values: true false
auto-update     default value: false
possible values: none link object true false
auto-delete     default value: false
possible values: none link object true false
otm-dependent     default value: false
possible values: true false
Used insideclass-descriptor
 

orderby
Content model ( documentation ? )
Attributes
name     type: CDATA
required attribute
sort     default value: ASC
possible values: ASC DESC
Used insidecollection-descriptor
 

inverse-foreignkey
Content model ( documentation ? )
Attributes
field-id-ref     type: CDATA
field-ref     type: CDATA
Used insidecollection-descriptor
 

fk-pointing-to-this-class
Content model ( documentation ? )
Attributes
column     type: CDATA
required attribute
Used insidecollection-descriptor
 

fk-pointing-to-element-class
Content model ( documentation ? )
Attributes
column     type: CDATA
required attribute
Used insidecollection-descriptor
 

query-customizer
Content model ( documentation ? , attribute * )
Attributes
class     type: CDATA
required attribute
Used insidecollection-descriptor
 

index-descriptor
Content model ( documentation ? , index-column + )
Attributes
name     type: CDATA
required attribute
unique     default value: false
possible values: true false
Used insideclass-descriptor
 

index-column
Content model ( documentation ? )
Attributes
name     type: CDATA
required attribute
Used insideindex-descriptor
 

insert-procedure
Content model ( documentation ? , ( runtime-argument | constant-argument ) * , attribute * )
Attributes
name     type: CDATA
required attribute
return-field-ref     type: CDATA
include-all-fields     default value: false
possible values: true false
Used insideclass-descriptor
 

update-procedure
Content model ( documentation ? , ( runtime-argument | constant-argument ) * , attribute * )
Attributes
name     type: CDATA
required attribute
return-field-ref     type: CDATA
include-all-fields     default value: false
possible values: true false
Used insideclass-descriptor
 

delete-procedure
Content model ( documentation ? , ( runtime-argument | constant-argument ) * , attribute * )
Attributes
name     type: CDATA
required attribute
return-field-ref     type: CDATA
include-pk-only     default value: false
possible values: true false
Used insideclass-descriptor
 

runtime-argument
Content model ( documentation ? , attribute * )
Attributes
field-ref     type: CDATA
return     default value: false
possible values: true false
Used insideinsert-procedure | update-procedure | delete-procedure
 

constant-argument
Content model ( documentation ? , attribute * )
Attributes
value     type: CDATA
required attribute
Used insideinsert-procedure | update-procedure | delete-procedure