eu.etaxonomy.cdm.model.reference
Interface IReference

All Superinterfaces:

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

All Known Subinterfaces:

IArticle, IBook, IBookSection, ICdDvd, IDatabase, IGeneric, IInProceedings, IJournal, IMap, INomenclaturalReference, IPatent, IPersonalCommunication, IPrintedUnitBase, IPrintSeries, IProceedings, IPublicationBase, IReport, ISectionBase, IThesis, IVolumeReference, IWebPage

All Known Implementing Classes:

OpenUrlReference, Reference

public interface IReference
extends IIdentifiableEntity, IParsable, IMergable, IMatchable

The upmost interface for references (information sources).

This class corresponds to:

• PublicationCitation according to the TDWG ontology
• Publication according to the TCS
• Reference according to the ABCD schema

Method Summary

TeamOrPersonBase	getAuthorTeam() Returns the references author(s)
TimePeriod	getDatePublished() Returns the date when the reference was published as a TimePeriod
String	getNomenclaturalCitation(String microReference) Returns the citation string including the detail (micro reference) information.
String	getReferenceAbstract() Returns the references abstract which is a summary of the content
String	getTitle() Returns the references title
ReferenceType	getType() Returns the reference type
URI	getUri() Returns the Uniform Resource Identifier (URI) corresponding to this reference.
boolean	isOfType(ReferenceType type) Returns true if the type of the reference is the same as the passed parameter
void	setAuthorTeam(TeamOrPersonBase authorTeam) Sets the references author(s)
void	setCacheStrategy(IReferenceBaseCacheStrategy cacheStrategy) Sets the cache strategy for this reference
void	setDatePublished(TimePeriod datePublished) Sets the date when the reference was published.
void	setReferenceAbstract(String referenceAbstract) Sets the references abstract which is a summary of the content
void	setTitle(String title) Sets the references title
void	setType(ReferenceType type) Sets the reference type
void	setUri(URI uri)

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

Method Detail

getType

ReferenceType getType()

Returns the reference type

setType

void setType(ReferenceType type)

Sets the reference type

Parameters:

type -

isOfType

boolean isOfType(ReferenceType type)

Returns true if the type of the reference is the same as the passed parameter

Parameters:

type -

Returns:

boolean

getAuthorTeam

TeamOrPersonBase getAuthorTeam()

Returns the references author(s)

setAuthorTeam

void setAuthorTeam(TeamOrPersonBase authorTeam)

Sets the references author(s)

getTitle

String getTitle()

Returns the references title

setTitle

void setTitle(String title)

Sets the references title

Parameters:

title -

getDatePublished

TimePeriod getDatePublished()

Returns the date when the reference was published as a TimePeriod

setDatePublished

void setDatePublished(TimePeriod datePublished)

Sets the date when the reference was published.

getUri

URI getUri()

Returns the Uniform Resource Identifier (URI) corresponding to this reference. An URI is a string of characters used to identify a resource on the Internet.

Returns:

the URI of this reference

setUri

void setUri(URI uri)

See Also:

getUri()

getReferenceAbstract

String getReferenceAbstract()

Returns the references abstract which is a summary of the content

setReferenceAbstract

void setReferenceAbstract(String referenceAbstract)

Sets the references abstract which is a summary of the content

Parameters:

referenceAbstract -

getNomenclaturalCitation

String getNomenclaturalCitation(String microReference)

Returns the citation string including the detail (micro reference) information. E.g. if the references title cache is L., Sp. Pl. 3. 1757 the nomenclatural citation may be something like L., Sp. Pl. 3: 45. 1757

Parameters:

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

Returns:

String

setCacheStrategy

void setCacheStrategy(IReferenceBaseCacheStrategy cacheStrategy)

Sets the cache strategy for this reference

Parameters:

cacheStrategy -