eu.etaxonomy.cdm.model.reference
Class Reference<S extends IReferenceBaseCacheStrategy>

java.lang.Object
  eu.etaxonomy.cdm.model.common.CdmBase
      eu.etaxonomy.cdm.model.common.VersionableEntity
          eu.etaxonomy.cdm.model.common.AnnotatableEntity
              eu.etaxonomy.cdm.model.common.IdentifiableEntity<S>
                  eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity<S>
                      eu.etaxonomy.cdm.model.reference.Reference<S>

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, IParsable, ISourceable<IdentifiableSource>, IVersionableEntity, IMediaDocumented, IMediaEntity, IArticle, IBook, IBookSection, ICdDvd, IDatabase, IGeneric, IInProceedings, IJournal, INomenclaturalReference, IPatent, IPersonalCommunication, IPrintedUnitBase, IPrintSeries, IProceedings, IPublicationBase, IReference, IReport, ISectionBase, IThesis, IVolumeReference, IWebPage, IMatchable, IMergable, Serializable, Cloneable

Direct Known Subclasses:

OpenUrlReference

@Entity
@InReference(groups=Level2.class)
@ReferenceCheck(groups=Level2.class)
public class Reference<S extends IReferenceBaseCacheStrategy>
extends IdentifiableMediaEntity<S>
implements INomenclaturalReference, IArticle, IBook, IPatent, IDatabase, IJournal, IBookSection, ICdDvd, IGeneric, IInProceedings, IProceedings, IPrintSeries, IReport, IThesis, IWebPage, IPersonalCommunication, IReference, Cloneable

The upmost (abstract) class 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

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

protected String	edition
protected String	editor
protected Reference	inReference
protected Institution	institution
protected String	isbn
protected String	issn
protected String	organization
protected String	pages
protected String	placePublished
protected String	publisher
protected Institution	school
protected String	series
protected String	seriesPart
protected ReferenceType	type
protected String	volume

Fields inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

cacheStrategy, NOT_PROTECTED, PROTECTED, protectedTitleCache, titleCache

Fields inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

annotations, markers

Fields inherited from class eu.etaxonomy.cdm.model.common.CdmBase

uuid

Fields inherited from interface eu.etaxonomy.cdm.model.reference.INomenclaturalReference

MICRO_REFERENCE_TOKEN

Constructor Summary

protected	Reference()
protected	Reference(ReferenceType type)

Method Summary

