|
1
|
/**
|
|
2
|
* Copyright (C) 2007 EDIT
|
|
3
|
* European Distributed Institute of Taxonomy
|
|
4
|
* http://www.e-taxonomy.eu
|
|
5
|
*
|
|
6
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
|
7
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
|
8
|
*/
|
|
9
|
|
|
10
|
package eu.etaxonomy.cdm.print;
|
|
11
|
|
|
12
|
import java.util.List;
|
|
13
|
import java.util.UUID;
|
|
14
|
|
|
15
|
import org.jdom.Element;
|
|
16
|
|
|
17
|
/**
|
|
18
|
* This interface provides a simplified interface to the API offered by the cdmlib-remote project.
|
|
19
|
*
|
|
20
|
* @author n.hoffmann
|
|
21
|
* @created Jul 16, 2010
|
|
22
|
* @version 1.0
|
|
23
|
*/
|
|
24
|
public interface IXMLEntityFactory {
|
|
25
|
|
|
26
|
/***************** Configuration methods *********************/
|
|
27
|
|
|
28
|
/**
|
|
29
|
* Returns a list of classifications that are present in the CDM Server associated with this factory
|
|
30
|
*
|
|
31
|
* @returna list of elements
|
|
32
|
*/
|
|
33
|
public List<Element> getClassifications();
|
|
34
|
|
|
35
|
/**
|
|
36
|
* Returns taxonomically included taxa for a given taxon or classification.
|
|
37
|
*
|
|
38
|
* @param treeNode
|
|
39
|
* @return a list of elements
|
|
40
|
*/
|
|
41
|
public List<Element> getChildNodes(Element treeNode);
|
|
42
|
|
|
43
|
/**
|
|
44
|
* Returns the TaxonNode for the given uuid
|
|
45
|
*
|
|
46
|
* @param taxonNodeUuid
|
|
47
|
* @return an element
|
|
48
|
*/
|
|
49
|
public Element getTaxonNode(UUID taxonNodeUuid);
|
|
50
|
|
|
51
|
/*
|
|
52
|
* Returns the taxonNodes for a specific name
|
|
53
|
*/
|
|
54
|
public Element getTaxonNodesByName(String taxonName, String classification);
|
|
55
|
|
|
56
|
/**
|
|
57
|
* Returns the {@link FeatureTree FeatureTrees} available with this CDM Server
|
|
58
|
*
|
|
59
|
* @return a list of elements
|
|
60
|
*/
|
|
61
|
public List<Element> getFeatureTrees();
|
|
62
|
|
|
63
|
/**
|
|
64
|
*
|
|
65
|
*
|
|
66
|
* @return
|
|
67
|
*/
|
|
68
|
public Element getFeatureTree(UUID uuid);
|
|
69
|
|
|
70
|
/**
|
|
71
|
*
|
|
72
|
* @param uuid
|
|
73
|
* @return
|
|
74
|
*/
|
|
75
|
public Element getFeatureNode(UUID uuid);
|
|
76
|
|
|
77
|
/**
|
|
78
|
*
|
|
79
|
* @param uuid
|
|
80
|
* @return
|
|
81
|
*/
|
|
82
|
public Element getFeatureForFeatureNode(UUID uuid);
|
|
83
|
|
|
84
|
/***************** Harvesting methods *********************/
|
|
85
|
|
|
86
|
/**
|
|
87
|
* Retrieves to taxon associated with the given taxon node
|
|
88
|
*
|
|
89
|
* @param taxonNodeElement
|
|
90
|
* @return an element
|
|
91
|
*/
|
|
92
|
public Element getTaxonForTaxonNode(Element taxonNodeElement);
|
|
93
|
|
|
94
|
/**
|
|
95
|
* Fully initializes an accepted taxon
|
|
96
|
*
|
|
97
|
* @param taxonElement
|
|
98
|
* @return an element
|
|
99
|
*/
|
|
100
|
public Element getAcceptedTaxonElement(Element taxonElement);
|
|
101
|
|
|
102
|
/**
|
|
103
|
* Fully initializes a reference
|
|
104
|
*
|
|
105
|
* @param referenceElement
|
|
106
|
* @return an element
|
|
107
|
*/
|
|
108
|
public List<Element> getReferences(Element referenceElement);
|
|
109
|
|
|
110
|
/**
|
|
111
|
* Initializes the complete synonym for an accepted taxon
|
|
112
|
*
|
|
113
|
* @param taxonElement
|
|
114
|
* @return a list of elements
|
|
115
|
*/
|
|
116
|
public List<Element> getSynonymy(Element taxonElement);
|
|
117
|
|
|
118
|
/**
|
|
119
|
* Initialize type designations for a name elemt
|
|
120
|
*
|
|
121
|
* @param nameElement
|
|
122
|
* @return
|
|
123
|
*/
|
|
124
|
public List<Element> getTypeDesignations(Element nameElement);
|
|
125
|
|
|
126
|
/**
|
|
127
|
* Initializes complete taxon descriptions for an accepted taxon
|
|
128
|
*
|
|
129
|
* @param taxonElement
|
|
130
|
* @return a list of elements
|
|
131
|
*/
|
|
132
|
public Element getDescriptions(Element taxonElement);
|
|
133
|
|
|
134
|
/**
|
|
135
|
* Gets the PolytomousKey as a List of LinkedPolytomousKeyNodeRowDto objects.
|
|
136
|
*
|
|
137
|
* @param taxonElement
|
|
138
|
* @return a list of elements
|
|
139
|
*/
|
|
140
|
public Element getPolytomousKey(Element taxonElement);
|
|
141
|
|
|
142
|
/**
|
|
143
|
* Gets the Media associated with a particular taxon
|
|
144
|
* @param taxonElement
|
|
145
|
* @return
|
|
146
|
*/
|
|
147
|
public List<Element> getMedia(Element taxonElement);
|
|
148
|
}
|