ojb-repository.dtd

spring,z几 塞积极 决撒 积极上经济歼击机就 将计就计经济年毫毫毫毫毫毫毫毫毫毫毫毫毫毫

    creates the referred object or deletes it if the reference field is set to null.
    Also otm-dependent references behave as if auto-update and auto-delete
    were set to true, but the auto-update and auto-delete attributes themself
    must be always set to false for use with OTM layer.

  -->
<!ATTLIST reference-descriptor
	name CDATA #REQUIRED
	class-ref IDREF #REQUIRED

	proxy (true | false) "false"
	proxy-prefetching-limit CDATA #IMPLIED
	refresh (true | false) "false"

	auto-retrieve (true | false) "true"
	auto-update (none | link | object | true | false) "false"
	auto-delete (none | link | object | true | false) "false"
	otm-dependent (true | false) "false"
>

<!--
    A foreignkey element contains information on a foreign-key persistent
    attribute that implement the association on the database level.
  -->
<!ELEMENT foreignkey (documentation?)>
<!--
	The field-id-ref contains the id attribute of the field-descriptor
	used as a foreign key.
  -->
<!ATTLIST foreignkey
	field-id-ref CDATA #IMPLIED
	field-ref CDATA #IMPLIED
>


<!--
    A collection-descriptor contains mapping info for a Collection- or
    Array-attribute of a  persistent class that contains persistent
    entity Objects.

    The inverse-foreignkey elements contains information on foreign-key
    attributes that implement the association on the database level.

    The fk-pointing-to-this-class and fk-pointing-to-element-class elements
    are only needed if the Collection or array implements a m:n association.
    In this case they contain information on the foreign-key columns of
    the intermediary table.

    A collection-descriptor may contain user defined attribute elements.
  -->
<!ELEMENT collection-descriptor (
    documentation?,
    orderby*,
    inverse-foreignkey*,
	fk-pointing-to-this-class*,
	fk-pointing-to-element-class*,
	query-customizer?,
	attribute*)>


<!--
	The name attribute holds the name of the persistent classes attribute.
	If the PersistentFieldDefaultImpl is used there must be an attribute
	in the persistent class with this name.
	If the PersistentFieldPropertyImpl is used there must be a JavaBeans
	compliant property of this name.

	The collection-class may hold a fully qualified class name.
	This class must be the Java type of the Collection attribute.
	This attribute must only specified if the attribute type is not
	a java.util.Collection (or subclass) or Array type. The declared
    (none java.util.Collection or non Array) class must implement
    ManageableCollection to let OJB handle this type of collection.

	The element-class-ref attribute contains a fully qualified class name.
	This class is the Object type of the elements of persistent collection
	or Array attribute.
	As this is an IDREF there must be a class-descriptor for this class
	in the repository too.

	DEPRECATED, please use the 'orderby'-element. The orderby attribute may
	specify a field of the element class.
	The Collection or Array will be sorted according to the specified attribute.
	The sort attribute may be used to specify ascending or descending order for
	this operation.

	The indirection-table must specify the name of an intermediary table,
	if the persistent collection attribute implements a m:n association.

	The proxy attribute can be set to true to specify that proxy based
	lazy loading should be used for this attribute.

    If the proxy-prefetching-limit attribute (used with the proxy attribute)
    is set to the value > 0, then loading of the collection for the first
    object of some other collection causes loading of the collections for
    the next proxy-prefetching-limit objects.
    Set this parameter to 0 if you want to turn this feature off.

	The refresh attribute can be set to true to force OJB to refresh
	object and collection references on instance loading.

	The auto-retrieve attribute specifies whether OJB automatically retrieves
	this attribute on loading the persistent object.
	If set to false the persistent attribute is set to null. In this case the
	user is responsible to fill the persistent attribute.

	The auto-update attribute specifies whether OJB automatically stores
	the referenced objects on storing the persistent object or not or only link.
	This attribute must be set to 'false' if using the OTM or JDO layer.
    Allowed ODMG settings please see OJB documentation.

	The auto-delete attribute specifies whether OJB automatically deletes
	the referenced objects on deleting the persistent object or not.
	This attribute must be set to 'false' if using the OTM or JDO layer.
    Allowed ODMG settings please see OJB documentation.

	The otm-dependent attribute specifies whether the OTM layer automatically
    creates collection elements that were included into the collectionelements
    and deletes collection elements that were excluded from the collection.
    Also otm-dependent references behave as if auto-update and auto-delete
    were set to true, but the auto-update and auto-delete attributes themself
    must be always set to false for use with OTM layer.


  -->
