Enhydra 5.1 release notes


Table of Contents

1. Tag reference in a XML file
<author>
<caching>
<can_be_null>
<class_name>
<column>
<constraint>
<db_type>
<db_vendor>
<delete_cascades>
<do_is_oid_based>
<extends>
<index>
<index_column>
<is_abstract>
<is_constant>
<is_foreign_key>
<is_lazy_loading>
<is_primary_key>
<javadoc>
<java_default_value>
<java_type>
<package>
<project_name>
<refattr>
<reference_object>
<referrer>
<size>
<table>
<table_name>
<template_set>
<used_for_query>

Chapter 1. Tag reference in a XML file

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.

<author>

Author of the Java code (your name).

Content: None

Attributes: None

Context: <table>

<caching>

Should table be cached or not. Possible values for caching are:

  • true

  • false

Content: None

Attributes: None

Context: <table>

<can_be_null>

Can column be null. Possible values for can_be_null are:

  • true

  • false

Content:None

Attributes: None

Context: <column>

<class_name>

The name of the class which represents table in the database, mostly, it is the TABLE_NAME.

Content: None

Attributes: None

Context: <table>

<column>

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>

<constraint>

Specifies whether the specified table row must exist. Possible values for constraint are:

  • true

  • false

Content: None

Attributes: None

Context: <reference_object>

<db_type>

Data type from database that represents column.

Content: None

Attributes: None

Context: <column>

<db_vendor>

The database type. Possible values are Standard, InstantDB, Oracle, Informix, MySQL, Sybase or PostgreSQL.

Content: None

Attributes: None

Context: <table>

<delete_cascades>

Is it possible to delete cascades in database. Possible values for delete_cascades are:

  • true

  • false

Content: None

Attributes: None

Context: <table>

<do_is_oid_based>

Is table based on OID keys. Posible values for do_is_oid_based are:

  • true

  • false

Content: None

Attributes: None

Context: <table>

<extends>

The name of the class extended by generated class.

Content: None

Attributes: None

Context: <table>

<index>

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>

<index_column>

Identifies index column.

Content: None

Attributes:

1. id - Id of index column, same as name of column.

Context: <table>

<is_abstract>

Is generated class abstract. Possible values for is_abstract are:

  • true

  • false

Content: None

Attributes: None

Context: <table>, <reference_object>

<is_constant>

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_foreign_key>

Is column used as a foreign key. Possible values for is_foreign_key are:

  • true

  • false

Content: None

Attributes: None

Context: <column>, <reference_object>

<is_lazy_loading>

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_primary_key>

Is column a primary key. Possible values for is_primary_key are:

  • true

  • false

Content: None

Attributes: None

Context: <column>

<javadoc>

Text for Javadoc documentation.

Content: None

Attributes: None

Context: <column>

<java_default_value>

Default value for Java data type.

Content: None

Attributes: None

Context: <column>

<java_type>

Data type from Java that represents column.

Content: None

Attributes: None

Context: <column>

<package>

Package that contains Java files.

Content: None

Attributes: None

Context: <table>, <reference_object>, <referrer>

<project_name>

The project name.

Content: None

Attributes: None

Context: <table>

<refattr>

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>

<reference_object>

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>

<referrer>

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>

<size>

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>

<table>

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>, <caching>, <do_is_oid_based>, <is_abstract>, <is_lazy_loading>, <delete_cascades>, <column>, <referrer>

Attributes: None

Context: None

<table_name>

The name of the table in the database.

Content: None

Attributes: None

Context: <table>

<template_set>

Template set that will be used for java code generation. The possible values for template_set are:

  • standard (default)

  • multidb

  • webdocwf

  • multidb_webdocwf

  • <any user defined template>

Content: None

Attributes: None

Context: <table>

<used_for_query>

Should column be used for queries. Possible values for used_for_query are:

  • true

  • false

Content: None

Attributes: None

Context: <column>