eu.etaxonomy.cdm.model.common

Interface ISourceable<T extends IOriginalSource>

All Known Subinterfaces:

IArticle, IAuthoredPublicationBase, IBacterialName, IBook, IBookSection, IBotanicalName, ICdDvd, ICultivarPlantName, IDatabase, IFungusName, IGeneric, IIdentifiableEntity, IInProceedings, IJournal, IMap, INomenclaturalReference, INonViralName, IPatent, IPersonalCommunication, IPrintedUnitBase, IPrintSeries, IProceedings, IPublicationBase, IReference, IReport, ISection, ITaxonName, ITaxonNameBase, IThesis, IViralName, IVolumeReference, IWebPage, IZoologicalName

All Known Implementing Classes:

AgentBase, AnnotationType, CategoricalData, Character, Classification, Collection, CommonTaxonName, Country, DefinedTerm, DefinedTermBase, DerivationEventType, DerivedUnit, DescriptionBase, DescriptionElementBase, DescriptiveDataSet, Distribution, DnaSample, ExtensionType, Feature, FeatureTree, FieldUnit, HybridRelationshipType, IdentifiableEntity, IdentifiableMediaEntity, IndividualsAssociation, Institution, Language, MarkerType, MeasurementUnit, Media, MediaKey, MediaSpecimen, MultiAccessKey, NamedArea, NamedAreaLevel, NamedAreaType, NameRelationshipType, NameTypeDesignationStatus, NaturalLanguageTerm, NomenclaturalStatusType, OpenUrlReference, OrderedTerm, OrderedTermBase, OrderedTermVocabulary, Person, PhylogeneticTree, PolytomousKey, PresenceAbsenceTerm, QuantitativeData, Rank, Reference, ReferenceSystem, RelationshipTermBase, RightsType, SpecimenDescription, SpecimenOrObservationBase, SpecimenTypeDesignationStatus, State, StatisticalMeasure, Synonym, SynonymType, Taxon, TaxonBase, TaxonDescription, TaxonInteraction, TaxonName, TaxonNameDescription, TaxonRelationshipType, Team, TeamOrPersonBase, TermBase, TermVocabulary, TextData, TextFormat, TypeDesignationStatusBase

public interface ISourceable<T extends IOriginalSource>

Method Summary

Modifier and Type	Method and Description
T	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.
T	addPrimaryTaxonomicSource(Reference citation) Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.
T	addPrimaryTaxonomicSource(Reference citation, java.lang.String microCitation) Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.
T	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(T source) Adds a source to this object
void	addSources(java.util.Set<T> sources) Adds a set of original sources (citations) for this sourceable object
java.util.Set<T>	getSources() Returns the set of original sources (citations) for this sourceable object
void	removeSource(T source) Removes a source from this object

Method Detail

getSources

java.util.Set<T> getSources()

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

Returns:

addSources

void addSources(java.util.Set<T> sources)

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

addSource

void addSource(T source)

Adds a source to this object

Parameters:

source -

addSource

T 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. If all components except for the type are null no source is added.

Parameters:

type - the type of the source

idInSource - the id used in the source

idNamespace - the namespace for the id in the source

citation - the source as a reference

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

removeSource

void removeSource(T source)

Removes a source from this object

Parameters:

source -

addImportSource

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

Parameters:

idInSource - the id used in the source

idNamespace - the namespace for the id in the source

citation - the source as a reference

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

addPrimaryTaxonomicSource

T addPrimaryTaxonomicSource(Reference citation,
                            java.lang.String microCitation)

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

Parameters:

citation - the source as a reference

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

addPrimaryTaxonomicSource

T addPrimaryTaxonomicSource(Reference citation)

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

Parameters:

citation - the source as a reference