1
|
/**
|
2
|
* Copyright (C) 2009 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
|
package eu.etaxonomy.cdm.api.facade;
|
10
|
|
11
|
import java.util.List;
|
12
|
import java.util.UUID;
|
13
|
|
14
|
import org.apache.commons.lang.StringUtils;
|
15
|
import org.apache.log4j.Logger;
|
16
|
|
17
|
import eu.etaxonomy.cdm.common.CdmUtils;
|
18
|
import eu.etaxonomy.cdm.model.agent.AgentBase;
|
19
|
import eu.etaxonomy.cdm.model.agent.Person;
|
20
|
import eu.etaxonomy.cdm.model.agent.Team;
|
21
|
import eu.etaxonomy.cdm.model.common.CdmBase;
|
22
|
import eu.etaxonomy.cdm.model.common.Language;
|
23
|
import eu.etaxonomy.cdm.model.common.TimePeriod;
|
24
|
import eu.etaxonomy.cdm.model.location.NamedArea;
|
25
|
import eu.etaxonomy.cdm.model.occurrence.FieldUnit;
|
26
|
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;
|
27
|
import eu.etaxonomy.cdm.model.term.Representation;
|
28
|
import eu.etaxonomy.cdm.strategy.StrategyBase;
|
29
|
import eu.etaxonomy.cdm.strategy.cache.agent.TeamDefaultCacheStrategy;
|
30
|
import eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy;
|
31
|
|
32
|
/**
|
33
|
* Cache strategy for {@link FieldUnit field units} handled in a DerivedUnitFacade.
|
34
|
*
|
35
|
* @author a.mueller
|
36
|
* @since 03.06.2010
|
37
|
*/
|
38
|
public class DerivedUnitFacadeFieldUnitCacheStrategy
|
39
|
extends StrategyBase
|
40
|
implements IIdentifiableEntityCacheStrategy<FieldUnit> {
|
41
|
|
42
|
private static final long serialVersionUID = 1578628591216605619L;
|
43
|
private static final Logger logger = Logger.getLogger(DerivedUnitFacadeFieldUnitCacheStrategy.class);
|
44
|
|
45
|
private static final UUID uuid = UUID.fromString("df4672c1-ce5c-4724-af6d-91e2b326d4a4");
|
46
|
|
47
|
@Override
|
48
|
protected UUID getUuid() {return uuid;}
|
49
|
|
50
|
private boolean includeEmptySeconds = false;
|
51
|
private boolean includeReferenceSystem = true;
|
52
|
|
53
|
@Override
|
54
|
public String getTitleCache(FieldUnit fieldUnit) {
|
55
|
DerivedUnitFacade facade;
|
56
|
String result = "";
|
57
|
DerivedUnitFacadeConfigurator config = DerivedUnitFacadeConfigurator.NewInstance();
|
58
|
config.setFirePropertyChangeEvents(false);
|
59
|
facade = DerivedUnitFacade.NewInstance(SpecimenOrObservationType.FieldUnit, fieldUnit, config);
|
60
|
result = getFieldData(facade);
|
61
|
result = addPlantDescription(result, facade);
|
62
|
result = CdmUtils.addTrailingDotIfNotExists(result);
|
63
|
facade.close();
|
64
|
return result;
|
65
|
}
|
66
|
|
67
|
protected String getFieldData(DerivedUnitFacade facade) {
|
68
|
|
69
|
FieldUnit fieldUnit = facade.getFieldUnit(false);
|
70
|
if (fieldUnit != null && fieldUnit.isProtectedTitleCache()){
|
71
|
return fieldUnit.getTitleCache();
|
72
|
}
|
73
|
|
74
|
String ALTITUDE_PREFIX = "alt. ";
|
75
|
// String ALTITUDE_POSTFIX = " m";
|
76
|
|
77
|
String result = "";
|
78
|
|
79
|
//country
|
80
|
String strCountry = null;
|
81
|
NamedArea country = facade.getCountry();
|
82
|
Representation repCountry = country == null ? null : country.getRepresentation(Language.DEFAULT());
|
83
|
strCountry = repCountry == null ? null: repCountry.getLabel();
|
84
|
result = CdmUtils.concat(", ", result, strCountry);
|
85
|
|
86
|
//locality
|
87
|
result = CdmUtils.concat(", ", result, facade.getLocalityText());
|
88
|
|
89
|
//elevation
|
90
|
if (StringUtils.isNotBlank(facade.absoluteElevationToString())){
|
91
|
result = CdmUtils.concat(", " , result, ALTITUDE_PREFIX);
|
92
|
result += facade.absoluteElevationToString();
|
93
|
}
|
94
|
|
95
|
//exact locality
|
96
|
if (facade.getExactLocation() != null){
|
97
|
String exactLocation = facade.getExactLocation().toSexagesimalString(this.includeEmptySeconds, this.includeReferenceSystem);
|
98
|
result = CdmUtils.concat(", ", result, exactLocation);
|
99
|
}
|
100
|
|
101
|
//ecology
|
102
|
result = CdmUtils.concat(", ", result, facade.getEcology());
|
103
|
|
104
|
//gathering period
|
105
|
//TODO period.toString ??
|
106
|
TimePeriod gatheringPeriod = facade.getGatheringPeriod();
|
107
|
result = CdmUtils.concat(", ", result, (gatheringPeriod == null? null : gatheringPeriod.toString()));
|
108
|
|
109
|
//collector (team) and field number
|
110
|
String collectorAndFieldNumber = getCollectorAndFieldNumber(facade);
|
111
|
result = CdmUtils.concat(", ", result, collectorAndFieldNumber);
|
112
|
|
113
|
return result;
|
114
|
}
|
115
|
|
116
|
protected String addPlantDescription(String result, DerivedUnitFacade facade) {
|
117
|
//plant description
|
118
|
result = CdmUtils.concat("; ", result, facade.getPlantDescription());
|
119
|
return result;
|
120
|
}
|
121
|
|
122
|
private String getCollectorAndFieldNumber(DerivedUnitFacade facade) {
|
123
|
String result = "";
|
124
|
AgentBase<?> collector = facade.getCollector();
|
125
|
String fieldNumber = facade.getFieldNumber();
|
126
|
Person primaryCollector = facade.getPrimaryCollector();
|
127
|
|
128
|
if (collector == null){
|
129
|
return fieldNumber;
|
130
|
}else if(collector.isProtectedTitleCache()){
|
131
|
return CdmUtils.concat(" ", collector.getTitleCache(), fieldNumber);
|
132
|
}else{
|
133
|
result = "";
|
134
|
Team collectorTeam;
|
135
|
if (collector.isInstanceOf(Person.class)){
|
136
|
collectorTeam = Team.NewInstance();
|
137
|
if (primaryCollector == null){
|
138
|
primaryCollector = CdmBase.deproxy(collector, Person.class);
|
139
|
}
|
140
|
collectorTeam.addTeamMember(primaryCollector);
|
141
|
} else if (collector.isInstanceOf(Team.class) && ! collector.isProtectedTitleCache() ){
|
142
|
collectorTeam = CdmBase.deproxy(collector, Team.class);
|
143
|
}else{
|
144
|
return CdmUtils.concat(" ", collector.getTitleCache(), fieldNumber);
|
145
|
}
|
146
|
|
147
|
int counter = 0;
|
148
|
boolean fieldNumberAdded = false;
|
149
|
List<Person> teamMembers = collectorTeam.getTeamMembers();
|
150
|
for (Person member : teamMembers){
|
151
|
counter++;
|
152
|
String sep = TeamDefaultCacheStrategy.teamConcatSeparator(collectorTeam, counter);
|
153
|
result = CdmUtils.concat(sep, result, getMemberString(member) );
|
154
|
if (member.equals(primaryCollector)){
|
155
|
result = addFieldNumber(result, fieldNumber);
|
156
|
fieldNumberAdded = true;
|
157
|
}
|
158
|
}
|
159
|
if (collectorTeam.isHasMoreMembers()){
|
160
|
result = TeamDefaultCacheStrategy.addHasMoreMembers(result);
|
161
|
}
|
162
|
if (! fieldNumberAdded){
|
163
|
result = addFieldNumber(result, fieldNumber);
|
164
|
}
|
165
|
return result;
|
166
|
}
|
167
|
}
|
168
|
|
169
|
private String addFieldNumber(String str, String fieldNumber) {
|
170
|
String result = CdmUtils.concat(" ", str, fieldNumber);
|
171
|
return result;
|
172
|
}
|
173
|
|
174
|
/**
|
175
|
* Strategy to format a collector team member name
|
176
|
* @param member
|
177
|
* @return
|
178
|
*/
|
179
|
private String getMemberString(Person member) {
|
180
|
if (StringUtils.isNotBlank(member.getFamilyName()) && ! member.isProtectedTitleCache() ){
|
181
|
String result = member.getFamilyName();
|
182
|
if (StringUtils.isNotBlank(member.getGivenName())){
|
183
|
result = member.getGivenName().substring(0,1) + ". " + result;
|
184
|
}
|
185
|
return result;
|
186
|
}else{
|
187
|
return member.getTitleCache();
|
188
|
}
|
189
|
}
|
190
|
|
191
|
private boolean testPrimaryCollectorInCollectorTeam(AgentBase collector, Person primaryCollector) {
|
192
|
if (collector.isInstanceOf(Person.class)){
|
193
|
return collector.equals(primaryCollector);
|
194
|
}else if (collector.isInstanceOf(Team.class)){
|
195
|
Team collectorTeam = CdmBase.deproxy(collector, Team.class);
|
196
|
return collectorTeam.getTeamMembers().contains(primaryCollector);
|
197
|
}else{
|
198
|
logger.warn("Collector is not of type person or team");
|
199
|
return false;
|
200
|
}
|
201
|
}
|
202
|
|
203
|
// ************************** GETTER / SETTER ******************************************************
|
204
|
|
205
|
public boolean isIncludeSeconds() {
|
206
|
return includeEmptySeconds;
|
207
|
}
|
208
|
public void setIncludeSeconds(boolean includeSeconds) {
|
209
|
this.includeEmptySeconds = includeSeconds;
|
210
|
}
|
211
|
|
212
|
public void setIncludeReferenceSystem(boolean includeReferenceSystem) {
|
213
|
this.includeReferenceSystem = includeReferenceSystem;
|
214
|
}
|
215
|
public boolean isIncludeReferenceSystem() {
|
216
|
return includeReferenceSystem;
|
217
|
}
|
218
|
}
|