void	addParsingProblem(ParserProblem warning) Adds a parsing problem to the list of parsing problems
IArticle	castReferenceToArticle() Generates, according to the cache strategy assigned to this reference, a string that identifies this reference and returns it.
IBook	castReferenceToBook()
IBookSection	castReferenceToBookSection()
ICdDvd	castReferenceToCdDvd()
IDatabase	castReferenceToDatabase()
IGeneric	castReferenceToGeneric()
IInProceedings	castReferenceToInProceedings()
IJournal	castReferenceToJournal()
IMap	castReferenceToMap()
IPatent	castReferenceToPatent()
IPersonalCommunication	castReferenceToPersonalCommunication()
IPrintSeries	castReferenceToPrintSeries()
IProceedings	castReferenceToProceedings()
IReport	castReferenceToReport()
IThesis	castReferenceToThesis()
IWebPage	castReferenceToWebPage()
Object	clone() Clones this reference.
String	generateTitle()
TeamOrPersonBase	getAuthorTeam() Returns the author (team) who created the content of this reference.
String	getCitation() Returns a formatted string containing the entire reference citation, including authors, corresponding to this reference.
TimePeriod	getDatePublished() Returns the date (mostly only the year) of publication / creation of this reference.
String	getDatePublishedString() Convenience method that returns a string representation for the publication date / creation of this reference.
String	getEdition() Returns this books edition
String	getEditor() Returns the editor of this reference
IBook	getInBook() Returns this book sections book
IJournal	getInJournal() Returns this articles journal.
IProceedings	getInProceedings() Returns the proceedings for these inProceedings
Reference	getInReference() Returns the in-reference of this reference.
IPrintSeries	getInSeries() Returns the print series of this printed unit
Institution	getInstitution() Returns the institution that published this report
String	getIsbn() Returns this books isbn (international standard book number)
String	getIssn() Returns the ISSN (International Standard Serial Number)
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	getOrganization() Returns the organization which published this reference
String	getPages() Returns the pages this reference covers in its in-reference.
int	getParsingProblem() Returns an integer value indicating whether the used parser method was able to parse a string successfully into this object (0) or not (!=0).
List<ParserProblem>	getParsingProblems() Returns a list of all warnings and errors that have been recognized during the parsing and not yet handled.
String	getPlacePublished() Returns the string which represents the place where this reference was published
int	getProblemEnds() Returns the integer value of the position where a parsing problem ends.
int	getProblemStarts() Returns the integer value of the position where a parsing problem starts.
String	getPublisher() Returns the publisher string for this reference
String	getReferenceAbstract() Returns the references abstract which is a summary of the content
Institution	getSchool() Returns the school which published this thesis
String	getSeries() Returns the series information for this article
String	getSeriesPart() Returns the series part for this printed unit
String	getTitle() Returns a string representing the title of this reference.
ReferenceType	getType() Returns the reference type
URI	getUri() Returns the Uniform Resource Identifier (URI) corresponding to this reference.
String	getVolume() Returns the volume of a reference.
String	getYear() Returns a string representation for the year of publication / creation of this reference.
boolean	hasDatePublished()
boolean	hasProblem() Returns true if any parsing problem (warning or error) exists.
boolean	hasProblem(ParserProblem problem) Returns true, if the specified problem exists.
boolean	isNomenclaturallyRelevant() Returns "true" if the isNomenclaturallyRelevant flag is set.
boolean	isOfType(ReferenceType type) Whether this reference is of the given type
void	removeParsingProblem(ParserProblem problem) Removes a parsing problem from the list of parsing problems.
void	setAuthorTeam(TeamOrPersonBase authorTeam) Sets the references author(s)
void	setCacheStrategy(ArticleDefaultCacheStrategy cacheStrategy)
void	setCacheStrategy(BookDefaultCacheStrategy cacheStrategy)
void	setCacheStrategy(BookSectionDefaultCacheStrategy cacheStrategy)
void	setCacheStrategy(GenericDefaultCacheStrategy cacheStrategy)
void	setCacheStrategy(IReferenceBaseCacheStrategy iReferenceBaseCacheStrategy) Sets the cache strategy for this reference
void	setCacheStrategy(JournalDefaultCacheStrategy cacheStrategy)
void	setCacheStrategy(ReferenceBaseDefaultCacheStrategy cacheStrategy)
void	setDatePublished(TimePeriod datePublished) Sets the date when the reference was published.
void	setEdition(String edition) Sets this books edition
void	setEditor(String editor) Sets the editor for this reference
void	setInBook(IBook book) Sets this book sections book.
void	setInJournal(IJournal journal) Sets this articles journal
void	setInProceedings(IProceedings proceeding) Sets the proceedings for these inProceedings
void	setInReference(Reference inReference) Sets the in-reference of this reference.
void	setInSeries(IPrintSeries inSeries) Sets the print series of this printed unit
void	setInstitution(Institution institution) Sets the institution that published this report
void	setIsbn(String isbn) Sets this books isbn (international standard book number)
void	setIssn(String issn) Sets the ISSN (International Standard Serial Number)
void	setNomenclaturallyRelevant(boolean nomenclaturallyRelevant)
void	setOrganization(String organization) Sets the organization which published this reference
void	setPages(String pages) Sets the pages that this reference covers in its in-reference
void	setParsingProblem(int parsingProblem)
void	setPlacePublished(String placePublished) Sets the string which represents the place where this reference was published
void	setProblemEnds(int end)
void	setProblemStarts(int start)
void	setPublisher(String publisher) Sets the publisher string for this reference
void	setPublisher(String publisher, String placePublished) Sets the publisher and the publication place
void	setReferenceAbstract(String referenceAbstract) Sets the references abstract which is a summary of the content
void	setSchool(Institution school) Sets the school which published this thesis
void	setSeries(String series) Sets the series information for this article
void	setSeriesPart(String seriesPart) Sets the series part for this printed unit
void	setTitle(String title) Sets the references title
void	setType(ReferenceType type) Sets the reference type
void	setUri(URI uri)
void	setVolume(String volume) Sets the volume of the reference.

