public class AnnotationTypeData extends CommonData implements RegisteredData, LoggableData
AnnotationType
,
Developer documentation: AnnotationsModifier and Type | Field and Description |
---|---|
private Set<AnnotationData> |
annotations |
private Set<AnnotationTypeCategoryData> |
categories |
private UnitData |
defaultUnit |
private String |
defaultValue |
private boolean |
disableLogOfValues |
private Date |
entryDate |
private ParameterValueData<?> |
enumerationValues |
private Set<ExperimentData> |
experiments |
private String |
externalId |
private int |
height |
private boolean |
isEnumeration |
private boolean |
isProtocolParameter |
private Set<Integer> |
itemTypes |
static int |
MAX_DEFAULT_VALUE_LENGTH |
static int |
MAX_EXTERNAL_ID_LENGTH
The maximum length of the external id that can be stored in the database.
|
static int |
MAX_OPTION_LENGTH |
private int |
multiplicity |
private Map<String,String> |
options |
private Set<ProtocolData> |
protocols |
private QuantityData |
quantity |
private boolean |
requiredForMiame |
private Set<UnitData> |
usableUnits |
private int |
valueType |
private int |
width |
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
Constructor and Description |
---|
AnnotationTypeData() |
Modifier and Type | Method and Description |
---|---|
(package private) Set<AnnotationData> |
getAnnotations()
This is the inverse end.
|
Set<AnnotationTypeCategoryData> |
getCategories()
Get the set that manages the categories of this annotation type.
|
UnitData |
getDefaultUnit()
Get the unit used to store annotation values for this type.
|
String |
getDefaultValue()
The default value of new annotations.
|
boolean |
getDisableLogOfValues()
If this flag is set, logging of actual annotation values should not
be done in the change history.
|
Date |
getEntryDate()
Get the date this item was added to the database.
|
ParameterValueData<?> |
getEnumerationValues()
The allowed values if this is an enumeration.
|
(package private) Set<ExperimentData> |
getExperiments()
This is the inverse end.
|
String |
getExternalId()
Get the external id for the biomaterial
|
int |
getHeight()
The recommended height (lines) to display input fields for this
annotation in client applications.
|
Set<Integer> |
getItemTypes()
The item code for all items this annotation type can be applied to.
|
int |
getMultiplicity()
How many values are allowed for this annotations of this type. 0 = no limit
|
Map<String,String> |
getOptions()
Additional options depending on the value type.
|
(package private) Set<ProtocolData> |
getProtocols()
This is the inverse end.
|
QuantityData |
getQuantity()
Get the quantity this annotation type uses.
|
Set<UnitData> |
getUsableUnits()
The units that it makes sense to use with this annotation type.
|
int |
getValueType()
The code for the value type.
|
int |
getWidth()
The recommended width (characters) to display input fields for this
annotation in client applications.
|
boolean |
isEnumeration()
If this annotation type defines a list of allowed values or not.
|
boolean |
isProtocolParameter()
If this annotation type is intended to be used as a protocol
parameter or as a regular annotation.
|
boolean |
isRequiredForMiame()
If an annotation of this type must be present for an annotatable item to be
compliant with MIAME.
|
(package private) void |
setAnnotations(Set<AnnotationData> annotations) |
(package private) void |
setCategories(Set<AnnotationTypeCategoryData> categories) |
void |
setDefaultUnit(UnitData defaultUnit) |
void |
setDefaultValue(String defaultValue) |
void |
setDisableLogOfValues(boolean disableLogOfValues) |
void |
setEntryDate(Date entryDate) |
void |
setEnumeration(boolean isEnumeration) |
void |
setEnumerationValues(ParameterValueData<?> enumerationValues) |
(package private) void |
setExperiments(Set<ExperimentData> experiments) |
void |
setExternalId(String externalId) |
void |
setHeight(int height) |
(package private) void |
setItemTypes(Set<Integer> itemTypes) |
void |
setMultiplicity(int multiplicity) |
(package private) void |
setOptions(Map<String,String> options) |
void |
setProtocolParameter(boolean isProtocolParameter) |
(package private) void |
setProtocols(Set<ProtocolData> protocols) |
void |
setQuantity(QuantityData quantity) |
void |
setRequiredForMiame(boolean requiredForMiame) |
(package private) void |
setUsableUnits(Set<UnitData> usableUnits) |
void |
setValueType(int valueType) |
void |
setWidth(int width) |
getDescription, getName, isRemoved, setDescription, setName, setRemoved
getItemKey, getProjectKey, setItemKey, setProjectKey
equals, getId, getVersion, hashCode, setId, setVersion, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getVersion
getOwner, setOwner
private Date entryDate
private QuantityData quantity
private UnitData defaultUnit
public static final int MAX_EXTERNAL_ID_LENGTH
setExternalId(String)
,
Constant Field Valuesprivate String externalId
private int multiplicity
private boolean requiredForMiame
private boolean isEnumeration
private int height
private int width
private String defaultValue
public static final int MAX_DEFAULT_VALUE_LENGTH
private int valueType
private boolean disableLogOfValues
public static final int MAX_OPTION_LENGTH
private ParameterValueData<?> enumerationValues
private Set<ExperimentData> experiments
private Set<AnnotationData> annotations
private boolean isProtocolParameter
private Set<ProtocolData> protocols
private Set<AnnotationTypeCategoryData> categories
public Date getEntryDate()
RegisteredData
getEntryDate
in interface RegisteredData
public void setEntryDate(Date entryDate)
public QuantityData getQuantity()
public void setQuantity(QuantityData quantity)
public UnitData getDefaultUnit()
public void setDefaultUnit(UnitData defaultUnit)
public Set<UnitData> getUsableUnits()
public String getExternalId()
public void setExternalId(String externalId)
public int getMultiplicity()
public void setMultiplicity(int multiplicity)
public boolean isRequiredForMiame()
public void setRequiredForMiame(boolean requiredForMiame)
public boolean isEnumeration()
public void setEnumeration(boolean isEnumeration)
public int getHeight()
public void setHeight(int height)
public int getWidth()
public void setWidth(int width)
public String getDefaultValue()
public void setDefaultValue(String defaultValue)
public int getValueType()
public void setValueType(int valueType)
public boolean getDisableLogOfValues()
public void setDisableLogOfValues(boolean disableLogOfValues)
public Set<Integer> getItemTypes()
public Map<String,String> getOptions()
public ParameterValueData<?> getEnumerationValues()
public void setEnumerationValues(ParameterValueData<?> enumerationValues)
Set<ExperimentData> getExperiments()
ExperimentData.getExperimentalFactors()
void setExperiments(Set<ExperimentData> experiments)
Set<AnnotationData> getAnnotations()
AnnotationData.getAnnotationType()
void setAnnotations(Set<AnnotationData> annotations)
public boolean isProtocolParameter()
public void setProtocolParameter(boolean isProtocolParameter)
Set<ProtocolData> getProtocols()
ProtocolData.getParameters()
void setProtocols(Set<ProtocolData> protocols)
public Set<AnnotationTypeCategoryData> getCategories()
void setCategories(Set<AnnotationTypeCategoryData> categories)