eu.etaxonomy.cdm.strategy.cache.name

Class NonViralNameDefaultCacheStrategy

java.lang.Object

eu.etaxonomy.cdm.strategy.StrategyBase

eu.etaxonomy.cdm.strategy.cache.name.NameCacheStrategyBase

eu.etaxonomy.cdm.strategy.cache.name.NonViralNameDefaultCacheStrategy

All Implemented Interfaces:

IIdentifiableEntityCacheStrategy<TaxonName>, INameCacheStrategy, INonViralNameCacheStrategy, IStrategy, Serializable

Direct Known Subclasses:

ZooNameNoMarkerCacheStrategy

public class NonViralNameDefaultCacheStrategy
extends NameCacheStrategyBase
implements INonViralNameCacheStrategy

This class is a default implementation for the INonViralNameCacheStrategy interface.
The method implements a cache strategy for botanical names so no method has to be overwritten by a subclass for botanic names. Where differing from this default botanic name strategy other subclasses should overwrite the existing methods, e.g. a CacheStrategy for zoological names should overwrite getAuthorAndExAuthor

Author:

a.mueller

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CharSequence	basionymAuthorCombinationAuthorSeperator
protected String	basionymEnd
protected String	basionymStart
protected String	exAuthorSeperator
protected String	nameAuthorSeperator
protected String	zooAuthorYearSeperator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NonViralNameDefaultCacheStrategy()

Method Summary

