org.proteios.core.data

Class AnnotationTypeData

java.lang.Object

org.proteios.core.data.BasicData

org.proteios.core.data.OwnedData

org.proteios.core.data.SharedData

org.proteios.core.data.CommonData

org.proteios.core.data.AnnotationTypeData

All Implemented Interfaces:

IdentifiableData, NameableData, OwnableData, RemovableData, ShareableData

public class AnnotationTypeData
extends CommonData

This class holds information about an annotation type.

Version:

2.0

Author:

Nicklas

See Also:

AnnotationType, Annotations overview

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Hibernate: class

table="`AnnotationTypes`" lazy="false"

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ADDEDPARAMETERNAME_LENGTH
static int	MAX_ADDEDPARAMETERTYPE_LENGTH
static int	MAX_ADDEDPARAMETERVALUE_LENGTH
static int	MAX_DEFAULT_VALUE_LENGTH
static int	MAX_OPTION_LENGTH

Fields inherited from interface org.proteios.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

Constructors

Constructor and Description
AnnotationTypeData()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAddedParameterName() Get the addedParameterName value.
String	getAddedParameterType() Get the addedParameterType value.
String	getAddedParameterValue() Get the addedParameterValue value.
String	getDefaultValue() The default value of new annotations.
ParameterValueData<?>	getEnumerationValues() The allowed values if this is an enumeration.
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.
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	isRequiredForMiame() If an annotation of this type must be present for an annotatable item to be compliant with MIAME.
void	setAddedParameterName(String addedParameterName) Set the addedParameterName value.
void	setAddedParameterType(String addedParameterType) Set the addedParameterType value.
void	setAddedParameterValue(String addedParameterValue) Set the addedParameterValue value.
void	setDefaultValue(String defaultValue)
void	setEnumeration(boolean isEnumeration)
void	setEnumerationValues(ParameterValueData<?> enumerationValues)
void	setHeight(int height)
void	setMultiplicity(int multiplicity)
void	setRequiredForMiame(boolean requiredForMiame)
void	setValueType(int valueType)
void	setWidth(int width)

Methods inherited from class org.proteios.core.data.CommonData

getDescription, getName, isRemoved, setDescription, setName, setRemoved

Methods inherited from class org.proteios.core.data.SharedData

getItemKey, getProjectKey, setItemKey, setProjectKey

Methods inherited from class org.proteios.core.data.OwnedData

getOwner, setOwner

Methods inherited from class org.proteios.core.data.BasicData

equals, getId, getVersion, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.proteios.core.data.IdentifiableData

getId, getVersion

Methods inherited from interface org.proteios.core.data.OwnableData

getOwner, setOwner

Field Detail

MAX_DEFAULT_VALUE_LENGTH

public static final int MAX_DEFAULT_VALUE_LENGTH

See Also:

Constant Field Values

MAX_OPTION_LENGTH

public static final int MAX_OPTION_LENGTH

See Also:

Constant Field Values

MAX_ADDEDPARAMETERTYPE_LENGTH

public static final int MAX_ADDEDPARAMETERTYPE_LENGTH

See Also:

Constant Field Values

MAX_ADDEDPARAMETERNAME_LENGTH

public static final int MAX_ADDEDPARAMETERNAME_LENGTH

See Also:

Constant Field Values

MAX_ADDEDPARAMETERVALUE_LENGTH

public static final int MAX_ADDEDPARAMETERVALUE_LENGTH

See Also:

Constant Field Values

Constructor Detail

AnnotationTypeData

public AnnotationTypeData()

Method Detail

getMultiplicity

public int getMultiplicity()

How many values are allowed for this annotations of this type. 0 = no limit

Hibernate: property

column="`multiplicity`" type="int" not-null="true"

setMultiplicity

public void setMultiplicity(int multiplicity)

isRequiredForMiame

public boolean isRequiredForMiame()

If an annotation of this type must be present for an annotatable item to be compliant with MIAME.

Hibernate: property

column="`required_for_miame`" type="boolean" not-null="true"

setRequiredForMiame

public void setRequiredForMiame(boolean requiredForMiame)

