eu.etaxonomy.cdm.model.reference
Class Generic

java.lang.Object
  eu.etaxonomy.cdm.model.common.CdmBase
      eu.etaxonomy.cdm.model.common.VersionableEntity<T>
          eu.etaxonomy.cdm.model.common.AnnotatableEntity<T>
              eu.etaxonomy.cdm.model.common.IdentifiableEntity
                  eu.etaxonomy.cdm.model.media.IdentifyableMediaEntity
                      eu.etaxonomy.cdm.model.reference.ReferenceBase
                          eu.etaxonomy.cdm.model.reference.StrictReferenceBase
                              eu.etaxonomy.cdm.model.reference.Generic

All Implemented Interfaces:

ICdmBase, IIdentifiableEntitiy, IParsable, ISourceable, IMediaDocumented, IMediaEntity, INomenclaturalReference, Serializable, Cloneable

public class Generic
extends StrictReferenceBase
implements INomenclaturalReference, 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

cacheStrategy

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

NOT_PROTECTED, PROTECTED

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

annotations, markers

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

MICRO_REFERENCE_TOKEN

Constructor Summary

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

Method Summary

Generic	clone() Clones this generic reference.
String	generateTitle() Generates, according to the default cache strategy assigned to this generic reference, a string that identifies this reference and returns it.
String	getCitation() Returns a formatted string containing the entire reference citation, including authors, corresponding to this generic reference.
String	getEditor() Returns the string representing the name of the editor of this generic reference.
String	getNomenclaturalCitation(String microReference) 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() Returns the string representing the page(s) where the content of this generic reference is located.
String	getPlacePublished() Returns the string representing the name of the place (mostly the city) where this generic reference has been published.
String	getPublisher() Returns the string representing the name of the publisher of this generic reference.
String	getSeries() Returns the string representing the series (for instance for books or within journals) - and series part - in which this generic reference was published.
String	getVolume() Returns the string representing the volume (for instance for books or within journals) in which this generic reference was published.
static Generic	NewInstance() Creates a new empty generic reference instance only containing the default cache strategy.
void	setEditor(String editor)
void	setPages(String pages)
void	setPlacePublished(String placePublished)
void	setPublisher(String publisher)
void	setSeries(String series)
void	setVolume(String volume)

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

getDatePublished, getTitle, getYear, setDatePublished, setTitle

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

getAuthorTeam, getHasProblem, getUri, isNomenclaturallyRelevant, setAuthorTeam, setHasProblem, setNomenclaturallyRelevant, setUri

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

addMedia, getMedia, removeMedia, setMedia

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

addExtension, addRights, addSource, getExtensions, getLsid, getPersistentTitleCache, getRights, getSources, getTitleCache, isProtectedTitleCache, removeExtension, removeRights, removeSource, setExtensions, setLsid, setPersistentTitleCache, setProtectedTitleCache, setRights, setSources, setTitleCache, setTitleCache, toString

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

addAnnotation, addMarker, getAnnotations, getMarkers, removeAnnotation, removeMarker, setAnnotations, setMarkers

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

equals, getNextVersion, getPreviousVersion, getUpdated, getUpdatedBy, getValidFrom, getValidTo, hashCode, setNextVersion, setPreviousVersion, setUpdated, setUpdatedBy

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

addPropertyChangeListener, addPropertyChangeListener, clone, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUuid, hasListeners, invokeSetMethod, invokeSetMethodWithNull, 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

getHasProblem, getYear

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

addExtension, addRights, addSource, getExtensions, getLsid, getRights, getSources, getTitleCache, isProtectedTitleCache, removeExtension, removeRights, removeSource, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString

Constructor Detail

Generic

public Generic()

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

See Also:

GenericDefaultCacheStrategy

Method Detail

NewInstance

public static Generic NewInstance()

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

See Also:

Generic(), GenericDefaultCacheStrategy

getPublisher

public String getPublisher()

Returns the string representing the name of the publisher of this generic reference. A publisher is mostly an institution or a private company which assumed the global responsibility for the publication process.
If there is a publisher then the generic reference must be some kind of publication.

Returns:

the string identifying the publisher of this generic reference

See Also:

getEditor()

setPublisher

public void setPublisher(String publisher)

See Also:

getPublisher()

getPlacePublished

public String getPlacePublished()

Returns the string representing the name of the place (mostly the city) where this generic reference has been published.
If there is a published place then the generic reference must be some kind of publication.

Returns:

the string identifying the publication place of this generic reference

setPlacePublished

public void setPlacePublished(String placePublished)

See Also:

getPlacePublished()

getEditor

public String getEditor()

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.

Returns:

the string identifying the editor of this generic reference

See Also:

getPublisher()

setEditor

public void setEditor(String editor)

See Also:

getEditor()

getSeries

public String getSeries()

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.

Returns:

the string identifying the series for this generic reference

setSeries

public void setSeries(String series)

See Also:

getSeries()

getVolume

public String getVolume()

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.

Returns:

the string identifying the volume for this generic reference

setVolume

public void setVolume(String volume)

See Also:

getVolume()

getPages

public String getPages()

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.

Returns:

the string containing the pages corresponding to this generic reference

setPages

public void setPages(String pages)

See Also:

getPages()

getCitation

public String getCitation()

Returns a formatted string containing the entire reference citation, including authors, corresponding to this generic reference.
This method overrides the generic and inherited getCitation method from StrictReferenceBase.

Overrides:

getCitation in class StrictReferenceBase

See Also:

getNomenclaturalCitation(String), StrictReferenceBase.getCitation()

getNomenclaturalCitation

public String getNomenclaturalCitation(String microReference)

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

Parameters:

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

Returns:

the formatted string representing the nomenclatural citation

See Also:

getCitation()

generateTitle

public String generateTitle()

Generates, according to the default cache strategy assigned to this generic 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 ReferenceBase.

Specified by:

generateTitle in interface IIdentifiableEntitiy

Overrides:

generateTitle in class ReferenceBase

Returns:

the string identifying this generic reference

See Also:

getCitation(), IdentifiableEntity.getTitleCache(), IdentifiableEntity.generateTitle()

clone

public Generic clone()

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 StrictReferenceBase

See Also:

StrictReferenceBase.clone(), IdentifyableMediaEntity.clone(), Object.clone()