Modifier and Type	Method and Description
protected void	addAppendedTaggedPhrase(List<TaggedText> tags, INonViralName nonViralName) Adds the tag for the appended phrase if an appended phrase exists
protected void	addInfraGenericPart(INonViralName name, List<TaggedText> tags, String infraGenericMarker, String infraGenEpi) Default implementation for the infrageneric part of a name.
protected List<TaggedText>	doGetTaggedTitle(TaxonName nonViralName)
protected String	getAuthorAndExAuthor(INomenclaturalAuthor author, INomenclaturalAuthor exAuthor) Returns the AuthorCache part for a combination of an author and an ex author.
String	getAuthorshipCache(TaxonName taxonName) Returns the composed author string.
CharSequence	getBasionymAuthorCombinationAuthorSeperator() String that separates the basionym/original_combination author part from the combination author part
String	getBasionymEnd() String the basionym author part ends with e.g.
String	getBasionymStart() String the basionym author part starts with e.g.
String	getExAuthorSeperator() String to separate ex author from author.
protected List<TaggedText>	getGenusOrUninomialTaggedNameCache(INonViralName nonViralName) Returns the tag list for an genus or higher taxon.
protected List<TaggedText>	getInfraGenusTaggedNameCache(INonViralName nonViralName) Returns the tag list for an infrageneric taxon (including species aggregates).
protected List<TaggedText>	getInfraSpeciesTaggedNameCache(INonViralName nonViralName, boolean includeMarker) Creates the tag list for an infraspecific taxon.
protected List<TaggedText>	getInfraSpeciesTaggedNameCache(TaxonName nonViralName) Creates the tag list for an infraspecific taxon.
String	getLastEpithet(TaxonName taxonName) Returns the last epithet of the name (i.e.
String	getNameAuthorSeperator() String that separates the NameCache part from the AuthorCache part
List<TaggedText>	getNomStatusTags(TaxonName nonViralName, boolean includeSeparatorBefore, boolean includeSeparatorAfter) Get TaggedText for the nomenclatural status part
protected String	getNonCacheAuthorshipCache(TaxonName nonViralName) Returns the authorshipcache string for the atomized authorship fields.
protected List<TaggedText>	getRanklessTaggedNameCache(INonViralName nonViralName) Returns the tag list for rankless taxa.
protected List<TaggedText>	getSpeciesAggregateTaggedCache(INonViralName nonViralName) Returns the tag list for a species aggregate (or similar) taxon. Possible ranks for a species aggregate are "aggr.", "species group", ...
protected List<TaggedText>	getSpeciesTaggedNameCache(INonViralName nonViralName) Returns the tag list for a species taxon.
List<TaggedText>	getTaggedFullTitle(TaxonName nonViralName) Same as INameCacheStrategy.getTaggedTitle(TaxonName) but also includes the reference and the nomenclatural status in the result.
List<TaggedText>	getTaggedName(TaxonName nonViralName) Returns the tag list of the name part (without author and reference).
List<TaggedText>	getTaggedTitle(TaxonName nonViralName) Returns a list of name typified tokens that together make up the name (including authorship etc.).
UUID	getUuid()
String	getZooAuthorYearSeperator()
protected String	getZoologicalNonCacheAuthorshipCache(TaxonName nonViralName)
protected boolean	nameIncludesAuthorship(INonViralName nonViralName) Checks if the given name should include the author in it's cached version. This is usually the case but not for species aggregates.
static NonViralNameDefaultCacheStrategy	NewInstance()
void	setBasionymAuthorCombinationAuthorSeperator(CharSequence basionymAuthorCombinationAuthorSeperator)
void	setBasionymEnd(String basionymEnd)
void	setBasionymStart(String basionymStart)
void	setExAuthorSeperator(String exAuthorSeperator)
void	setNameAuthorSeperator(String nameAuthorSeperator)
void	setZooAuthorYearSeperator(String authorYearSeperator)

Methods inherited from class eu.etaxonomy.cdm.strategy.cache.name.NameCacheStrategyBase

addOriginalSpelling, createString, createString, getFullTitleCache, getFullTitleCache, getNameCache, getTitleCache, getTitleCache

Methods inherited from class eu.etaxonomy.cdm.strategy.StrategyBase

isBlank, isCollection, isNotBlank, isPrimitive, isSingleCdmBaseObject, isUserType, Nz

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface eu.etaxonomy.cdm.strategy.cache.name.INameCacheStrategy

getFullTitleCache, getFullTitleCache, getNameCache, getTitleCache

Methods inherited from interface eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy

getTitleCache

Field Detail

nameAuthorSeperator

protected String nameAuthorSeperator

basionymStart

protected String basionymStart

basionymEnd

protected String basionymEnd

exAuthorSeperator

protected String exAuthorSeperator

basionymAuthorCombinationAuthorSeperator

protected CharSequence basionymAuthorCombinationAuthorSeperator

zooAuthorYearSeperator

protected String zooAuthorYearSeperator

Constructor Detail

NonViralNameDefaultCacheStrategy

protected NonViralNameDefaultCacheStrategy()

Method Detail

getUuid

public UUID getUuid()

Specified by:

getUuid in class StrategyBase

NewInstance

public static NonViralNameDefaultCacheStrategy NewInstance()

getNameAuthorSeperator

public String getNameAuthorSeperator()

String that separates the NameCache part from the AuthorCache part

Returns:

setNameAuthorSeperator

public void setNameAuthorSeperator(String nameAuthorSeperator)

getBasionymStart

public String getBasionymStart()

String the basionym author part starts with e.g. '('. This should correspond with the basionymEnd attribute

Returns:

setBasionymStart

public void setBasionymStart(String basionymStart)

getBasionymEnd

public String getBasionymEnd()

String the basionym author part ends with e.g. ')'. This should correspond with the basionymStart attribute

Returns:

setBasionymEnd

public void setBasionymEnd(String basionymEnd)

getExAuthorSeperator

public String getExAuthorSeperator()

String to separate ex author from author.

Returns:

setExAuthorSeperator

public void setExAuthorSeperator(String exAuthorSeperator)

getBasionymAuthorCombinationAuthorSeperator

public CharSequence getBasionymAuthorCombinationAuthorSeperator()

String that separates the basionym/original_combination author part from the combination author part

Returns:

setBasionymAuthorCombinationAuthorSeperator

public void setBasionymAuthorCombinationAuthorSeperator(CharSequence basionymAuthorCombinationAuthorSeperator)

getZooAuthorYearSeperator

public String getZooAuthorYearSeperator()

setZooAuthorYearSeperator

public void setZooAuthorYearSeperator(String authorYearSeperator)

getAuthorshipCache

public String getAuthorshipCache(TaxonName taxonName)

Description copied from interface: INameCacheStrategy

Returns the composed author string. Returns null for viral names.

Specified by:

getAuthorshipCache in interface INameCacheStrategy

Returns:

getNonCacheAuthorshipCache

protected String getNonCacheAuthorshipCache(TaxonName nonViralName)

Returns the authorshipcache string for the atomized authorship fields. Does not use the authorship field.

Parameters:

nonViralName -

Returns:

Throws:

NullPointerException - if nonViralName is null.

getZoologicalNonCacheAuthorshipCache

protected String getZoologicalNonCacheAuthorshipCache(TaxonName nonViralName)

getAuthorAndExAuthor

protected String getAuthorAndExAuthor(INomenclaturalAuthor author,
                                      INomenclaturalAuthor exAuthor)

Returns the AuthorCache part for a combination of an author and an ex author. This applies on combination authors as well as on basionym/orginal combination authors. The correct order is exAuthor ex author though some botanist do not know about and do it the other way round. (see 46.4-46.6 ICBN (Vienna Code, 2006))

Parameters:

author - the author

exAuthor - the ex-author

Returns:

nameIncludesAuthorship

protected boolean nameIncludesAuthorship(INonViralName nonViralName)

Checks if the given name should include the author in it's cached version.
This is usually the case but not for species aggregates.

Parameters:

nonViralName -

Returns:

getTaggedFullTitle

public List<TaggedText> getTaggedFullTitle(TaxonName nonViralName)

Description copied from interface: INameCacheStrategy

Same as INameCacheStrategy.getTaggedTitle(TaxonName) but also includes the reference and the nomenclatural status in the result.

Specified by:

getTaggedFullTitle in interface INameCacheStrategy

Overrides:

getTaggedFullTitle in class NameCacheStrategyBase

Returns:

getNomStatusTags

public List<TaggedText> getNomStatusTags(TaxonName nonViralName,
                                         boolean includeSeparatorBefore,
                                         boolean includeSeparatorAfter)

Description copied from interface: INameCacheStrategy

Get TaggedText for the nomenclatural status part

Specified by:

getNomStatusTags in interface INameCacheStrategy

Overrides:

getNomStatusTags in class NameCacheStrategyBase

Parameters:

nonViralName -

tags -

Returns:

getTaggedTitle

public List<TaggedText> getTaggedTitle(TaxonName nonViralName)

Description copied from interface: INameCacheStrategy

Returns a list of name typified tokens that together make up the name (including authorship etc.). A token (taggedText) is a string and a type which indicates which part of a name the text belongs to. Types may be name (indicating a core part of the name, e.g. a name epithet), author (indicating an authorship part), rank, reference, etc.).
Example: ["Abies"/name,"alba"/name,Rank.SUBSPECIES/rank,"alpina"/name, "Greuther (L.)"/authorship]