isEnumeration

public boolean isEnumeration()

If this annotation type defines a list of allowed values or not.

Hibernate: property

column="`is_enumeration`" type="boolean" not-null="true"

setEnumeration

public void setEnumeration(boolean isEnumeration)

getHeight

public int getHeight()

The recommended height (lines) to display input fields for this annotation in client applications.

Hibernate: property

column="`height`" type="int" not-null="true"

setHeight

public void setHeight(int height)

getWidth

public int getWidth()

The recommended width (characters) to display input fields for this annotation in client applications.

Hibernate: property

column="`width`" type="int" not-null="true"

setWidth

public void setWidth(int width)

getDefaultValue

public String getDefaultValue()

The default value of new annotations.

Hibernate: property

column="`default_value`" type="string" length="255" not-null="false"

setDefaultValue

public void setDefaultValue(String defaultValue)

getValueType

public int getValueType()

The code for the value type.

Hibernate: property

column="`value_type`" type="int" not-null="true" update="false"

setValueType

public void setValueType(int valueType)

getItemTypes

public Set<Integer> getItemTypes()

The item code for all items this annotation type can be applied to.

Hibernate: set

table="`AnnotationTypeItems`" lazy="true"

Hibernate: collection-key

column="`annotationtype_id`"

Hibernate: collection-element

column="`item_type`" type="int"

getOptions

public Map<String,String> getOptions()

Additional options depending on the value type.

Hibernate: map

table="`AnnotationTypeOptions`" lazy="true"

Hibernate: collection-key

column="`annotationtype_id`"

Hibernate: collection-index

column="`name`" type="string" length="255" not-null="true"

Hibernate: collection-element

column="`value`" type="string" length="255" not-null="true"

getEnumerationValues

public ParameterValueData<?> getEnumerationValues()

The allowed values if this is an enumeration.

Hibernate: many-to-one

column="`enumerationvalues_id`" not-null="false" cascade="all" unique="true"

setEnumerationValues

public void setEnumerationValues(ParameterValueData<?> enumerationValues)

getAddedParameterType

public String getAddedParameterType()

Get the addedParameterType value. An added parameter is a triplet of String Type, Name, and Value, representing a specific parameter. An example is a cvParam XML block, that contains String data for cvLabel, accession, name, and value. The name will be stored as the name of the annotationType and the value as the annotation value. The annotation is marked as being a cvParam annotation by having the following additional parameters set to non-null: addedParameterType = "cvParam" addedParameterName = cvLabel (the value from the cvParam XML tag) addedParameterValue = accession (the value from the cvParam XML tag)

Returns:

String the addedParameterType value.

Hibernate: property

column="`addedParameterType`" type="string" length="255" not-null="false"

setAddedParameterType

public void setAddedParameterType(String addedParameterType)

Set the addedParameterType value. An added parameter is a triplet of String Type, Name, and Value, representing a specific parameter. An example is a cvParam XML block, that contains String data for cvLabel, accession, name, and value. The name will be stored as the name of the annotationType and the value as the annotation value. The annotation is marked as being a cvParam annotation by having the following additional parameters set to non-null: addedParameterType = "cvParam" addedParameterName = cvLabel (the value from the cvParam XML tag) addedParameterValue = accession (the value from the cvParam XML tag)

Parameters:

addedParameterType - String the addedParameterType value to set.

getAddedParameterName

public String getAddedParameterName()

Get the addedParameterName value.

Returns:

String the addedParameterName value.

Hibernate: property

column="`addedParameterName`" type="string" length="255" not-null="false"

setAddedParameterName

public void setAddedParameterName(String addedParameterName)

Set the addedParameterName value.

Parameters:

addedParameterName - String the addedParameterName value to set.

getAddedParameterValue

public String getAddedParameterValue()

Get the addedParameterValue value.

Returns:

String the addedParameterValue value.

Hibernate: property

column="`addedParameterValue`" type="string" length="255" not-null="false"

setAddedParameterValue

public void setAddedParameterValue(String addedParameterValue)

Set the addedParameterValue value.

Parameters:

addedParameterValue - String the addedParameterValue value to set.