X-Git-Url: https://dev.e-taxonomy.eu/gitweb/cdmlib.git/blobdiff_plain/37e6b280e0c861e81be8956b125a84cf4ef344fa..8e2a4925e9ca1c14d3bcc7d6006f55e4f0361096:/src/docbkx/identifiable-entities.xml diff --git a/src/docbkx/identifiable-entities.xml b/src/docbkx/identifiable-entities.xml index c4bbf3e2fd..0fd65670ec 100644 --- a/src/docbkx/identifiable-entities.xml +++ b/src/docbkx/identifiable-entities.xml @@ -1,33 +1,85 @@ - - - - Identifiable Entities - - - Likely to change - Globally unique identifiers, their use and implementation are still an unresolved topic. The implementaton of objects that are identifiable and resolvable in a global sense must, given an open world, reflect the standards and best practices being used by the community as a whole. Consequently this area of the CDM is likely to change to reflect this. - -
- Some entities in the CDM extend IdentifiableEntity. In general there is one or two abstract base classes that extend IdentifiableEntity in each package. These classes represent important objects that an application might want to share with another application (and hence, publish globally unique identifiers for). - Current implemetation of the GUID in the CDM is based on the LSID Resolution Service implementation of the CATE project. Each IdentifiableEntity has an lsid property. See the section on GUID Resolution to see how the CDM Java Library makes it easier for you to manage and publish your data. -
-
- - <varname>titleCache</varname> and <varname>cacheStrategyGenerator</varname> - Classes that extend IdentifiableEntity have a titleCache attribute. This property is used represent the object (for example, in a list of objects or the title for a page displaying metadata about that object). The titleCache is also used by default when sorting lists of entities. Applications are free to use other properties or combinations of properties in representing objects and can supply their own implementations of the interfaces in the eu.etaxonomy.cdm.strategy.cache package. If you do wish to supply custom cache strategies, you will need to inject them into your data entities, overriding the default strategy (using something like Springs spring-managed configuration mechanism). -
-
- Recording Provenance using <varname>originalSource</varname> - -
-
- Indicating ownership and use using <varname>rights</varname> property - Identifiable entities are significant enough that users may wish to indicate ownership of the copyright of the thing that they represent, or to provide some statement of a licence under which that data may be used. This information is held in the rights element as a series of Right objects, each representing a single rights statement. - Note that the assertation of rights in the data is not the same as access rights in terms of application-level security which is dealt with in a later section. -
- + + + + Identifiable Entities + + + + Likely to change + + Globally unique identifiers, their use and implementation are still + an unresolved topic. The implementaton of objects that are identifiable + and resolvable in a global sense must, given an open world, reflect the + standards and best practices being used by the community as a whole. + Consequently this area of the CDM is likely to change to reflect + this. + + +
+ Some entities in the CDM extend + IdentifiableEntity. In general there is one or two + abstract base classes that extend + IdentifiableEntity in each package. These classes + represent important objects that an application might want to share with + another application (and hence, publish globally unique identifiers + for). + + Current implemetation of the GUID in the CDM is based on the LSID Resolution + Service implementation of the CATE project. Each + IdentifiableEntity has an lsid + property. See the section on GUID + Resolution to see how the CDM Java Library makes it easier for you + to manage and publish your data. +
+ +
+ + + <varname>titleCache</varname> and + <varname>cacheStrategyGenerator</varname> + + Classes that extend IdentifiableEntity have a + titleCache attribute. This property is used represent + the object (for example, in a list of objects or the title for a page + displaying metadata about that object). The titleCache + is also used by default when sorting lists of entities. Applications are + free to use other properties or combinations of properties in representing + objects and can supply their own implementations of the interfaces in the + eu.etaxonomy.cdm.strategy.cache package. If you do wish + to supply custom cache strategies, you will need to inject them into your + data entities, overriding the default strategy (using something like + Spring's spring-managed configuration + mechanism). +
+ +
+ Recording Provenance using + <varname>originalSource</varname> + + +
+ +
+ Indicating ownership and use using <varname>rights</varname> + property + + Identifiable entities are significant enough that users may wish to + indicate ownership of the copyright of the thing that they represent, or + to provide some statement of a licence under which that data may be used. + This information is held in the rights element as a + series of Right objects, each representing a single + rights statement. + + Note that the assertation of rights in the data is not the same as + access rights in terms of application-level security which is dealt with + in a later section. +
+