Cdm Identifiable Entity » History » Version 10
Andreas Müller, 04/07/2022 04:34 PM
1 | 10 | Andreas Müller | # Identifiable Entities |
---|---|---|---|
2 | 1 | Andreas Müller | |
3 | 10 | Andreas Müller | *This page is to discuss the use of Identifiable Entities* |
4 | 1 | Andreas Müller | |
5 | ---- |
||
6 | 3 | Andreas Müller | |
7 | 10 | Andreas Müller | {{toc}} |
8 | 3 | Andreas Müller | |
9 | 10 | Andreas Müller | {{child_pages(depth=1)}} |
10 | 4 | Andreas Müller | |
11 | ### Definition |
||
12 | |||
13 | |||
14 | Superclass for the primary CDM classes that can be referenced from outside via LSIDs and contain a simple generated title string as a label for human reading. |
||
15 | 1 | Andreas Müller | |
16 | 7 | Andreas Müller | All subclasses inherit the ability to store additional properties that are stored as source:"trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/Extension.java", basically a string value with a type term. |
17 | 4 | Andreas Müller | |
18 | 7 | Andreas Müller | Any number of right statements can be attached as well as multiple source:"trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/OriginalSource.java" objects. |
19 | 4 | Andreas Müller | |
20 | Original sources carry a reference to the source, an ID within that source and the original title/label of this object as it was used in that source (originalNameString). |
||
21 | 1 | Andreas Müller | |
22 | 4 | Andreas Müller | A Taxon for example that was taken from 2 sources like FaunaEuropaea and IPNI would have two originalSource objects. |
23 | 1 | Andreas Müller | |
24 | 7 | Andreas Müller | The original source representing that taxon as it was found in IPNI would contain IPNI as the reference, the IPNI id of the taxon and the name of the taxon exactly as it was used in IPNI. |
25 | 4 | Andreas Müller | |
26 | |||
27 | 7 | Andreas Müller | see source:"trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/IdentifiableEntity.java@latest#L50" |
28 | 4 | Andreas Müller | |
29 | |||
30 | |||
31 | ### Best Practices |
||
32 | |||
33 | |||
34 | |||
35 | #### use of title cache |
||
36 | |||
37 | |||
38 | * To use the title cache in a multi-language environment in an expedient way the title cache should be created independent from the language. This means that the according cache strategy may not make use of language dependent attributes. |
||
39 | |||
40 | * If the above can not be assured one can not use the title cache for sorting in a database query. Sorting instead must be done either by the client application or by using representations (representations are language dependent). Be aware of the drawbacks of this method being a result of the missing restrictions on representations to be available for each any language needed. |
||
41 | |||
42 | |||
43 | ... |