DescriptionHelper class.
* * @author p.ciardelli * @author n.hoffmann - * @created 02.04.2009 - * @version 1.0 */ public class DescriptionHelper { - + /** * Returns whatever the element's title cache equivalent is, * depending on its class. @@ -64,11 +90,37 @@ public class DescriptionHelper { * @param language a {@link eu.etaxonomy.cdm.model.common.Language} object. * @return a {@link java.lang.String} object. */ - public static String getCache(DescriptionElementBase element, + public static String getCache(DescriptionElementBase element, Language language) { + + String mainElementLabel= null; + DescriptionBase descr = element.getInDescription(); + descr = CdmBase.deproxy(descr, DescriptionBase.class); + + if (descr != null){ + if (descr.isInstanceOf(TaxonDescription.class)){ + Taxon taxon = CdmBase.deproxy(descr, TaxonDescription.class).getTaxon(); + if (taxon != null){ + mainElementLabel = taxon.getTitleCache(); + } + }else if (descr.isInstanceOf(SpecimenDescription.class)){ + SpecimenOrObservationBase specimen = CdmBase.deproxy(descr, SpecimenDescription.class).getDescribedSpecimenOrObservation(); + if (specimen != null){ + mainElementLabel = specimen.getTitleCache(); + } + }else if (descr.isInstanceOf(TaxonNameDescription.class)){ + TaxonName name = CdmBase.deproxy(descr, TaxonNameDescription.class).getTaxonName(); + if (name != null){ + mainElementLabel = name.getTitleCache(); + } + } + } + + String cache = null; if (element instanceof TextData) { - cache = ((TextData) element).getText(language); + //cache = ((TextData) element).getText(language); + cache = "Text Data"; } if (element instanceof CommonTaxonName) { cache = ((CommonTaxonName) element).getName(); @@ -80,16 +132,16 @@ public class DescriptionHelper { }else{ cache = "No taxon chosen"; } - + } if (element instanceof Distribution) { Distribution distribution = (Distribution) element; - + NamedArea area = distribution.getArea(); if(area != null){ cache = area.getLabel(); - - PresenceAbsenceTermBase status = distribution.getStatus(); + + PresenceAbsenceTerm status = distribution.getStatus(); if (status == null){ cache += ", no status"; }else { @@ -97,7 +149,11 @@ public class DescriptionHelper { } } } - return cache == null ? "" : cache; + String result = cache == null ? "" : cache; + if (isNotBlank(mainElementLabel)){ + result = CdmUtils.concat(" ", result, "(" + mainElementLabel + ")"); + } + return result; } /** @@ -110,7 +166,7 @@ public class DescriptionHelper { public static String getCache(DescriptionElementBase element) { return getCache(element, CdmStore.getDefaultLanguage()); } - + /** * Set whatever the element's title cache equivalent is, * depending on its class. @@ -124,21 +180,19 @@ public class DescriptionHelper { if (element instanceof TextData) { ((TextData) element).putText(language, value); return; - } - if (element instanceof CommonTaxonName) { + }else if (element instanceof CommonTaxonName) { ((CommonTaxonName) element).setName(value); return; - } - if (element instanceof TaxonInteraction) { - - } - if(element instanceof Distribution){ - StoreUtil.warn(DescriptionHelper.class, "trying to set cache on distribution, don't know what to do at the moment."); + }else if (element instanceof TaxonInteraction) { + + }else if(element instanceof Distribution){ + MessagingUtils.warn(DescriptionHelper.class, "trying to set cache on distribution, don't know what to do at the moment."); return; + }else{ + MessagingUtils.warn(DescriptionHelper.class, "No matching subclass found for DescriptionElementBase object, 'cache' not set."); } - StoreUtil.warn(DescriptionHelper.class, "No matching subclass found for DescriptionElementBase object, 'cache' not set."); } - + /** * Set whatever the element's title cache equivalent is, * depending on its class, using the default language. @@ -150,10 +204,8 @@ public class DescriptionHelper { String value) { setCache(element, value, CdmStore.getDefaultLanguage()); } - - /* (non-Javadoc) - * @see eu.etaxonomy.taxeditor.bulkeditor.referencingobjects.IReferencingObjectsService#getObjectDescription(java.lang.Object) - */ + + /** *getObjectDescription
* @@ -161,49 +213,305 @@ public class DescriptionHelper { * @return a {@link java.lang.String} object. */ public static String getObjectDescription(Object element) { + String resultString = null; if (element instanceof IdentifiableEntity) { try{ - return ((IdentifiableEntity) element).getTitleCache(); + resultString = ((IdentifiableEntity) element).getTitleCache(); }catch(LazyInitializationException e){ String result = "No Session to initialize title cache for IdentifiableEntity"; - StoreUtil.error(DescriptionHelper.class, result, e); - return "TODO: " + result; + MessagingUtils.error(DescriptionHelper.class, result, e); + resultString = "TODO: " + result; } - } - if (element instanceof OriginalSourceBase) { + }else if (element instanceof OriginalSourceBase) { try{ - OriginalSourceBase originalSource = (OriginalSourceBase) element; - ISourceable sourcedObject = originalSource.getSourcedObj(); - String sourceObjectTitle = ""; - if(sourcedObject instanceof IIdentifiableEntity){ - sourceObjectTitle = ((IdentifiableEntity) sourcedObject).getTitleCache(); - }else if(sourcedObject instanceof DescriptionElementBase){ - sourceObjectTitle = "Element for description: " + ((DescriptionElementBase) sourcedObject).getInDescription().getTitleCache(); - }else{ - throw new IllegalStateException("Unknown ISourceable object for given OriginalSourceBase"); - } - - return CdmUtils.concat("; ", new String[]{originalSource.getIdNamespace(), originalSource.getIdInSource(), sourceObjectTitle}); + OriginalSourceBase originalSource = (OriginalSourceBase) element; +// ISourceable sourcedObject = originalSource.getSourcedObj(); + //due to #5743 the bidirectionality for sourced object had to be removed + String sourceObjectTitle = "sourced object data not available (#5743)"; +// if(sourcedObject instanceof IIdentifiableEntity){ +// sourceObjectTitle = ((IdentifiableEntity) sourcedObject).getTitleCache(); +// }else if(sourcedObject instanceof DescriptionElementBase){ +// sourceObjectTitle = "Element for description: " + ((DescriptionElementBase) sourcedObject).getInDescription().getTitleCache(); +// }else{ +// throw new IllegalStateException("Unknown ISourceable object for given OriginalSourceBase"); +// } + + resultString = CdmUtils.concat("; ", new String[]{originalSource.getIdNamespace(), originalSource.getIdInSource(), sourceObjectTitle}); }catch(LazyInitializationException e){ String result = "Error initializing title cache for ISourceable of an OriginalSourceBase"; - StoreUtil.error(DescriptionHelper.class, result, e); - return "TODO: " + result; + MessagingUtils.error(DescriptionHelper.class, result, e); + resultString = "TODO: " + result; } + }else if (element instanceof LanguageStringBase) { + resultString = ((LanguageStringBase) element).getText(); + }else if (element instanceof DescriptionElementBase) { + resultString = getCache((DescriptionElementBase) element); + }else if (element instanceof RelationshipBase) { + resultString = getCache((RelationshipBase) element); + }else if (element instanceof TypeDesignationBase) { + resultString = getCache((TypeDesignationBase) element); + }else if (element instanceof HomotypicalGroup) { + resultString = getCache((HomotypicalGroup) element); + }else if (element instanceof TaxonNode) { + resultString = getCache((TaxonNode) element); + }else if (element instanceof DeterminationEvent) { + resultString = getCache((DeterminationEvent) element); + }else if (element instanceof GatheringEvent){ + resultString = getCache((GatheringEvent) element); + }else if (element instanceof Marker) { + Marker marker = (Marker) element; + MarkerType type = marker.getMarkerType(); + resultString = (type == null ? "- no marker type -" : marker.getMarkerType().getLabel()) + " (" + marker.getFlag() + ")"; + }else if (element instanceof User) { + User user = (User) element; + resultString = user.getUsername(); + }else if (element instanceof Group) { + Group group = (Group) element; + resultString = group.getName(); + }else if (element instanceof KeyStatement) { + KeyStatement keyStatement = (KeyStatement) element; + resultString = getCache(keyStatement); + }else{ + // TODO write return texts for HomotypicalGroup, etc. + resultString = element.toString(); } - if (element instanceof LanguageStringBase) { - return ((LanguageStringBase) element).getText(); + + if (resultString == null){ + resultString = element.toString(); } - if (element instanceof DescriptionElementBase) { - return getCache((DescriptionElementBase) element); + return resultString; + } + + private static String getCache(GatheringEvent gatheringEvent){ + String ALTITUDE_PREFIX = "alt. "; + final String METER = "m"; + + String result = ""; + + //collector + AgentBase collector = CdmBase.deproxy(gatheringEvent.getCollector()); + String collectorStr = collector == null? null : collector.getTitleCache(); + result = CdmUtils.concat(", ", result, collectorStr); + + //gathering period + TimePeriod gatheringPeriod = gatheringEvent.getTimeperiod(); + result = CdmUtils.concat(", ", result, (gatheringPeriod == null? null : gatheringPeriod.toString())); + + //country + String strCountry = null; + NamedArea country = gatheringEvent.getCountry(); + Representation repCountry = country == null ? null : country.getRepresentation(Language.DEFAULT()); + strCountry = repCountry == null ? null: repCountry.getLabel(); + result = CdmUtils.concat(", ", result, strCountry); + + //locality + LanguageString locality = gatheringEvent.getLocality(); + if (locality != null) { + result = CdmUtils.concat(", ", result, locality.getText()); } - if (element instanceof Marker) { - Marker marker = (Marker) element; - return marker.getMarkerType().getLabel() + " (" + marker.getFlag() + ")"; + + //elevation + String elevationStr; + if (isNotBlank(gatheringEvent.getAbsoluteElevationText())){ + elevationStr = gatheringEvent.getAbsoluteElevationText(); + }else{ + String text = gatheringEvent.getAbsoluteElevationText(); + Integer min = gatheringEvent.getAbsoluteElevation(); + Integer max = gatheringEvent.getAbsoluteElevationMax(); + elevationStr = DerivedUnitFacade.distanceString(min, max, text, METER); + } + if (isNotBlank(elevationStr)){ + result = CdmUtils.concat(", " , result, ALTITUDE_PREFIX); + result += elevationStr; + } + + //exact locality + if (gatheringEvent.getExactLocation() != null){ + String exactLocation = gatheringEvent.getExactLocation().toSexagesimalString(false, false); + result = CdmUtils.concat(", ", result, exactLocation); + } + + return result; + } + + + private static String getCache(DeterminationEvent detEvent) { + //taxon + String taxonStr = null; + TaxonName taxonName = detEvent.getTaxonName(); + TaxonBase taxon = detEvent.getTaxon(); + if (taxonName != null){ + taxonStr = taxonName.getTitleCache(); + } + if (isBlank(taxonStr) && taxon != null){ + taxonStr = taxon.getTitleCache(); + } + if (isBlank(taxonStr)){ + taxonStr = "no or unlabled taxon"; + } + + + //unit + SpecimenOrObservationBase unit = detEvent.getIdentifiedUnit(); + String unitStr; + if (unit != null){ + unitStr = unit.getTitleCache(); + if (isBlank(unitStr)){ + unitStr = "Unlabled unit"; + } + }else{ + unitStr = "no unit"; + } + + String result = CdmUtils.concat(" determined as ", unitStr, taxonStr); + + return result; + } + + private static String getCache(TaxonNode taxonNode) { + String result = ""; + Classification classification = taxonNode.getClassification(); + if (classification != null){ + String classificationStr = classification.getName() == null ? "" : classification.getName().getText(); + result = CdmUtils.concat("" , result, classificationStr); + if (isBlank(result)){ + result = classification.toString(); + } + } + String parentStr; + TaxonNode parentNode = taxonNode.getParent(); + if (parentNode == null){ + parentStr = "no parent"; + }else{ + Taxon parentTaxon = parentNode.getTaxon(); + if (parentTaxon == null){ + parentStr = "no parent taxon"; + }else{ + TaxonName parentName = parentTaxon.getName(); + if (parentName == null){ + parentStr = "child of " + parentTaxon.getTitleCache(); + }else{ + parentStr = "child of " + parentName.getTitleCache(); + } + } } - // TODO write return texts for NameRelationship, HomotypicalGroup, SpecimenTypeDesignation, etc. - return element.toString(); + result = CdmUtils.concat(": ", result, parentStr); + + return result; } + private static String getCache(TypeDesignationBase designation) { + designation = CdmBase.deproxy(designation); + TypeDesignationStatusBase status = designation.getTypeStatus(); + SetgetObjectClassname
* @@ -213,7 +521,7 @@ public class DescriptionHelper { public static String getObjectClassname(Object element) { return element.getClass().getSimpleName(); } - + /** *getFeatureNodeContainerText
* @@ -221,10 +529,16 @@ public class DescriptionHelper { * @return a {@link java.lang.String} object. */ public static String getFeatureNodeContainerText(FeatureNodeContainer element) { + String result = null; if(element.getFeatureNode() != null && element.getFeatureNode().getFeature() != null){ - return element.getFeatureNode().getFeature().getLabel(CdmStore.getDefaultLanguage()); + result = element.getFeatureNode().getFeature().getLabel(CdmStore.getDefaultLanguage()); + } else{ + return "No label set"; } - return "No label set"; + if (result == null){ + result = element.getFeatureNode().getFeature().getLabel(); + } + return result; } /** @@ -235,7 +549,7 @@ public class DescriptionHelper { */ public static String getQuantitativeDataText(QuantitativeData element) { TextData textData = quantitativeDescriptionBuilder.build(element, getLanguageList()); - + return textData.getText(CdmStore.getDefaultLanguage()); } @@ -247,17 +561,17 @@ public class DescriptionHelper { */ public static String getCategoricalDataText(CategoricalData element) { TextData textData = categoricalDescriptionBuilder.build(element, getLanguageList()); - + return textData.getText(CdmStore.getDefaultLanguage()); } - + private static ListgetDistributionText
@@ -266,18 +580,18 @@ public class DescriptionHelper { * @return a {@link java.lang.String} object. */ public static String getDistributionText(Distribution element) { - + String text = "EMPTY"; - - Distribution distribution = (Distribution) element; - + + Distribution distribution = element; + NamedArea area = distribution.getArea(); if(area != null){ - + text = NamedArea.labelWithLevel(area, CdmStore.getDefaultLanguage()); - - PresenceAbsenceTermBase status = distribution.getStatus(); - + + PresenceAbsenceTerm status = distribution.getStatus(); + if (status != null) { text += ", " + status.getLabel(); }else{ @@ -301,15 +615,15 @@ public class DescriptionHelper { return "No title."; } - - + + /** *getElementText
* * @param element a {@link eu.etaxonomy.cdm.model.description.TextData} object. * @return a {@link java.lang.String} object. */ - public static String getElementText(TextData element) { + public static String getElementText(TextData element) { String text = null; if(element.getFeature().equals(Feature.CITATION())){ text = ""; @@ -321,7 +635,7 @@ public class DescriptionHelper { text += " [ " + source.getNameUsedInSource().getTitleCache() + " ]"; } } - if(CdmUtils.isEmpty(text)){ + if(isBlank(text)){ text = "No sources provided"; } }else{ @@ -329,9 +643,9 @@ public class DescriptionHelper { LanguageString languageString = element.getPreferredLanguageString(languages); text = languageString != null ? languageString.getText() : null; } - return CdmUtils.isEmpty(text) ? "No text provided" : text; + return isBlank(text) ? "No text provided" : text; } - + /** *getTaxonInteractionText
* @@ -340,13 +654,13 @@ public class DescriptionHelper { */ public static String getTaxonInteractionText(TaxonInteraction element) { String text = ""; - Taxon taxon2 = ((TaxonInteraction) element).getTaxon2(); + Taxon taxon2 = element.getTaxon2(); if(taxon2 != null && taxon2.getName() != null){ text = taxon2.getName().getTitleCache(); }else{ text = "No taxon chosen"; } - + return text; } @@ -381,10 +695,10 @@ public class DescriptionHelper { if (text == null || text.length() == 0) { text = "No label provided"; } - - return "Description: " + text; + + return text; } - + /** *getIndividualsAssociationText
* @@ -396,7 +710,7 @@ public class DescriptionHelper { if(derivedUnit != null){ return derivedUnit.getTitleCache(); } - return "No text provided"; + return "No unit chosen"; } /** @@ -406,6 +720,7 @@ public class DescriptionHelper { * @return a {@link java.lang.String} object. */ public static String getLabel(Object element){ + String noLabelString = "[no label]"; if (element instanceof FeatureNodeContainer){ return getFeatureNodeContainerText((FeatureNodeContainer) element); } @@ -413,19 +728,27 @@ public class DescriptionHelper { return getDescriptionText((DescriptionBase) element); } else if(element instanceof CategoricalData){ - return getCategoricalDataText((CategoricalData) element); + String categoricalDataText = getCategoricalDataText((CategoricalData) element); + if(categoricalDataText==null || categoricalDataText.isEmpty()){ + categoricalDataText = noLabelString; + } + return categoricalDataText; } else if (element instanceof CommonTaxonName) { - return getCommonNameText((CommonTaxonName) element); + return getCommonNameText((CommonTaxonName) element); } else if (element instanceof Distribution) { - return getDistributionText((Distribution) element); - } + return getDistributionText((Distribution) element); + } else if (element instanceof IndividualsAssociation) { return getIndividualsAssociationText((IndividualsAssociation) element); } else if (element instanceof QuantitativeData) { - return getQuantitativeDataText((QuantitativeData) element); + String quantitativeDataText = getQuantitativeDataText((QuantitativeData) element); + if(quantitativeDataText==null || quantitativeDataText.isEmpty()){ + quantitativeDataText = noLabelString; + } + return quantitativeDataText; } else if (element instanceof TaxonInteraction) { return getTaxonInteractionText((TaxonInteraction) element); @@ -437,4 +760,12 @@ public class DescriptionHelper { return element.toString(); } } + + private static boolean isNotBlank(String str){ + return StringUtils.isNotBlank(str); + } + + private static boolean isBlank(String str){ + return StringUtils.isBlank(str); + } }