|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.ReferenceBase<S>
public class ReferenceBase<S extends IReferenceBaseCacheStrategy>
The upmost (abstract) class for references (information sources).
This class corresponds to:
Field Summary | |
---|---|
protected String |
edition
|
protected String |
editor
|
protected ReferenceBase |
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 |
ReferenceBase()
|
protected |
ReferenceBase(ReferenceType type)
|
Method Summary | |
---|---|
void |
addParsingProblem(ParserProblem warning)
Adds a parsing problem to the list of parsing problems |
IArticle |
castReferenceToArticle()
|
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 |
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 |
ReferenceBase |
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 |
String |
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 |
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(ReferenceBase 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(String 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, getLsid, getRights, getSources, getTitleCache, getTruncatedCache, initListener, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeRights, removeSource, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString |
Methods inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity |
---|
addAnnotation, addMarker, getAnnotations, getMarkers, 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, 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.ICdmBase |
---|
getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid |
Methods inherited from interface eu.etaxonomy.cdm.model.common.IVersionableEntity |
---|
getUpdated, getUpdatedBy, setUpdated, setUpdatedBy |
Field Detail |
---|
protected ReferenceType type
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String editor
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String series
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String volume
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String pages
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String edition
@Field(index=TOKENIZED) @NullOrNotEmpty @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.ReferenceBase.isbn.message}") protected String isbn
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) @Pattern(regexp="(?=.{9}$)\\d{4}([- ])\\d{4} (\\d|X)$", groups=Level2.class, message="{eu.etaxonomy.cdm.model.reference.ReferenceBase.issn.message}") protected String issn
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String seriesPart
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String organization
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String publisher
@Field(index=TOKENIZED) @NullOrNotEmpty @Length(max=255) protected String placePublished
@IndexedEmbedded protected Institution institution
@IndexedEmbedded protected Institution school
protected ReferenceBase inReference
Constructor Detail |
---|
protected ReferenceBase()
protected ReferenceBase(ReferenceType type)
Method Detail |
---|
public String getEditor()
IPrintedUnitBase
getEditor
in interface IGeneric
getEditor
in interface IPrintedUnitBase
public void setEditor(String editor)
IPrintedUnitBase
setEditor
in interface IGeneric
setEditor
in interface IPrintedUnitBase
public String getSeries()
IArticle
getSeries
in interface IArticle
getSeries
in interface IGeneric
public void setSeries(String series)
IArticle
setSeries
in interface IArticle
setSeries
in interface IGeneric
public String getVolume()
IVolumeReference
getVolume
in interface IVolumeReference
public void setVolume(String volume)
IVolumeReference
setVolume
in interface IVolumeReference
public String getPages()
ISectionBase
getPages
in interface IGeneric
getPages
in interface ISectionBase
public void setPages(String pages)
ISectionBase
setPages
in interface IGeneric
setPages
in interface ISectionBase
ISectionBase.getPages()
public String getEdition()
IBook
getEdition
in interface IBook
public void setEdition(String edition)
IBook
setEdition
in interface IBook
public String getIsbn()
IBook
getIsbn
in interface IBook
public void setIsbn(String isbn)
IBook
setIsbn
in interface IBook
public String getIssn()
IJournal
getIssn
in interface IJournal
public void setIssn(String issn)
IJournal
setIssn
in interface IJournal
public String getSeriesPart()
IPrintedUnitBase
getSeriesPart
in interface IPrintedUnitBase
public void setSeriesPart(String seriesPart)
IPrintedUnitBase
setSeriesPart
in interface IPrintedUnitBase
public String getOrganization()
IProceedings
getOrganization
in interface IProceedings
public void setOrganization(String organization)
IProceedings
setOrganization
in interface IProceedings
public String getPublisher()
IPublicationBase
getPublisher
in interface IPublicationBase
public void setPublisher(String publisher)
IPublicationBase
setPublisher
in interface IPublicationBase
public void setPublisher(String publisher, String placePublished)
IPublicationBase
setPublisher
in interface IPublicationBase
publisher
- the publisher to setplacePublished
- the place where the publication was publishedIPublicationBase.setPublisher(String)
,
IPublicationBase.setPlacePublished(String)
public String getPlacePublished()
IPublicationBase
getPlacePublished
in interface IPublicationBase
public void setPlacePublished(String placePublished)
IPublicationBase
setPlacePublished
in interface IPublicationBase
public Institution getInstitution()
IReport
getInstitution
in interface IReport
public void setInstitution(Institution institution)
IReport
setInstitution
in interface IReport
public Institution getSchool()
IThesis
getSchool
in interface IThesis
public void setSchool(Institution school)
IThesis
setSchool
in interface IThesis
public ReferenceBase getInReference()
ISectionBase
getInReference
in interface IGeneric
getInReference
in interface ISectionBase
public void setInReference(ReferenceBase inReference)
ISectionBase
setInReference
in interface IGeneric
setInReference
in interface ISectionBase
public void setType(ReferenceType type)
IReferenceBase
setType
in interface IReferenceBase
public ReferenceType getType()
IReferenceBase
getType
in interface IReferenceBase
public boolean isOfType(ReferenceType type)
isOfType
in interface IReferenceBase
type
-
public String getTitle()
getTitle
in interface IReferenceBase
getCitation()
public void setTitle(String title)
IReferenceBase
setTitle
in interface IReferenceBase
getTitle()
public TimePeriod getDatePublished()
getDatePublished
in interface IReferenceBase
public void setDatePublished(TimePeriod datePublished)
IReferenceBase
setDatePublished
in interface INomenclaturalReference
setDatePublished
in interface IReferenceBase
getDatePublished()
public TeamOrPersonBase getAuthorTeam()
author (team)
who created the
content of this reference.
getAuthorTeam
in interface IReferenceBase
TeamOrPersonBase
public void setAuthorTeam(TeamOrPersonBase authorTeam)
IReferenceBase
setAuthorTeam
in interface IReferenceBase
getAuthorTeam()
public String getUri()
getUri
in interface IReferenceBase
public void setUri(String uri)
setUri
in interface IReferenceBase
getUri()
public String getReferenceAbstract()
IReferenceBase
getReferenceAbstract
in interface IReferenceBase
public void setReferenceAbstract(String referenceAbstract)
IReferenceBase
setReferenceAbstract
in interface IReferenceBase
referenceAbstract
- the referenceAbstract to setpublic boolean isNomenclaturallyRelevant()
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.
public void setNomenclaturallyRelevant(boolean nomenclaturallyRelevant)
isNomenclaturallyRelevant()
public String getCitation()
generateTitle()
public String generateTitle()
generateTitle
in interface IIdentifiableEntity
generateTitle
in class IdentifiableEntity<S extends IReferenceBaseCacheStrategy>
public String getYear()
datePublished
attribute.
getYear
in interface INomenclaturalReference
public int getParsingProblem()
IParsable
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.
getParsingProblem
in interface IParsable
public void setParsingProblem(int parsingProblem)
setParsingProblem
in interface IParsable
IParsable.getParsingProblem()
public boolean hasProblem()
IParsable
hasProblem
in interface IParsable
#getHasProblem()
public boolean hasProblem(ParserProblem problem)
IParsable
hasProblem
in interface IParsable
public int getProblemStarts()
IParsable
getProblemStarts
in interface IParsable
#getHasProblem()
public void setProblemStarts(int start)
setProblemStarts
in interface IParsable
IParsable.getProblemStarts()
public int getProblemEnds()
IParsable
getProblemEnds
in interface IParsable
#getHasProblem()
public void setProblemEnds(int end)
setProblemEnds
in interface IParsable
IParsable.getProblemEnds()
public void addParsingProblem(ParserProblem warning)
IParsable
addParsingProblem
in interface IParsable
public void removeParsingProblem(ParserProblem problem)
IParsable
null
, nothing happens.
removeParsingProblem
in interface IParsable
public List<ParserProblem> getParsingProblems()
IParsable
getParsingProblems
in interface IParsable
public Object clone()
clone
in class IdentifiableMediaEntity<S extends IReferenceBaseCacheStrategy>
IdentifiableMediaEntity.clone()
,
Object.clone()
public IArticle castReferenceToArticle()
public IBook castReferenceToBook()
public IBookSection castReferenceToBookSection()
public ICdDvd castReferenceToCdDvd()
public IDatabase castReferenceToDatabase()
public IGeneric castReferenceToGeneric()
public IInProceedings castReferenceToInProceedings()
public IJournal castReferenceToJournal()
public IMap castReferenceToMap()
public IPatent castReferenceToPatent()
public IPersonalCommunication castReferenceToPersonalCommunication()
public IPrintSeries castReferenceToPrintSeries()
public IWebPage castReferenceToWebPage()
public IProceedings castReferenceToProceedings()
public IReport castReferenceToReport()
public IThesis castReferenceToThesis()
public String getNomenclaturalCitation(String microReference)
INomenclaturalReference
taxon name
.
getNomenclaturalCitation
in interface INomenclaturalReference
getNomenclaturalCitation
in interface IReferenceBase
microReference
- the detail, e.g. a page number, a figure, ...
public IJournal getInJournal()
IArticle
getInJournal
in interface IArticle
public void setInJournal(IJournal journal)
IArticle
setInJournal
in interface IArticle
public IPrintSeries getInSeries()
IPrintedUnitBase
getInSeries
in interface IPrintedUnitBase
public void setInSeries(IPrintSeries inSeries)
IPrintedUnitBase
setInSeries
in interface IPrintedUnitBase
public IBook getInBook()
IBookSection
getInBook
in interface IBookSection
public void setInBook(IBook book)
IBookSection
setInBook
in interface IBookSection
public IProceedings getInProceedings()
IInProceedings
getInProceedings
in interface IInProceedings
public void setInProceedings(IProceedings proceeding)
IInProceedings
setInProceedings
in interface IInProceedings
public void setCacheStrategy(IReferenceBaseCacheStrategy iReferenceBaseCacheStrategy)
IReferenceBase
setCacheStrategy
in interface IReferenceBase
setCacheStrategy
in class IdentifiableEntity<S extends IReferenceBaseCacheStrategy>
IdentifiableEntity.getCacheStrategy()
public void setCacheStrategy(ArticleDefaultCacheStrategy cacheStrategy)
setCacheStrategy
in interface IArticle
public void setCacheStrategy(BookDefaultCacheStrategy cacheStrategy)
setCacheStrategy
in interface IBook
public void setCacheStrategy(JournalDefaultCacheStrategy cacheStrategy)
setCacheStrategy
in interface IJournal
public void setCacheStrategy(BookSectionDefaultCacheStrategy cacheStrategy)
setCacheStrategy
in interface IBookSection
public void setCacheStrategy(GenericDefaultCacheStrategy cacheStrategy)
setCacheStrategy
in interface IGeneric
public void setCacheStrategy(ReferenceBaseDefaultCacheStrategy cacheStrategy)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |