2.17.2: 2011-06-17

net.sf.basedb.core.data
Interface AnnotatableData

All Superinterfaces:
IdentifiableData
All Known Implementing Classes:
AnnotatedData, ArrayBatchData, ArrayDesignData, ArraySlideData, BioAssayData, BioAssaySetData, BioMaterialData, BioPlateData, BioSourceData, ExtractData, HybridizationData, LabeledExtractData, MeasuredBioMaterialData, PlateData, PluginConfigurationData, PluginDefinitionData, ProtocolData, RawBioAssayData, SampleData, ScanData, WellData

public interface AnnotatableData
extends IdentifiableData

An annotatable item is an item that can be annotated with name/value pairs. All annotations are held in an AnnotationSetData object.

This interface defines Hibernate database mapping for the annotationSet association to a column with the name annotationset_id. If a subclass wants to map the association to another column, it should override the getAnnotationSet() method and add a Hibernate tag in the comment.

Reference implementation

private AnnotationSetData annotationSet;
public AnnotationSetData getAnnotationSet()
{
   return annotationSet;
}
public void setAnnotationSet(AnnotationSetData annotationSet)
{
   this.annotationSet = annotationSet;
}

Version:
2.0
Author:
Nicklas
See Also:
AnnotatedData, AnnotationSetData, AnnotationData, AnnotationTypeData, Annotatable, Annotations overview

Method Summary
 AnnotationSetData getAnnotationSet()
          Get the annotation set that holds the annotations for an item.
 void setAnnotationSet(AnnotationSetData annotationSet)
          Change the annotation set.
 
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData
getId, getVersion
 

Method Detail

getAnnotationSet

AnnotationSetData getAnnotationSet()
Get the annotation set that holds the annotations for an item.

Returns:
An AnnotationSetData item or null if no annotations exist
Hibernate: many-to-one
column="`annotationset_id`" not-null="false" unique="true" outer-join="false" cascade="delete"

setAnnotationSet

void setAnnotationSet(AnnotationSetData annotationSet)
Change the annotation set. Use null to remove the annotations.

Parameters:
annotationSet - Annotation set to change to.

2.17.2: 2011-06-17