Table of Contents
Table of Contents
This section contains an alphabetical reference of all the XML tags that DODS can generate using given DOML file. Every tag contains the subsections:
Content - tags that the tag can contain.
Attributes - attributes the tag can have.
Context - tags within which the tag can appear, in other words, the tags that can contain it.
Can column be null. Possible values for can_be_null are:
true
false
Content:None
Attributes: None
Context: <column>
The name of the class which represents table in the database, mostly, it is the TABLE_NAME.
Content: None
Attributes: None
Context: <table>
Represents one column in the table.
Content: <REFERENCE_OBJECT>, <CONSTRAINT>, <IS_ABSTRACT>, <IS_FOREIGN_KEY>, <PACKAGE>, <IS_CONSTANT>, <JAVADOC>, <DB_TYPE>, <JAVA_TYPE>, <JAVA_DEFAULT_VALUE>, <USED_FOR_QUERY>, <CAN_BE_NULL>, <IS_PRIMARY_KEY>, <IS_FOREIGN_KEY>, <SIZE>
Attributes:
1. name - Name of the column in the table.
Context:<table>
Specifies whether the specified table row must exist. Possible values for constraint are:
true
false
Content: None
Attributes: None
Context: <reference_object>
Data type from database that represents column.
Content: None
Attributes: None
Context: <column>
The database type. Possible values are Standard, InstantDB, Oracle, Informix, MySQL, Sybase or PostgreSQL.
Content: None
Attributes: None
Context: <table>
Is it possible to delete cascades in database. Possible values for delete_cascades are:
true
false
Content: None
Attributes: None
Context: <table>
Is table based on OID keys. Posible values for do_is_oid_based are:
true
false
Content: None
Attributes: None
Context: <table>
The name of the class extended by generated class.
Content: None
Attributes: None
Context: <table>
Represents table index.
Content: <index_column>
Attributes:
1. id - Id of index.
2. unique - True if index is unique, otherwise false.
3. clustered - True if index is clustered, otherwise false.
Context: <table>
Identifies index column.
Content: None
Attributes:
1. id - Id of index column, same as name of column.
Context: <table>
Is generated class abstract. Possible values for is_abstract are:
true
false
Content: None
Attributes: None
Context: <table>, <reference_object>
Does column have constant value, that is, does it represent constant class attribute (not taken from database). Possible values for is_constant are:
true
false
Content: None
Attributes: None
Context: <column>
Is column used as a foreign key. Possible values for is_foreign_key are:
true
false
Content: None
Attributes: None
Context: <column>, <reference_object>
This attribute specifies whether the DO will use lazy loading. If the DO uses lazy loading, when you supply a known ObjectId to create a DO instance, the DO instance is created but the corresponding row in the table is not retrieved until the first get()or set() method call is made. It delays the hit on the database until the moment the data is actually needed. Possible values for isLazyLoading are:
true
false
Content: None
Attributes: None
Context: <table>
Is column a primary key. Possible values for is_primary_key are:
true
false
Content: None
Attributes: None
Context: <column>
Data type from Java that represents column.
Content: None
Attributes: None
Context: <column>
Package that contains Java files.
Content: None
Attributes: None
Context: <table>, <reference_object>, <referrer>
Tag that is used like attribute for tag <referrer>. It represents column of table that references generated class.
Content: None
Attributes:
1. name - Name of the column that references some DO objects. It is object of generated class, mostly.
2. do_name - Name of the DO object that is referenced by attribute.
Context: <table>
If the column is a reference to another table, <reference_object> specifies the table.
Content: <CONSTRAINT>, <IS_ABSTRACT>, <IS_FOREIGN_KEY>, <PACKAGE>
Attributes:
1. name - Name of the reference object class.
Context: <column>
Outer table that references generated class.
Content: <refattr>
Attributes:
1. name - Name of the outer table that references generated class.
2. package - Name of the outer table package that references generated class.
Context: <table>
Specifies the size of data types that are commonly measured in width, like VARCHAR. size must be an integer.
Content: None
Attributes: None
Context: <column>
Root element of XML files. It contains one table from database.
Content: <package>, <author>, <project_name>, <table_name>, <class_name>, <extends>, <db_vendor>, <template_set>, <do_is_oid_based>, <is_abstract>, <is_lazy_loading>, <delete_cascades>, <column>, <referrer>
Attributes: None
Context: None
Template set that will be used for java code generation. The possible values for template_set are:
standard (default)
multidb
<any user defined template>
Content: None
Attributes: None
Context: <table>