<!ATTLIST collection-descriptor
	name CDATA #IMPLIED
	collection-class CDATA #IMPLIED
	element-class-ref IDREF #REQUIRED
	orderby CDATA #IMPLIED
	sort (ASC | DESC) "ASC"

	indirection-table CDATA #IMPLIED

	proxy (true | false) "false"
	proxy-prefetching-limit CDATA #IMPLIED
	refresh (true | false) "false"

	auto-retrieve (true | false) "true"
	auto-update (none | link | object | true | false) "false"
	auto-delete (none | link | object | true | false) "false"
	otm-dependent (true | false) "false"
>

<!--
	an OrderBy elemnent contains an attribute name and a sort order
  -->
<!ELEMENT orderby (documentation?)>
<!ATTLIST orderby
	name CDATA #REQUIRED
	sort (ASC | DESC) "ASC"
>

<!--
    A inverse-foreignkey element contains information on a foreign-key
    persistent attribute that implement the association on the database level.
  -->
<!ELEMENT inverse-foreignkey (documentation?)>
<!--
	The field-id-ref contains the id attribute of the field-descriptor
	in the class of the collection elements that is used as a foreign key.
  -->
<!ATTLIST inverse-foreignkey
	field-id-ref CDATA #IMPLIED
	field-ref CDATA #IMPLIED
>

<!--
    A fk-pointing-to-this-class element contains information on a foreign-key
    column of an intermediary table in a m:n scenario.
  -->
<!ELEMENT fk-pointing-to-this-class (documentation?)>
<!--
	The column attribute specifies the foreign-key column in the intermediary
	table that points to the class holding the collection.
  -->
<!ATTLIST fk-pointing-to-this-class
	column CDATA #REQUIRED
>

<!--
    A fk-pointing-to-element-class element contains information on a foreign-key
    column of an intermediary table in a m:n scenario.
  -->
<!ELEMENT fk-pointing-to-element-class (documentation?)>
<!--
	The column attribute specifies the foreign-key column in the intermediary
	table that points to the class of the collection elements.
  -->
<!ATTLIST fk-pointing-to-element-class
	column CDATA #REQUIRED
>


<!--
	a queryEnhancer element to enhance the 1:n query
  -->
<!ELEMENT query-customizer (
	documentation?,
	attribute*)>
<!ATTLIST query-customizer
	class CDATA #REQUIRED
>

<!--
    An index-descriptor describes an index by listing its columns.  It may be
    unique or not.
-->
<!ELEMENT index-descriptor (documentation?, index-column+)>
<!ATTLIST index-descriptor
    name CDATA #REQUIRED
    unique (true | false) "false">

<!--
    An index-column is just the name of a column in an index.
-->
<!ELEMENT index-column (documentation?)>
<!ATTLIST index-column
    name CDATA #REQUIRED>

<!--
	Identifies the procedure/function that should be used to handle
    insertions for a specific class-descriptor.

    The nested 'argument' elements define the argument list for the
    procedure/function as well as the source for each argument.

    The name attribute identifies the name of the procedure/function to use

    The return-field-ref identifies the field-descriptor that will receive
    the value that is returned by the procedure/function.  If the procedure/
    function does not include a return value, then do not specify a value
    for this attribute.

    The include-all-fields attribute indicates if all field-descriptors in
    the corresponding class-descriptor are to be passed to the procedure/
    function.  If include-all-fields is 'true', any nested 'argument'
    elements will be ignored.  In this case, values for all field-descriptors
    will be passed to the procedure/function.  The order of values that are
    passed to the procedure/function will match the order of field-descriptors
    on the corresponding class-descriptor.  If include-all-fields is false,
    then values will be passed to the procedure/function based on the
    information in the nested 'argument' elements.
  -->