Specified by:

getTaggedTitle in interface INameCacheStrategy

Overrides:

getTaggedTitle in class NameCacheStrategyBase

Returns:

the tagged list, null if taxonName is null

getTaggedName

public List<TaggedText> getTaggedName(TaxonName nonViralName)

Returns the tag list of the name part (without author and reference).

Specified by:

getTaggedName in interface INameCacheStrategy

Parameters:

nonViralName -

Returns:

getRanklessTaggedNameCache

protected List<TaggedText> getRanklessTaggedNameCache(INonViralName nonViralName)

Returns the tag list for rankless taxa.

Parameters:

nonViralName -

Returns:

getGenusOrUninomialTaggedNameCache

protected List<TaggedText> getGenusOrUninomialTaggedNameCache(INonViralName nonViralName)

Returns the tag list for an genus or higher taxon.

Parameters:

nonViralName -

Returns:

getInfraGenusTaggedNameCache

protected List<TaggedText> getInfraGenusTaggedNameCache(INonViralName nonViralName)

Returns the tag list for an infrageneric taxon (including species aggregates).

Parameters:

nonViralName -

Returns:

See Also:

#getSpeciesAggregateTaggedCache(NonViralName)

addInfraGenericPart

protected void addInfraGenericPart(INonViralName name,
                                   List<TaggedText> tags,
                                   String infraGenericMarker,
                                   String infraGenEpi)

Default implementation for the infrageneric part of a name. This is usually the infrageneric marker and the infrageneric epitheton. But may be implemented differently e.g. for zoological names the infrageneric epitheton may be surrounded by brackets and the marker left out.

Parameters:

nonViralName -

tags -

infraGenericMarker -

getSpeciesAggregateTaggedCache

protected List<TaggedText> getSpeciesAggregateTaggedCache(INonViralName nonViralName)

Returns the tag list for a species aggregate (or similar) taxon.
Possible ranks for a species aggregate are "aggr.", "species group", ...

Parameters:

nonViralName -

Returns:

getSpeciesTaggedNameCache

protected List<TaggedText> getSpeciesTaggedNameCache(INonViralName nonViralName)

Returns the tag list for a species taxon.

Parameters:

nonViralName -

Returns:

getInfraSpeciesTaggedNameCache

protected List<TaggedText> getInfraSpeciesTaggedNameCache(TaxonName nonViralName)

Creates the tag list for an infraspecific taxon. In include is true the result will contain

Parameters:

nonViralName -

Returns:

getInfraSpeciesTaggedNameCache

protected List<TaggedText> getInfraSpeciesTaggedNameCache(INonViralName nonViralName,
                                                          boolean includeMarker)

Creates the tag list for an infraspecific taxon. If include is true the result will contain the infraspecific marker (e.g. "var.")

Parameters:

nonViralName -

includeMarker -

Returns:

addAppendedTaggedPhrase

protected void addAppendedTaggedPhrase(List<TaggedText> tags,
                                       INonViralName nonViralName)

Adds the tag for the appended phrase if an appended phrase exists

Parameters:

tags -

nonViralName -

getLastEpithet

public String getLastEpithet(TaxonName taxonName)

Description copied from interface: INonViralNameCacheStrategy

Returns the last epithet of the name (i.e. uninomial if generic or above, infrageneric epithet if infrageneric, specific epithet if species and infraspecific epithet if infraspecific, possibly with other information (e.g. ranks in infraspecific names, indications of hybrid status etc)). This is suitable for rendering the name in context of the name which taxonomically includes it i.e. taxonomic hierarchies or checklists organised into a hierarchy where the initial epithets are removed for brevity

Specified by:

getLastEpithet in interface INonViralNameCacheStrategy

Returns:

doGetTaggedTitle

protected List<TaggedText> doGetTaggedTitle(TaxonName nonViralName)

Specified by:

doGetTaggedTitle in class NameCacheStrategyBase