Package net.sf.basedb.core.data

Class AnnotatedData

java.lang.Object

net.sf.basedb.core.data.BasicData

net.sf.basedb.core.data.OwnedData

net.sf.basedb.core.data.SharedData

net.sf.basedb.core.data.CommonData

net.sf.basedb.core.data.AnnotatedData

All Implemented Interfaces:

AnnotatableData, IdentifiableData, LoggableData, NameableData, OwnableData, RemovableData, ShareableData

Direct Known Subclasses:

ArrayBatchData, ArrayDesignData, ArraySlideData, BioMaterialData, BioPlateData, DerivedBioAssayData, ExperimentData, FileData, FileServerData, HardwareData, ItemListData, KitData, PhysicalBioAssayData, PlateData, PluginConfigurationData, ProtocolData, RawBioAssayData, SoftwareData, TagData

public abstract class AnnotatedData
extends CommonData
implements AnnotatableData, LoggableData

This class extends the CommonData class and implements the AnnotatableData interface. Ie. by extending this class a data item becomes annotatable.

Version:

2.0

Author:

Nicklas

See Also:

AnnotatableData, AnnotatedItem, Developer documentation: Annotations

Field Summary

Fields

Modifier and Type	Field	Description
private AnnotationSetData	annotationSet
private Set<AnnotationLink>	links

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

Constructors

Constructor	Description
AnnotatedData()

Method Summary

Modifier and Type	Method	Description
Set<AnnotationLink>	getAnnotations()	Short-cut to all annotations belonging to this item.
AnnotationSetData	getAnnotationSet()	Get the annotation set that holds the annotations for an item.
(package private) void	setAnnotations(Set<AnnotationLink> links)
void	setAnnotationSet(AnnotationSetData annotationSet)	Change the annotation set.

Methods inherited from class net.sf.basedb.core.data.CommonData

getDescription, getName, getRemovedBy, setDescription, setName, setRemovedBy

Methods inherited from class net.sf.basedb.core.data.SharedData

getItemKey, getProjectKey, setItemKey, setProjectKey

Methods inherited from class net.sf.basedb.core.data.OwnedData

getOwner, setOwner

Methods inherited from class net.sf.basedb.core.data.BasicData

equals, getId, getVersion, hashCode, setId, setVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.basedb.core.data.IdentifiableData

getId, getVersion

Methods inherited from interface net.sf.basedb.core.data.OwnableData

getOwner, setOwner

Field Details

annotationSet

private AnnotationSetData annotationSet

links

private Set<AnnotationLink> links

Constructor Details

AnnotatedData

public AnnotatedData()

Method Details

getAnnotationSet

public AnnotationSetData getAnnotationSet()

Description copied from interface: AnnotatableData

Get the annotation set that holds the annotations for an item.

Specified by:

getAnnotationSet in interface AnnotatableData

Returns:

An AnnotationSetData item or null if no annotations exist

setAnnotationSet

public void setAnnotationSet(AnnotationSetData annotationSet)

Description copied from interface: AnnotatableData

Change the annotation set. Use null to remove the annotations.

Specified by:

setAnnotationSet in interface AnnotatableData

Parameters:

annotationSet - Annotation set to change to.

getAnnotations

public Set<AnnotationLink> getAnnotations()

Description copied from interface: AnnotatableData

Short-cut to all annotations belonging to this item. Used for HQL queries only. This is the inverse end. NOTE! The property-ref="annotationSet" require that AnnotationSetData implements Serializable

Specified by:

getAnnotations in interface AnnotatableData

setAnnotations

void setAnnotations(Set<AnnotationLink> links)