<!ELEMENT insert-procedure
	(documentation?, (runtime-argument | constant-argument)*, attribute*)>
<!ATTLIST insert-procedure
	name CDATA #REQUIRED
    return-field-ref CDATA #IMPLIED
    include-all-fields (true | false) "false"
>

<!--
	Identifies the procedure/function that should be used to handle
    updates for a specific class-descriptor.

    The nested 'argument' elements define the argument list for the
    procedure/function as well as the source for each argument.

    The name attribute identifies the name of the procedure/function to use

    The return-field-ref identifies the field-descriptor that will receive
    the value that is returned by the procedure/function.  If the procedure/
    function does not include a return value, then do not specify a value
    for this attribute.

    The include-all-fields attribute indicates if all field-descriptors in
    the corresponding class-descriptor are to be passed to the procedure/
    function.  If include-all-fields is 'true', any nested 'argument'
    elements will be ignored.  In this case, values for all field-descriptors
    will be passed to the procedure/function.  The order of values that are
    passed to the procedure/function will match the order of field-descriptors
    on the corresponding class-descriptor.  If include-all-fields is false,
    then values will be passed to the procedure/function based on the
    information in the nested 'argument' elements.
  -->
<!ELEMENT update-procedure
	(documentation?, (runtime-argument | constant-argument)*, attribute*)>
<!ATTLIST update-procedure
	name CDATA #REQUIRED
    return-field-ref CDATA #IMPLIED
    include-all-fields (true | false) "false"
>

<!--
	Identifies the procedure/function that should be used to handle
    deletions for a specific class-descriptor.

    The nested 'runtime-argument' and 'constant-argument' elements define
    the argument list for the procedure/function as well as the source
    for each argument.

    The name attribute identifies the name of the procedure/function to use

    The return-field-ref identifies the field-descriptor that will receive
    the value that is returned by the procedure/function.  If the procedure/
    function does not include a return value, then do not specify a value
    for this attribute.

    The include-pk-only attribute indicates if all field-descriptors in
    the corresponding class-descriptor that are identified as being part of
    the primary key are to be passed to the procedure/function.  If
    include-pk-only is 'true', any nested 'argument' elements will be
    ignored.  In this case, values for all field-descriptors that are identified
    as being part of the primary key will be passed to the procedure/function.
    The order of values that are passed to the procedure/function will match
    the order of field-descriptors on the corresponding class-descriptor.
    If include-pk-only is false, then values will be passed to the procedure/
    function based on the information in the nested 'argument' elements.
  -->
<!ELEMENT delete-procedure
	(documentation?, (runtime-argument | constant-argument)*, attribute*)>
<!ATTLIST delete-procedure
	name CDATA #REQUIRED
    return-field-ref CDATA #IMPLIED
    include-pk-only (true | false) "false"
>
<!--
    Defines an argument that is passed to a procedure/function.  Each argument
    will be set to a value from a field-descriptor or null.

    The field-ref attribute identifies the field-descriptor in the corresponding
    class-descriptor that provides the value for this argument.  If this attribute
    is unspecified, then this argument will be set to null.
-->
<!ELEMENT runtime-argument
	(documentation?, attribute*)>
<!ATTLIST runtime-argument
	field-ref CDATA #IMPLIED
    return (true | false) "false"
>
<!--
    Defines a constant value that is passed to a procedure/function.

    The value attribute identifies the value that is passed to the procedure/
    function.
-->
<!ELEMENT constant-argument
	(documentation?, attribute*)>
<!ATTLIST constant-argument
    value CDATA #REQUIRED
>