net.sf.basedb.info
Class AnnotationTypeInfo

java.lang.Object
  net.sf.basedb.info.BasicItemInfo
      net.sf.basedb.info.OwnedItemInfo
          net.sf.basedb.info.SharedItemInfo
              net.sf.basedb.info.CommonItemInfo
                  net.sf.basedb.info.AnnotationTypeInfo

All Implemented Interfaces:

Serializable, NameableInfo, Transferable

public class AnnotationTypeInfo
extends CommonItemInfo
implements Serializable

An information class that holds information about an AnnotationType. This class only holds simple objects that can be handled by web services.

Version:

2.5

Author:

Nicklas

See Also:

Serialized Form

Field Summary

private String	defaultValue
private boolean	enumeration
private String[]	enumValues
private String	externalId
private String[]	itemTypes
private int	multiplicity
private boolean	protocolParameter
private boolean	requiredForMiame
private static long	serialVersionUID
private String	valueType

Constructor Summary

AnnotationTypeInfo()
Creates information object with no properties set.

Method Summary

String	getDefaultValue()
String[]	getEnumValues()
String	getExternalId()
String[]	getItemTypes()
int	getMultiplicity()
String	getValueType()
boolean	isEnumeration()
boolean	isProtocolParameter()
boolean	isRequiredForMiame()
void	setDefaultValue(String defaultValue)
void	setEnumeration(boolean enumeration)
void	setEnumValues(String[] enumValues)
void	setExternalId(String externalId)
void	setItemTypes(String[] itemTypes)
void	setMultiplicity(int multiplicity)
void	setProtocolParameter(boolean protocolParameter)
void	setRequiredForMiame(boolean requiredForMiame)
void	setValueType(String valueType)

Methods inherited from class net.sf.basedb.info.CommonItemInfo

getDescription, getName, setDescription, setName

Methods inherited from class net.sf.basedb.info.SharedItemInfo

isShared, setShared

Methods inherited from class net.sf.basedb.info.OwnedItemInfo

getOwnerId, setOwnerId

Methods inherited from class net.sf.basedb.info.BasicItemInfo

getId, getVersion, setId, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

externalId

private String externalId

defaultValue

private String defaultValue

multiplicity

private int multiplicity

valueType

private String valueType

enumeration

private boolean enumeration

protocolParameter

private boolean protocolParameter

requiredForMiame

private boolean requiredForMiame

enumValues

private String[] enumValues

itemTypes

private String[] itemTypes

Constructor Detail

AnnotationTypeInfo

public AnnotationTypeInfo()

Creates information object with no properties set.

Method Detail

getDefaultValue

public String getDefaultValue()

Returns:

Returns the default value

setDefaultValue

public void setDefaultValue(String defaultValue)

Parameters:

defaultValue - The default value to set

isEnumeration

public boolean isEnumeration()

Returns:

TRUE if the annotation type is an enumeration

setEnumeration

public void setEnumeration(boolean enumeration)

Parameters:

enumeration - TRUE if the annotation type is an enumeration

getEnumValues

public String[] getEnumValues()

Returns:

Returns the possible values to select from if this annotation type is an enumeration

setEnumValues

public void setEnumValues(String[] enumValues)

Parameters:

enumValues - The possible values to select from

getExternalId

public String getExternalId()

Returns:

The external ID of the annotation type or null

setExternalId

public void setExternalId(String externalId)

Parameters:

externalId - The externalId to set

getMultiplicity

public int getMultiplicity()

Returns:

The maximum number of allowed values or 0 to allow any number of values

setMultiplicity

public void setMultiplicity(int multiplicity)

Parameters:

multiplicity - The number of values that are allowed when annotating items

isProtocolParameter

public boolean isProtocolParameter()

Returns:

TRUE if this annotation type is a protocol parameter, FALSE if it is a regular annotation

setProtocolParameter

public void setProtocolParameter(boolean protocolParameter)

Parameters:

protocolParameter - TRUE if this annotation type is a protocol parameter, FALSE if it is a regular annotation

isRequiredForMiame

public boolean isRequiredForMiame()

Returns:

TRUE if values must be specified for this annotation type in order to be MIAME compliant

setRequiredForMiame

public void setRequiredForMiame(boolean requiredForMiame)

Parameters:

requiredForMiame - TRUE if values must be specified for this annotation type in order to be MIAME compliant

getValueType

public String getValueType()

Returns:

The class of values that can be used for annotations. The value is the string representation of one of the options in Type, ie. STRING, INT, LONG

setValueType

public void setValueType(String valueType)

Parameters:

valueType - The class of values that can be used for annotations.

See Also:

getValueType()

getItemTypes

public String[] getItemTypes()

Returns:

The types of items that can be annotated with this annotation type. The value is the string representation of one of the options in Item, ie. SAMPLE, EXTRACT, BIOASSAYSET, RAWBIOASSAY, etc.

setItemTypes

public void setItemTypes(String[] itemTypes)

Parameters:

itemTypes - The type of items that can be annotated with this annotation type.

See Also:

getItemTypes()