Methods inherited from class eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity

addMedia, getMedia, removeMedia

Methods inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

addCredit, addCredit, addExtension, addExtension, addRights, addSource, addSource, compareTo, getCacheStrategy, getCredits, getCredits, getData, getExtensions, getExtensions, getExtensions, getLsid, getRights, getSources, getTitleCache, getTruncatedCache, initListener, isProtectedTitleCache, regenerateTitleCache, removeCredit, removeCredit, removeExtension, removeRights, removeSource, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString

Methods inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

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

Methods inherited from class eu.etaxonomy.cdm.model.common.VersionableEntity

equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from class eu.etaxonomy.cdm.model.common.CdmBase

addPropertyChangeListener, addPropertyChangeListener, clone, deproxy, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUuid, hashCode, hasListeners, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isInstanceOf, removePropertyChangeListener, removePropertyChangeListener, setCreated, setCreatedBy, setId, setUuid

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

addCredit, addCredit, addExtension, addRights, 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

Field Detail

type

protected ReferenceType type

editor

@Field
@Length(max=255)
protected String editor

series

@Field
@Length(max=255)
protected String series

volume

@Field
@Length(max=255)
protected String volume

pages

@Field
@Length(max=255)
protected String pages

edition

@Field
@Length(max=255)
protected String edition

isbn

@Field
@Length(max=255)
@Pattern(regexp="(?=.{13}$)\\d{1,5}([- ])\\d{1,7}\\1\\d{1,6}\\1(\\d|X)$",
         groups=Level2.class,
         message="{eu.etaxonomy.cdm.model.reference.Reference.isbn.message}")
protected String isbn

issn

@Field
@Length(max=255)
@Pattern(regexp="(?=.{9}$)\\d{4}([- ])\\d{4} (\\d|X)$",
         groups=Level2.class,
         message="{eu.etaxonomy.cdm.model.reference.Reference.issn.message}")
protected String issn

seriesPart

@Field
@Length(max=255)
protected String seriesPart

organization

@Field
@Length(max=255)
protected String organization

publisher

@Field
@Length(max=255)
protected String publisher

placePublished

@Field
@Length(max=255)
protected String placePublished

institution

@IndexedEmbedded
protected Institution institution

school

@IndexedEmbedded
protected Institution school

inReference

protected Reference inReference

Constructor Detail

Reference

protected Reference()

Reference

protected Reference(ReferenceType type)

Method Detail

getEditor

public String getEditor()

Description copied from interface: IPrintedUnitBase

Returns the editor of this reference

Specified by:

getEditor in interface IGeneric

Specified by:

getEditor in interface IPrintedUnitBase

setEditor

public void setEditor(String editor)

Description copied from interface: IPrintedUnitBase

Sets the editor for this reference

Specified by:

setEditor in interface IGeneric

Specified by:

setEditor in interface IPrintedUnitBase

getSeries

public String getSeries()

Description copied from interface: IArticle

Returns the series information for this article

Specified by:

getSeries in interface IArticle

Specified by:

getSeries in interface IGeneric

setSeries

public void setSeries(String series)

Description copied from interface: IArticle

Sets the series information for this article

Specified by:

setSeries in interface IArticle

Specified by:

setSeries in interface IGeneric

getVolume

public String getVolume()

Description copied from interface: IVolumeReference

Returns the volume of a reference.

Specified by:

getVolume in interface IVolumeReference

setVolume

public void setVolume(String volume)

Description copied from interface: IVolumeReference

Sets the volume of the reference.

Specified by:

setVolume in interface IVolumeReference

getPages

