eu.etaxonomy.cdm.model.common

Class SourcedEntityBase<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

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.SourcedEntityBase<SOURCE>

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, ISelfDescriptive, IVersionableEntity, ISourceable<SOURCE>, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

IdentifiableEntity, TypeDesignationBase

@MappedSuperclass
public abstract class SourcedEntityBase<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>
extends AnnotatableEntity
implements ISourceable<SOURCE>

Abstract class for all objects that may have (multiple) sources

Since:

14-Jan-2019 13:06:47

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

CLOB_LENGTH, uuid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SourcedEntityBase()

Method Summary

Modifier and Type	Method and Description
SOURCE	addAggregationSource(ICdmTarget target) Adds a source which links to another CDM object as source.
SOURCE	addImportSource(java.lang.String id, java.lang.String idNamespace, Reference citation, java.lang.String microCitation) Adds a source of type OriginalSourceType.Import to this object.
SOURCE	addPrimaryTaxonomicSource(Reference citation) Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.
SOURCE	addPrimaryTaxonomicSource(Reference citation, java.lang.String microCitation) Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.
SOURCE	addSource(OriginalSourceType type, Reference reference, java.lang.String microReference, java.lang.String originalInformation)
SOURCE	addSource(OriginalSourceType type, java.lang.String id, java.lang.String idNamespace, Reference citation, java.lang.String microCitation) Adds a source that is newly created by its components.
void	addSource(SOURCE source) Adds a source to this object
void	addSources(java.util.Set<SOURCE> sources) Adds a set of original sources (citations) for this sourceable object
java.lang.Object	clone() Clones this versionable entity.
protected abstract SOURCE	createNewSource(OriginalSourceType type, java.lang.String idInSource, java.lang.String idNamespace, Reference citation, java.lang.String microReference, java.lang.String originalInformation, ICdmTarget target)
java.util.Set<SOURCE>	getSources() Returns the set of original sources (citations) for this sourceable object
void	removeSource(SOURCE source) Removes a source from this object
void	removeSources()

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

addAnnotation, addMarker, addMarker, getAnnotations, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker, setAnnotations

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

cloneLanguageString, equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

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

addPropertyChangeListener, addPropertyChangeListener, addToSetWithChangeEvent, deproxy, deproxy, fireOnCreateEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUserFriendlyDescription, getUserFriendlyFieldName, getUserFriendlyTypeName, getUuid, hashCode, hasListeners, initListener, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isBlank, isInstanceOf, isNotBlank, isPersited, removeFromSetWithChangeEvent, removePropertyChangeListener, removePropertyChangeListener, replaceInList, setCreated, setCreatedBy, setId, setNewEntityListener, setUuid, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid

Constructor Detail

SourcedEntityBase

protected SourcedEntityBase()

Method Detail

getSources

public java.util.Set<SOURCE> getSources()

Description copied from interface: ISourceable

Returns the set of original sources (citations) for this sourceable object

Specified by:

getSources in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

Returns:

addSource

public void addSource(SOURCE source)

Description copied from interface: ISourceable

Adds a source to this object

Specified by:

addSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

addSource

public SOURCE addSource(OriginalSourceType type,
                        java.lang.String id,
                        java.lang.String idNamespace,
                        Reference citation,
                        java.lang.String microCitation)

Description copied from interface: ISourceable

Adds a source that is newly created by its components. If all components except for the type are null no source is added.

Specified by:

addSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

Parameters:

type - the type of the source

idNamespace - the namespace for the id in the source

citation - the source as a reference

microCitation - the details (e.g. page number) in the reference

addSource

public SOURCE addSource(OriginalSourceType type,
                        Reference reference,
                        java.lang.String microReference,
                        java.lang.String originalInformation)

Specified by:

addSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

Returns:

the added source

addAggregationSource

public SOURCE addAggregationSource(ICdmTarget target)

Description copied from interface: ISourceable

Adds a source which links to another CDM object as source.

Specified by:

addAggregationSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

Parameters:

target - the target CDM source

Returns:

the aggregation source

addSources

public void addSources(java.util.Set<SOURCE> sources)

Description copied from interface: ISourceable

Adds a set of original sources (citations) for this sourceable object

Specified by:

addSources in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

addImportSource

public SOURCE addImportSource(java.lang.String id,
                              java.lang.String idNamespace,
                              Reference citation,
                              java.lang.String microCitation)

Description copied from interface: ISourceable

Adds a source of type OriginalSourceType.Import to this object.

Specified by:

addImportSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

idNamespace - the namespace for the id in the source

citation - the source as a reference

microCitation - the details (e.g. page number) in the reference

addPrimaryTaxonomicSource

public SOURCE addPrimaryTaxonomicSource(Reference citation,
                                        java.lang.String microCitation)

Description copied from interface: ISourceable

Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.

Specified by:

addPrimaryTaxonomicSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

Parameters:

citation - the source as a reference

microCitation - the details (e.g. page number) in the reference

addPrimaryTaxonomicSource

public SOURCE addPrimaryTaxonomicSource(Reference citation)

Description copied from interface: ISourceable

Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.

Specified by:

addPrimaryTaxonomicSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

Parameters:

citation - the source as a reference

removeSource

public void removeSource(SOURCE source)

Description copied from interface: ISourceable

Removes a source from this object

Specified by:

removeSource in interface ISourceable<SOURCE extends OriginalSourceBase<? extends SourcedEntityBase<SOURCE>>>

removeSources

public void removeSources()

createNewSource

protected abstract SOURCE createNewSource(OriginalSourceType type,
                                          java.lang.String idInSource,
                                          java.lang.String idNamespace,
                                          Reference citation,
                                          java.lang.String microReference,
                                          java.lang.String originalInformation,
                                          ICdmTarget target)

clone

public java.lang.Object clone()
                       throws java.lang.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 AnnotatableEntity

Throws:

java.lang.CloneNotSupportedException

See Also:

Object.clone()