eu.etaxonomy.cdm.strategy.cache.reference
Interface INomenclaturalReferenceCacheStrategy<T extends Reference>

Type Parameters:

T - The concrete Reference class this strategy applies for

All Superinterfaces:

IIdentifiableEntityCacheStrategy<T>, IReferenceBaseCacheStrategy<T>, IStrategy

All Known Implementing Classes:

ArticleDefaultCacheStrategy, BookDefaultCacheStrategy, BookSectionDefaultCacheStrategy, CdDvdDefaultCacheStrategy, GenericDefaultCacheStrategy, InRefDefaultCacheStrategyBase, NomRefDefaultCacheStrategyBase, ThesisDefaultCacheStrategy

public interface INomenclaturalReferenceCacheStrategy<T extends Reference>
extends IReferenceBaseCacheStrategy<T>

A reference cache rendering strategy for all subclasses implementing INomenclaturalReference.

Author:

a.mueller

Method Summary

String	getBeforeMicroReference() Returns the character sequence before the micro reference (e.g.
String	getNomenclaturalCitation(T nomenclaturalReference, String microReference) Returns a formatted string containing the entire citation used for nomenclatural purposes based on the reference supplied - including (abbreviated) title but not authors - and on the given details. The returned string is build according to the corresponding cache strategy.
String	getTitleCache(T nomenclaturalReference) returns the composed scientific taxon name string without authors nor year
String	getTokenizedNomenclaturalTitel(T referenceBase) returns the composed author string

Methods inherited from interface eu.etaxonomy.cdm.strategy.cache.reference.IReferenceBaseCacheStrategy

getCitation

Method Detail

getTitleCache

String getTitleCache(T nomenclaturalReference)

returns the composed scientific taxon name string without authors nor year

Specified by:

getTitleCache in interface IIdentifiableEntityCacheStrategy<T extends Reference>

Parameters:

object -

Returns:

getTokenizedNomenclaturalTitel

String getTokenizedNomenclaturalTitel(T referenceBase)

returns the composed author string

Parameters:

object -

Returns:

getBeforeMicroReference

String getBeforeMicroReference()

Returns the character sequence before the micro reference (e.g. ": ")

Returns:

getNomenclaturalCitation

String getNomenclaturalCitation(T nomenclaturalReference,
                                String microReference)

Returns a formatted string containing the entire citation used for nomenclatural purposes based on the reference supplied - including (abbreviated) title but not authors - and on the given details.
The returned string is build according to the corresponding cache strategy.

Parameters:

nomenclaturalReference - The nomenclatural reference

microReference - the string with the details (generally pages) corresponding to the nomenclatural reference supplied as the first argument

Returns:

the formatted string representing the nomenclatural citation

See Also:

INomenclaturalReference.getNomenclaturalCitation(String), name.TaxonNameBase#getNomenclaturalReference(), strategy.cache.reference.INomenclaturalReferenceCacheStrategy