public String getPages()

Description copied from interface: ISectionBase

Returns the pages this reference covers in its in-reference. E.g. if this reference is an article it may cover the pages 34-45 in the according journal.

Specified by:

getPages in interface IGeneric

Specified by:

getPages in interface ISectionBase

setPages

public void setPages(String pages)

Description copied from interface: ISectionBase

Sets the pages that this reference covers in its in-reference

Specified by:

setPages in interface IGeneric

Specified by:

setPages in interface ISectionBase

See Also:

ISectionBase.getPages()

getEdition

public String getEdition()

Description copied from interface: IBook

Returns this books edition

Specified by:

getEdition in interface IBook

setEdition

public void setEdition(String edition)

Description copied from interface: IBook

Sets this books edition

Specified by:

setEdition in interface IBook

getIsbn

public String getIsbn()

Description copied from interface: IBook

Returns this books isbn (international standard book number)

Specified by:

getIsbn in interface IBook

setIsbn

public void setIsbn(String isbn)

Description copied from interface: IBook

Sets this books isbn (international standard book number)

Specified by:

setIsbn in interface IBook

getIssn

public String getIssn()

Description copied from interface: IJournal

Returns the ISSN (International Standard Serial Number)

Specified by:

getIssn in interface IJournal

setIssn

public void setIssn(String issn)

Description copied from interface: IJournal

Sets the ISSN (International Standard Serial Number)

Specified by:

setIssn in interface IJournal

getSeriesPart

public String getSeriesPart()

Description copied from interface: IPrintedUnitBase

Returns the series part for this printed unit

Specified by:

getSeriesPart in interface IPrintedUnitBase

setSeriesPart

public void setSeriesPart(String seriesPart)

Description copied from interface: IPrintedUnitBase

Sets the series part for this printed unit

Specified by:

setSeriesPart in interface IPrintedUnitBase

getOrganization

public String getOrganization()

Description copied from interface: IProceedings

Returns the organization which published this reference

Specified by:

getOrganization in interface IProceedings

setOrganization

public void setOrganization(String organization)

Description copied from interface: IProceedings

Sets the organization which published this reference

Specified by:

setOrganization in interface IProceedings

getPublisher

public String getPublisher()

Description copied from interface: IPublicationBase

Returns the publisher string for this reference

Specified by:

getPublisher in interface IPublicationBase

setPublisher

public void setPublisher(String publisher)

Description copied from interface: IPublicationBase

Sets the publisher string for this reference

Specified by:

setPublisher in interface IPublicationBase

setPublisher

public void setPublisher(String publisher,
                         String placePublished)

Description copied from interface: IPublicationBase

Sets the publisher and the publication place

Specified by:

setPublisher in interface IPublicationBase

Parameters:

publisher - the publisher to set

placePublished - the place where the publication was published

See Also:

IPublicationBase.setPublisher(String), IPublicationBase.setPlacePublished(String)

getPlacePublished

public String getPlacePublished()

Description copied from interface: IPublicationBase

Returns the string which represents the place where this reference was published

Specified by:

getPlacePublished in interface IPublicationBase

setPlacePublished

public void setPlacePublished(String placePublished)

Description copied from interface: IPublicationBase

Sets the string which represents the place where this reference was published

Specified by:

setPlacePublished in interface IPublicationBase

getInstitution

public Institution getInstitution()

Description copied from interface: IReport

Returns the institution that published this report

Specified by:

getInstitution in interface IReport

setInstitution

public void setInstitution(Institution institution)

Description copied from interface: IReport

Sets the institution that published this report

Specified by:

setInstitution in interface IReport

getSchool

public Institution getSchool()

Description copied from interface: IThesis

Returns the school which published this thesis

Specified by:

getSchool in interface IThesis

setSchool

public void setSchool(Institution school)

Description copied from interface: IThesis

Sets the school which published this thesis

Specified by:

setSchool in interface IThesis

getInReference

public Reference getInReference()

Description copied from interface: ISectionBase

Returns the in-reference of this reference. E.g. if this reference is a book section the according book is returned

