eu.etaxonomy.cdm.strategy.cache.name
Interface INameCacheStrategy<T extends TaxonNameBase>

Type Parameters:

T - The concrete TaxonName class this strategy applies for

All Superinterfaces:

IIdentifiableEntityCacheStrategy<T>, IStrategy

All Known Subinterfaces:

INonViralNameCacheStrategy<T>

All Known Implementing Classes:

BacterialNameDefaultCacheStrategy, BotanicNameDefaultCacheStrategy, NameCacheStrategyBase, NonViralNameDefaultCacheStrategy, ZooNameDefaultCacheStrategy, ZooNameNoMarkerCacheStrategy

public interface INameCacheStrategy<T extends TaxonNameBase>
extends IIdentifiableEntityCacheStrategy<T>

A name cache rendering strategy for all TaxonNameBase subclasses. Different TaxonNameBase subclasses could have different strategies.

Author:

a.mueller

Method Summary

String	getFullTitleCache(T taxonNameBase) Returns the full title cache as a string.
String	getFullTitleCache(T nonViralName, HTMLTagRules htmlTagRules) Returns the full title cache tagged by html tags according to tag rules.
String	getNameCache(T taxonNameBase) Returns the name cache as a string.
List<TaggedText>	getTaggedFullTitle(T taxonName) Same as getTaggedTitle(TaxonNameBase) but also includes the reference and the nomenclatural status in the result.
List<TaggedText>	getTaggedName(T taxonName) Same as getTaggedTitle(TaxonNameBase) but not including authorship.
List<TaggedText>	getTaggedTitle(T taxonName) Returns a list of name typified tokens that together make up the name (including authorship etc.).
String	getTitleCache(T nonViralName, HTMLTagRules htmlTagRules) Returns the title cache tagged by html tags according to tag rules.

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

getTitleCache

Method Detail

getTaggedTitle

List<TaggedText> getTaggedTitle(T taxonName)

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]

Parameters:

taxonNameBase -

Returns:

the tagged list, null if taxonName is null

getTaggedFullTitle

List<TaggedText> getTaggedFullTitle(T taxonName)

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

Parameters:

taxonName -

Returns:

getTaggedName

List<TaggedText> getTaggedName(T taxonName)

Same as getTaggedTitle(TaxonNameBase) but not including authorship.

Parameters:

taxonName -

Returns:

getFullTitleCache

String getFullTitleCache(T taxonNameBase)

Returns the full title cache as a string. The full title cache contains the name cache, followed by the nomencl. reference, followed by the nomencl. status

Parameters:

taxonNameBase -

Returns:

getFullTitleCache

String getFullTitleCache(T nonViralName,
                         HTMLTagRules htmlTagRules)

Returns the full title cache tagged by html tags according to tag rules.

Parameters:

nonViralName -

htmlTagRules -

Returns:

getNameCache

String getNameCache(T taxonNameBase)

Returns the name cache as a string.

Parameters:

taxonNameBase -

Returns:

getTitleCache

String getTitleCache(T nonViralName,
                     HTMLTagRules htmlTagRules)

Returns the title cache tagged by html tags according to tag rules.

Parameters:

nonViralName -

htmlTagRules -

Returns: