eu.etaxonomy.cdm.model.reference
Class Generic

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

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 Generic
extends PublicationBase<INomenclaturalReferenceCacheStrategy<Generic>>
implements INomenclaturalReference, IVolumeReference, Cloneable

This class represents all references which cannot be clearly assigned to a particular reference subclass. Therefore attributes which are characteristic for a unique reference subclass are not necessary here.

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

• "Generic"
• "Artwork"
• "AudiovisualMaterial"
• "ComputerProgram"
• "Determination"
• "Commentary"
• "SubReference"

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

Generic()
Deprecated. Class constructor: creates a new empty generic reference instance only containing the default cache strategy.

Method Summary

Generic	clone() Deprecated. Clones this generic reference.
String	getEditor() Deprecated. Returns the string representing the name of the editor of this generic reference.
String	getNomenclaturalCitation(String microReference) Deprecated. Returns a formatted string containing the entire citation used for nomenclatural purposes based on this generic reference - including (abbreviated) title but not authors - and on the given details.
String	getPages() Deprecated. Returns the string representing the page(s) where the content of this generic reference is located. If there is a pages information then the generic reference must be some kind of physical printed unit or an article.
String	getSeries() Deprecated. Returns the string representing the series (for instance for books or within journals) - and series part - in which this generic reference was published. If there is a series then the generic reference must be some kind of physical printed unit or an article.
String	getVolume() Deprecated. Returns the string representing the volume (for instance for books or within journals) in which this generic reference was published. If there is a volume then the generic reference must be some kind of physical printed unit or an article.
static Generic	NewInstance() Deprecated.
void	setEditor(String editor) Deprecated. Sets the editor for this reference
void	setPages(String pages) Deprecated. Sets the pages that this reference covers in its in-reference
void	setSeries(String series) Deprecated. Sets the series information for this article
void	setVolume(String volume) Deprecated. Sets the volume of the reference.

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

getPlacePublished, getPublisher, setPlacePublished, setPublisher

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, getInBook, getInJournal, getInProceedings, getInReference, getInSeries, getInstitution, getIsbn, getIssn, getOrganization, getParsingProblem, getParsingProblems, getProblemEnds, getProblemStarts, getReferenceAbstract, getSchool, getSeriesPart, getTitle, getType, getUri, getYear, hasProblem, hasProblem, isNomenclaturallyRelevant, isOfType, removeParsingProblem, setAuthorTeam, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setDatePublished, setEdition, setInBook, setInJournal, setInProceedings, setInReference, setInSeries, setInstitution, setIsbn, setIssn, setNomenclaturallyRelevant, setOrganization, setParsingProblem, setProblemEnds, setProblemStarts, setPublisher, setReferenceAbstract, setSchool, 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

Generic

public Generic()

Deprecated.

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

See Also:

GenericDefaultCacheStrategy

Method Detail

NewInstance

@Deprecated
public static Generic NewInstance()

Deprecated.

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

See Also:

Generic(), GenericDefaultCacheStrategy

getEditor

public String getEditor()

Deprecated.

Returns the string representing the name of the editor of this generic reference. An editor is mostly a person (team) who assumed the responsibility for the content of the publication as a whole without being the author of this content.
If there is an editor then the generic reference must be some kind of physical printed unit.

Specified by:

getEditor in interface IGeneric

Specified by:

getEditor in interface IPrintedUnitBase

Overrides:

getEditor in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Generic>>

Returns:

the string identifying the editor of this generic reference

See Also:

PublicationBase.getPublisher()

setEditor

public void setEditor(String editor)

Deprecated.

Description copied from interface: IPrintedUnitBase

Sets the editor for this reference

Specified by:

setEditor in interface IGeneric

Specified by:

setEditor in interface IPrintedUnitBase

Overrides:

setEditor in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Generic>>

See Also:

getEditor()

getSeries

public String getSeries()

Deprecated.

Returns the string representing the series (for instance for books or within journals) - and series part - in which this generic reference was published.
If there is a series then the generic reference must be some kind of physical printed unit or an article.

Specified by:

getSeries in interface IArticle

Specified by:

getSeries in interface IGeneric

Overrides:

getSeries in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Generic>>

Returns:

the string identifying the series for this generic reference

setSeries

public void setSeries(String series)

Deprecated.

Description copied from interface: IArticle

Sets the series information for this article

Specified by:

setSeries in interface IArticle

Specified by:

setSeries in interface IGeneric

Overrides:

setSeries in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Generic>>

See Also:

getSeries()

getVolume

public String getVolume()

Deprecated.

Returns the string representing the volume (for instance for books or within journals) in which this generic reference was published.
If there is a volume then the generic reference must be some kind of physical printed unit or an article.

Specified by:

getVolume in interface IVolumeReference

Overrides:

getVolume in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Generic>>

Returns:

the string identifying the volume for this generic reference

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<Generic>>

See Also:

getVolume()

getPages

public String getPages()

Deprecated.

Returns the string representing the page(s) where the content of this generic reference is located.
If there is a pages information then the generic reference must be some kind of physical printed unit or an article.

Specified by:

getPages in interface IGeneric

Specified by:

getPages in interface ISectionBase

Overrides:

getPages in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Generic>>

Returns:

the string containing the pages corresponding to this generic reference

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<Generic>>

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 generic reference - including (abbreviated) title but not authors - and on the given details.

Specified by:

getNomenclaturalCitation in interface INomenclaturalReference

Specified by:

getNomenclaturalCitation in interface IReferenceBase

Overrides:

getNomenclaturalCitation in class ReferenceBase<INomenclaturalReferenceCacheStrategy<Generic>>

Parameters:

microReference - the string with the details (generally pages) within this generic reference

Returns:

the formatted string representing the nomenclatural citation

See Also:

ReferenceBase.getCitation()

clone

public Generic clone()

Deprecated.

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

Overrides:

clone in class PublicationBase<INomenclaturalReferenceCacheStrategy<Generic>>

See Also:

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