eu.etaxonomy.cdm.model.reference
Interface INomenclaturalReference

All Superinterfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, IMatchable, IMergable, IParsable, IReference, ISourceable<IdentifiableSource>, IVersionableEntity

All Known Subinterfaces:

IArticle, IBook, IBookSection, IGeneric

All Known Implementing Classes:

OpenUrlReference, Reference

public interface INomenclaturalReference
extends IReference

Interface providing methods for nomenclatural references.

Version:

1.0

Author:

m.doering

Field Summary

static String

MICRO_REFERENCE_TOKEN

Method Summary

String	getNomenclaturalCitation(String microReference) Returns a formatted string containing the reference citation excluding authors but including the details as used in a taxon name.
String	getYear() Returns a string representation for the year of publication / creation of a reference.
void	setDatePublished(TimePeriod datePublished) Sets the date when the reference was published.

Methods inherited from interface eu.etaxonomy.cdm.model.reference.IReference

getAuthorTeam, getDatePublished, getReferenceAbstract, getTitle, getType, getUri, isOfType, setAuthorTeam, setCacheStrategy, setReferenceAbstract, setTitle, setType, setUri

Methods inherited from interface eu.etaxonomy.cdm.model.common.IIdentifiableEntity

addCredit, addCredit, addExtension, addRights, generateTitle, getCredits, getCredits, getData, getExtensions, getLsid, getRights, getTitleCache, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeRights, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString

Methods inherited from interface eu.etaxonomy.cdm.model.common.ISourceable

addSource, addSource, getSources, removeSource

Methods inherited from interface eu.etaxonomy.cdm.model.common.IAnnotatableEntity

addAnnotation, addMarker, getAnnotations, getMarkers, hasMarker, hasMarker, removeAnnotation, removeMarker

Methods inherited from interface eu.etaxonomy.cdm.model.common.IVersionableEntity

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from interface eu.etaxonomy.cdm.model.common.ICdmBase

getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid

Methods inherited from interface eu.etaxonomy.cdm.model.common.IParsable

addParsingProblem, getParsingProblem, getParsingProblems, getProblemEnds, getProblemStarts, hasProblem, hasProblem, removeParsingProblem, setParsingProblem, setProblemEnds, setProblemStarts

Field Detail

MICRO_REFERENCE_TOKEN

static final String MICRO_REFERENCE_TOKEN

See Also:

Constant Field Values

Method Detail

getNomenclaturalCitation

String getNomenclaturalCitation(String microReference)

Returns a formatted string containing the reference citation excluding authors but including the details as used in a taxon name.

Specified by:

getNomenclaturalCitation in interface IReference

Parameters:

microReference - the detail, e.g. a page number, a figure, ...

Returns:

String

getYear

String getYear()

Returns a string representation for the year of publication / creation of a reference.

setDatePublished

void setDatePublished(TimePeriod datePublished)

Description copied from interface: IReference

Sets the date when the reference was published.

Specified by:

setDatePublished in interface IReference