eu.etaxonomy.cdm.model.reference
Class Article

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<INomenclaturalReferenceCacheStrategy<Article>>
                          eu.etaxonomy.cdm.model.reference.Article

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, IReferenceBase, IReport, ISectionBase, IThesis, IVolumeReference, IWebPage, IMatchable, IMergable, Serializable, Cloneable

Deprecated.

@Indexed(index="eu.etaxonomy.cdm.model.reference.ReferenceBase")
@Configurable
@Deprecated
public class Article
extends ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>
implements INomenclaturalReference, IVolumeReference, Cloneable

This class represents articles in a journal. An article is an independent piece of prose written by an author (team) which is published among other articles within a particular issue of a journal.

This class corresponds, according to the TDWG ontology, to the publication type terms (from PublicationTypeTerm):

• "JournalArticle"
• "NewspaperArticle"
• "MagazineArticle"

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.etaxonomy.cdm.model.reference.ReferenceBase

edition, editor, inReference, institution, isbn, issn, organization, pages, placePublished, publisher, school, series, seriesPart, type, 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

Article() Deprecated. Class constructor: creates a new empty article instance only containing the default cache strategy.

Method Summary

Article	clone() Deprecated. Clones this article.
Journal	getInJournal() Deprecated. Returns the journal in which this article has been published.
String	getNomenclaturalCitation(String microReference) Deprecated. Returns a formatted string containing the entire citation used for nomenclatural purposes based on this article - including (abbreviated) title of the journal but not authors of the article - and on the given details.
String	getPages() Deprecated. Returns the string representing the page(s) where the content of this article is located within the journal issue.
String	getSeries() Deprecated. Returns the string representing the series (within the journal) in which this article was published.
String	getVolume() Deprecated. Returns the volume of a reference.
static Article	NewInstance() Deprecated. Creates a new empty article instance only containing the default cache strategy.
static Article	NewInstance(Journal inJournal, TeamOrPersonBase authorTeam, String articleTitle, String pages, String series, String volume, TimePeriod datePublished) Deprecated. Creates a new article instance with the given values and with the default cache strategy.
void	setInJournal(Journal inJournal) Deprecated.
void	setPages(String pages) Deprecated. Sets the pages that this reference covers in its in-reference
void	setVolume(String volume) Deprecated. Sets the volume of the reference.

Methods inherited from class eu.etaxonomy.cdm.model.reference.ReferenceBase

addParsingProblem, castReferenceToArticle, castReferenceToBook, castReferenceToBookSection, castReferenceToCdDvd, castReferenceToDatabase, castReferenceToGeneric, castReferenceToInProceedings, castReferenceToJournal, castReferenceToMap, castReferenceToPatent, castReferenceToPersonalCommunication, castReferenceToPrintSeries, castReferenceToProceedings, castReferenceToReport, castReferenceToThesis, castReferenceToWebPage, generateTitle, getAuthorTeam, getCitation, getDatePublished, getEdition, getEditor, getInBook, getInProceedings, getInReference, getInSeries, getInstitution, getIsbn, getIssn, getOrganization, getParsingProblem, getParsingProblems, getPlacePublished, getProblemEnds, getProblemStarts, getPublisher, getReferenceAbstract, getSchool, getSeriesPart, getTitle, getType, getUri, getYear, hasProblem, hasProblem, isNomenclaturallyRelevant, isOfType, removeParsingProblem, setAuthorTeam, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setDatePublished, setEdition, setEditor, setInBook, setInJournal, setInProceedings, setInReference, setInSeries, setInstitution, setIsbn, setIssn, setNomenclaturallyRelevant, setOrganization, setParsingProblem, setPlacePublished, setProblemEnds, setProblemStarts, setPublisher, setPublisher, setReferenceAbstract, setSchool, setSeries, setSeriesPart, setTitle, setType, setUri

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.reference.INomenclaturalReference

getYear, setDatePublished

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

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

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

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

Constructor Detail

Article

protected Article()

Deprecated.

Class constructor: creates a new empty article instance only containing the default cache strategy.

See Also:

ArticleDefaultCacheStrategy

Method Detail

NewInstance

public static Article NewInstance()

Deprecated.

Creates a new empty article instance only containing the default cache strategy.

See Also:

Article(), NewInstance(Journal, TeamOrPersonBase, String, String, String, String, TimePeriod), ArticleDefaultCacheStrategy

NewInstance

public static Article NewInstance(Journal inJournal,
                                  TeamOrPersonBase authorTeam,
                                  String articleTitle,
                                  String pages,
                                  String series,
                                  String volume,
                                  TimePeriod datePublished)

Deprecated.

Creates a new article instance with the given values and with the default cache strategy.

Parameters:

inJournal - the journal in which this article has been published

authorTeam - the team or person who wrote this article

articleTitle - the string representing the title of this article

pages - the string representing the pages in the journal issue where this article can be found

series - the string representing the series (within the journal) in which this article has been published

volume - the string representing the volume of the journal in which this article has been published

datePublished - the date (time period) in which this article has been published

See Also:

NewInstance(), Journal, TeamOrPersonBase, TimePeriod, ArticleDefaultCacheStrategy

getInJournal

public Journal getInJournal()

Deprecated.

Returns the journal in which this article has been published.

Specified by:

getInJournal in interface IArticle

Overrides:

getInJournal in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

Returns:

the journal

See Also:

Journal

setInJournal

public void setInJournal(Journal inJournal)

Deprecated.

See Also:

getInJournal()

getSeries

public String getSeries()

Deprecated.

Returns the string representing the series (within the journal) in which this article was published.

Specified by:

getSeries in interface IArticle

Specified by:

getSeries in interface IGeneric

Overrides:

getSeries in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

Returns:

the string identifying the series

getVolume

public String getVolume()

Deprecated.

Description copied from interface: IVolumeReference

Returns the volume of a reference.

Specified by:

getVolume in interface IVolumeReference

Overrides:

getVolume in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

See Also:

getSeries()

setVolume

public void setVolume(String volume)

Deprecated.

Description copied from interface: IVolumeReference

Sets the volume of the reference.

Specified by:

setVolume in interface IVolumeReference

Overrides:

setVolume in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

See Also:

getVolume()

getPages

public String getPages()

Deprecated.

Returns the string representing the page(s) where the content of this article is located within the journal issue.

Specified by:

getPages in interface IGeneric

Specified by:

getPages in interface ISectionBase

Overrides:

getPages in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

Returns:

the string with the pages corresponding to this article

setPages

public void setPages(String pages)

Deprecated.

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

Overrides:

setPages in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

See Also:

getPages()

getNomenclaturalCitation

public String getNomenclaturalCitation(String microReference)

Deprecated.

Returns a formatted string containing the entire citation used for nomenclatural purposes based on this article - including (abbreviated) title of the journal but not authors of the article - and on the given details.

Specified by:

getNomenclaturalCitation in interface INomenclaturalReference

Specified by:

getNomenclaturalCitation in interface IReferenceBase

Overrides:

getNomenclaturalCitation in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

Parameters:

microReference - the string with the details (generally pages) within the journal

Returns:

the formatted string representing the nomenclatural citation

See Also:

ReferenceBase.getCitation()

clone

public Article clone()

Deprecated.

Clones this article. This is a shortcut that enables to create a new instance that differs only slightly from this article by modifying only some of the attributes.
This method overrides the clone method from StrictReferenceBase.

Overrides:

clone in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Article>>

See Also:

StrictReferenceBase#clone(), IdentifiableMediaEntity.clone(), Object.clone()