Specified by:

getInReference in interface IGeneric

Specified by:

getInReference in interface ISectionBase

Specified by:

getInReference in interface IWebPage

Returns:

the inReference

setInReference

public void setInReference(Reference inReference)

Description copied from interface: ISectionBase

Sets the in-reference of this reference. E.g. if this reference is a book section the according book is set via this method.

Specified by:

setInReference in interface IGeneric

Specified by:

setInReference in interface ISectionBase

Specified by:

setInReference in interface IWebPage

Parameters:

inReference - The inReference.

setType

public void setType(ReferenceType type)

Description copied from interface: IReference

Sets the reference type

Specified by:

setType in interface IReference

getType

public ReferenceType getType()

Description copied from interface: IReference

Returns the reference type

Specified by:

getType in interface IReference

Returns:

the type

isOfType

public boolean isOfType(ReferenceType type)

Whether this reference is of the given type

Specified by:

isOfType in interface IReference

Parameters:

type -

Returns:

getTitle

public String getTitle()

Returns a string representing the title of this reference. If a reference has different titles (for instance abbreviated and not abbreviated) then for each title a new instance must be created.

Specified by:

getTitle in interface IReference

Returns:

the title string of this reference

See Also:

getCitation()

setTitle

public void setTitle(String title)

Description copied from interface: IReference

Sets the references title

Specified by:

setTitle in interface IReference

See Also:

getTitle()

getDatePublished

public TimePeriod getDatePublished()

Returns the date (mostly only the year) of publication / creation of this reference.

Specified by:

getDatePublished in interface IReference

setDatePublished

public void setDatePublished(TimePeriod datePublished)

Description copied from interface: IReference

Sets the date when the reference was published.

Specified by:

setDatePublished in interface INomenclaturalReference

Specified by:

setDatePublished in interface IReference

See Also:

getDatePublished()

hasDatePublished

public boolean hasDatePublished()

getAuthorTeam

public TeamOrPersonBase getAuthorTeam()

Returns the author (team) who created the content of this reference.

Specified by:

getAuthorTeam in interface IReference

Returns:

the author (team) of this reference

See Also:

TeamOrPersonBase

setAuthorTeam

public void setAuthorTeam(TeamOrPersonBase authorTeam)

Description copied from interface: IReference

Sets the references author(s)

Specified by:

setAuthorTeam in interface IReference

See Also:

getAuthorTeam()

getUri

public 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.

Specified by:

getUri in interface IReference

Returns:

the URI of this reference

setUri

public void setUri(URI uri)

Specified by:

setUri in interface IReference

See Also:

getUri()

getReferenceAbstract

public String getReferenceAbstract()

Description copied from interface: IReference

Returns the references abstract which is a summary of the content

Specified by:

getReferenceAbstract in interface IReference

Returns:

the referenceAbstract

setReferenceAbstract

public void setReferenceAbstract(String referenceAbstract)

Description copied from interface: IReference

Sets the references abstract which is a summary of the content

Specified by:

setReferenceAbstract in interface IReference

Parameters:

referenceAbstract - the referenceAbstract to set

isNomenclaturallyRelevant

public boolean isNomenclaturallyRelevant()

Returns "true" if the isNomenclaturallyRelevant flag is set. This indicates that a taxon name has been originally published in this reference following the rules of a nomenclature code and is therefore used for nomenclatural citations. This flag will be set as soon as this reference is used as a nomenclatural reference for any taxon name.
FIXME what happens if the only taxon name referencing this reference is not any longer using this reference as a nomenclatural reference. How does the reference get informed about the fact that it is not nomenclaturally relevant anymore?

setNomenclaturallyRelevant

public void setNomenclaturallyRelevant(boolean nomenclaturallyRelevant)

See Also:

isNomenclaturallyRelevant()

getCitation

public String getCitation()

Returns a formatted string containing the entire reference citation, including authors, corresponding to this reference.

See Also:

generateTitle()

generateTitle

public String generateTitle()

Specified by:

generateTitle in interface IIdentifiableEntity

Overrides:

generateTitle in class IdentifiableEntity<S extends IReferenceBaseCacheStrategy>

getYear

public String getYear()

Returns a string representation for the year of publication / creation of this reference. If the datePublished of this reference contains more date information then (starting) year only the year is returned. than attribute.

Specified by:

getYear in interface INomenclaturalReference

getDatePublishedString

public String getDatePublishedString()

Convenience method that returns a string representation for the publication date / creation of this reference. The string is obtained by the string representation of the date published.

getParsingProblem

public int getParsingProblem()

Description copied from interface: IParsable

Returns an integer value indicating whether the used parser method was able to parse a string successfully into this object (0) or not (!=0). The the parsing was not successful the value returned defines in more detail what the problem was. The definition of these values depends on the parser that has been used for parsing.

Specified by:

getParsingProblem in interface IParsable

Returns:

the int value parsingProblem

setParsingProblem

public void setParsingProblem(int parsingProblem)

Specified by:

setParsingProblem in interface IParsable

See Also:

IParsable.getParsingProblem()

hasProblem

public boolean hasProblem()

Description copied from interface: IParsable

Returns true if any parsing problem (warning or error) exists.

Specified by:

hasProblem in interface IParsable

See Also:

#getHasProblem()

hasProblem

public boolean hasProblem(ParserProblem problem)

Description copied from interface: IParsable

Returns true, if the specified problem exists. False otherwise.

Specified by:

hasProblem in interface IParsable

Returns:

getProblemStarts

public int getProblemStarts()

Description copied from interface: IParsable

Returns the integer value of the position where a parsing problem starts. If no problem exists -1 is returned. Default: -1

Specified by:

getProblemStarts in interface IParsable

See Also:

#getHasProblem()

setProblemStarts

public void setProblemStarts(int start)

Specified by:

setProblemStarts in interface IParsable

See Also:

IParsable.getProblemStarts()

getProblemEnds

public int getProblemEnds()

Description copied from interface: IParsable

Returns the integer value of the position where a parsing problem ends. If no problem exists -1 is returned. Default: -1

Specified by:

getProblemEnds in interface IParsable

See Also:

#getHasProblem()

setProblemEnds

public void setProblemEnds(int end)

Specified by:

setProblemEnds in interface IParsable

See Also:

IParsable.getProblemEnds()

addParsingProblem

public void addParsingProblem(ParserProblem warning)

Description copied from interface: IParsable

Adds a parsing problem to the list of parsing problems

Specified by:

addParsingProblem in interface IParsable

removeParsingProblem

public void removeParsingProblem(ParserProblem problem)

Description copied from interface: IParsable

Removes a parsing problem from the list of parsing problems. If the problem is not in the list or is null, nothing happens.

Specified by:

removeParsingProblem in interface IParsable

getParsingProblems

public List<ParserProblem> getParsingProblems()

Description copied from interface: IParsable

Returns a list of all warnings and errors that have been recognized during the parsing and not yet handled.

Specified by:

getParsingProblems in interface IParsable

Returns:

getNomenclaturalCitation

public String getNomenclaturalCitation(String microReference)

Description copied from interface: INomenclaturalReference

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 INomenclaturalReference

Specified by:

getNomenclaturalCitation in interface IReference

Parameters:

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

Returns:

String

castReferenceToArticle

public IArticle castReferenceToArticle()

Generates, according to the cache strategy assigned to this reference, a string that identifies this reference and returns it. This string may be stored in the inherited titleCache attribute.
This method overrides the generic and inherited generateTitle method from IdentifiableEntity.

Returns:

the string identifying this reference

See Also:

getCitation(), IdentifiableEntity.getTitleCache(), IdentifiableEntity.generateTitle(), eu.etaxonomy.cdm.strategy.strategy.cache.common.IIdentifiableEntityCacheStrategy#getTitleCache()

castReferenceToBook

public IBook castReferenceToBook()

castReferenceToBookSection

public IBookSection castReferenceToBookSection()

castReferenceToCdDvd

public ICdDvd castReferenceToCdDvd()

