eu.etaxonomy.cdm.model.common
Class DescriptionElementSource

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.ReferencedEntityBase
                  eu.etaxonomy.cdm.model.common.OriginalSourceBase<DescriptionElementBase>
                      eu.etaxonomy.cdm.model.common.DescriptionElementSource

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IOriginalSource<DescriptionElementBase>, IReferencedEntity, IVersionableEntity, Serializable, Cloneable

@Entity
public class DescriptionElementSource
extends OriginalSourceBase<DescriptionElementBase>

This class represents an IOriginalSource that can be used with description elements. Additionally to the core functionally of IOriginalSource a taxon name can be stored that points to the name used in the source. This is needed because description always belong to accepted taxa while the referenced citations may use synonym names.
The use of "originalNameString" within a DescriptionElementSource has to be discussed. In general this string is to be used for different representations of the sourced object. In this classes context it could also stand for the string representation of the taxon name used in the source. This may make sense if the taxon name is not available in the CDM and the user for some reason does not want to create a new ful taxon name.

Version:

1.0

Author:

a.mueller

See Also:

Serialized Form

Field Summary

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

annotations, markers

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

uuid

Method Summary

Object	clone() Clones this versionable entity.
DescriptionElementSource	clone(DescriptionElementBase sourcedObj) Clones this original source and sets the clones sourced object to 'sourceObj'
TaxonNameBase	getNameUsedInSource()
DescriptionElementBase	getSourcedObj() The object this original source is the source for
static DescriptionElementSource	NewInstance() Factory method
static DescriptionElementSource	NewInstance(Reference citation, String microCitation)
static DescriptionElementSource	NewInstance(Reference citation, String microReference, TaxonNameBase nameUsedInSource, String originalNameString)
static DescriptionElementSource	NewInstance(String id)
static DescriptionElementSource	NewInstance(String id, String idNamespace)
static DescriptionElementSource	NewInstance(String id, String idNamespace, Reference citation)
static DescriptionElementSource	NewInstance(String id, String idNamespace, Reference citation, String microCitation)
static DescriptionElementSource	NewInstance(String id, String idNamespace, Reference citation, String microReference, TaxonNameBase nameUsedInSource, String originalNameString)
void	setNameUsedInSource(TaxonNameBase nameUsedInSource)
void	setSourcedObj(DescriptionElementBase sourcedObj)

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

getIdInSource, getIdNamespace, setIdInSource, setIdNamespace, toString

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

getCitation, getCitationMicroReference, getOriginalNameString, setCitation, setCitationMicroReference, setOriginalNameString

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

getCitation, getCitationMicroReference, setCitation, setCitationMicroReference

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

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

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

getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid

Method Detail

NewInstance

public static DescriptionElementSource NewInstance()

Factory method

Returns:

NewInstance

public static DescriptionElementSource NewInstance(String id)

NewInstance

public static DescriptionElementSource NewInstance(String id,
                                                   String idNamespace)

NewInstance

public static DescriptionElementSource NewInstance(String id,
                                                   String idNamespace,
                                                   Reference citation)

NewInstance

public static DescriptionElementSource NewInstance(String id,
                                                   String idNamespace,
                                                   Reference citation,
                                                   String microCitation)

NewInstance

public static DescriptionElementSource NewInstance(String id,
                                                   String idNamespace,
                                                   Reference citation,
                                                   String microReference,
                                                   TaxonNameBase nameUsedInSource,
                                                   String originalNameString)

NewInstance

public static DescriptionElementSource NewInstance(Reference citation,
                                                   String microCitation)

NewInstance

public static DescriptionElementSource NewInstance(Reference citation,
                                                   String microReference,
                                                   TaxonNameBase nameUsedInSource,
                                                   String originalNameString)

getSourcedObj

public DescriptionElementBase getSourcedObj()

Description copied from interface: IOriginalSource

The object this original source is the source for

Returns:

setSourcedObj

public void setSourcedObj(DescriptionElementBase sourcedObj)

See Also:

IOriginalSource.getSourcedObj()

getNameUsedInSource

public TaxonNameBase getNameUsedInSource()

Returns:

the taxonNameUsedInSource

setNameUsedInSource

public void setNameUsedInSource(TaxonNameBase nameUsedInSource)

Parameters:

nameUsedInReference - the nameUsedInReference to set

clone

public DescriptionElementSource clone(DescriptionElementBase sourcedObj)
                               throws CloneNotSupportedException

Clones this original source and sets the clones sourced object to 'sourceObj'

Throws:

CloneNotSupportedException

See Also:

Object.clone()

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: VersionableEntity

Clones this versionable entity. Set fields for nextVersion, previousVersion, updated, updatedBy and createdBy are set to null The id is set to 0. The uuid is created new. The createdWhen is set to the current date.

Overrides:

clone in class OriginalSourceBase<DescriptionElementBase>

Throws:

CloneNotSupportedException

See Also:

Object.clone()