castReferenceToDatabase

public IDatabase castReferenceToDatabase()

castReferenceToGeneric

public IGeneric castReferenceToGeneric()

castReferenceToInProceedings

public IInProceedings castReferenceToInProceedings()

castReferenceToJournal

public IJournal castReferenceToJournal()

castReferenceToMap

public IMap castReferenceToMap()

castReferenceToPatent

public IPatent castReferenceToPatent()

castReferenceToPersonalCommunication

public IPersonalCommunication castReferenceToPersonalCommunication()

castReferenceToPrintSeries

public IPrintSeries castReferenceToPrintSeries()

castReferenceToWebPage

public IWebPage castReferenceToWebPage()

castReferenceToProceedings

public IProceedings castReferenceToProceedings()

castReferenceToReport

public IReport castReferenceToReport()

castReferenceToThesis

public IThesis castReferenceToThesis()

getInJournal

public IJournal getInJournal()

Description copied from interface: IArticle

Returns this articles journal.

Specified by:

getInJournal in interface IArticle

Returns:

setInJournal

public void setInJournal(IJournal journal)

Description copied from interface: IArticle

Sets this articles journal

Specified by:

setInJournal in interface IArticle

getInSeries

public IPrintSeries getInSeries()

Description copied from interface: IPrintedUnitBase

Returns the print series of this printed unit

Specified by:

getInSeries in interface IPrintedUnitBase

Returns:

setInSeries

public void setInSeries(IPrintSeries inSeries)

Description copied from interface: IPrintedUnitBase

Sets the print series of this printed unit

Specified by:

setInSeries in interface IPrintedUnitBase

getInBook

public IBook getInBook()

Description copied from interface: IBookSection

Returns this book sections book

Specified by:

getInBook in interface IBookSection

Returns:

setInBook

public void setInBook(IBook book)

Description copied from interface: IBookSection

Sets this book sections book.

Specified by:

setInBook in interface IBookSection

getInProceedings

public IProceedings getInProceedings()

Description copied from interface: IInProceedings

Returns the proceedings for these inProceedings

Specified by:

getInProceedings in interface IInProceedings

setInProceedings

public void setInProceedings(IProceedings proceeding)

Description copied from interface: IInProceedings

Sets the proceedings for these inProceedings

Specified by:

setInProceedings in interface IInProceedings

setCacheStrategy

public void setCacheStrategy(IReferenceBaseCacheStrategy iReferenceBaseCacheStrategy)

Description copied from interface: IReference

Sets the cache strategy for this reference

Specified by:

setCacheStrategy in interface IReference

Overrides:

setCacheStrategy in class IdentifiableEntity<S extends IReferenceBaseCacheStrategy>

See Also:

IdentifiableEntity.getCacheStrategy()

setCacheStrategy

public void setCacheStrategy(ArticleDefaultCacheStrategy cacheStrategy)

Specified by:

setCacheStrategy in interface IArticle

setCacheStrategy

public void setCacheStrategy(BookDefaultCacheStrategy cacheStrategy)

Specified by:

setCacheStrategy in interface IBook

setCacheStrategy

public void setCacheStrategy(JournalDefaultCacheStrategy cacheStrategy)

Specified by:

setCacheStrategy in interface IJournal

setCacheStrategy

public void setCacheStrategy(BookSectionDefaultCacheStrategy cacheStrategy)

Specified by:

setCacheStrategy in interface IBookSection

setCacheStrategy

public void setCacheStrategy(GenericDefaultCacheStrategy cacheStrategy)

Specified by:

setCacheStrategy in interface IGeneric

setCacheStrategy

public void setCacheStrategy(ReferenceBaseDefaultCacheStrategy cacheStrategy)

clone

public Object clone()

Clones this reference. This is a shortcut that enables to create a new instance that differs only slightly from this reference by modifying only some of the attributes.

Overrides:

clone in class IdentifiableMediaEntity<S extends IReferenceBaseCacheStrategy>

See Also:

IdentifiableMediaEntity.clone(), Object.clone()