org.molgenis.omx.observ

Class ObservableFeature

java.lang.Object

org.molgenis.data.support.AbstractEntity

org.molgenis.omx.observ.Characteristic

org.molgenis.omx.observ.ObservableFeature

All Implemented Interfaces:

Serializable, Entity, Autoid, Identifiable

@Entity
public class ObservableFeature
extends Characteristic
implements Entity

ObservableFeature: ObservableFeature defines anything that can be observed.

In other words, ObservableFeature are the questions asked, e.g. 'What is Height?', 'What is Systolic blood pressure?', or 'Has blue eyes?'.

Some questions may be repeated for multiple characteristics. For example 'What is [MarkerAllele] observed?' can be applied to all elements of a MarkerSet, and 'What is [medicin codes] uses' can be applied to a set of Medicine codes. This can be specified using the measuredCharacteristic field.

The identifier of ObservableFeature is globally unique. It is recommended that each ObservableFeature is named according to a well-defined ontology term or database accession. .

Author:

MOLGENIS generator

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATATYPE
static String	DEFINITIONS
static String	ENTITY_NAME
static String	ID
static String	MAXRANGE
static String	MINRANGE
static String	TEMPORAL
static String	UNIT

Fields inherited from class org.molgenis.omx.observ.Characteristic

__TYPE, DESCRIPTION, IDENTIFIER, NAME

Constructor Summary

Constructors

Constructor and Description
ObservableFeature()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(String name) Generic getter.
Iterable<String>	getAttributeNames()
String	getDataType() Get the (Optional) Reference to the technical data type.
String	getDataTypeLabel() Get tha label for enum DataType.
List<ValueLabel>	getDataTypeOptions() DataType is enum.
List<OntologyTerm>	getDefinitions() Get the The concept that is being measured in a specific way..
EntityMetaData	getEntityMetaData()
String	getEntityName()
Collection<Protocol>	getFeaturesProtocolCollection()
Integer	getIdValue()
List<String>	getLabelAttributeNames()
Long	getMaxRange() Get the for numeric values this is used to set the 'max' value of the slider user interface.
Long	getMinRange() Get the for numeric values this is used to set the 'min' value of the slider user interface.
Collection<Protocol>	getRequiredFeaturesProtocolCollection()
Boolean	getTemporal() Get the Whether this feature is time dependent and can have different values when measured on different times (e.g.
OntologyTerm	getUnit() Get the (Optional) Reference to the well-defined measurement unit used to observe this feature (if feature is that concrete).
int	hashCode()
void	set(Entity entity, boolean strict)
void	set(String attributeName, Object value)
void	setDataType(String dataType) Set the (Optional) Reference to the technical data type.
void	setDefinitions(List<OntologyTerm> definitions) Set the The concept that is being measured in a specific way..
void	setFeaturesProtocolCollection(Collection<Protocol> collection)
void	setMaxRange(Long maxRange) Set the for numeric values this is used to set the 'max' value of the slider user interface.
void	setMinRange(Long minRange) Set the for numeric values this is used to set the 'min' value of the slider user interface.
void	setRequiredFeaturesProtocolCollection(Collection<Protocol> collection)
void	setTemporal(Boolean temporal) Set the Whether this feature is time dependent and can have different values when measured on different times (e.g.
void	setUnit(OntologyTerm unit) Set the (Optional) Reference to the well-defined measurement unit used to observe this feature (if feature is that concrete).
String	toString()
String	toString(boolean verbose)

Methods inherited from class org.molgenis.omx.observ.Characteristic

get__Type, get__TypeLabel, get__TypeOptions, getDescription, getId, getIdentifier, getName, getValueMrefValueCollection, set__Type, setDescription, setId, setIdentifier, setName, setValueMrefValueCollection

Methods inherited from class org.molgenis.data.support.AbstractEntity

getBoolean, getDate, getDouble, getEntities, getEntity, getInt, getIntList, getLabelValue, getList, getLong, getString, getTimestamp, getUtilDate, isObjectRepresentation, set, setValuesFromString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.molgenis.data.Entity

getBoolean, getDate, getDouble, getEntities, getEntity, getInt, getIntList, getLabelValue, getList, getLong, getString, getTimestamp, getUtilDate, set

Field Detail

ENTITY_NAME

public static final String ENTITY_NAME

See Also:

Constant Field Values

UNIT

public static final String UNIT

See Also:

Constant Field Values

DEFINITIONS

public static final String DEFINITIONS

See Also:

Constant Field Values

DATATYPE

public static final String DATATYPE

See Also:

Constant Field Values

TEMPORAL

public static final String TEMPORAL

See Also:

Constant Field Values

MINRANGE

public static final String MINRANGE

See Also:

Constant Field Values

MAXRANGE

public static final String MAXRANGE

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

ObservableFeature

public ObservableFeature()

Method Detail

getEntityName

public String getEntityName()

Overrides:

getEntityName in class Characteristic

getUnit

public OntologyTerm getUnit()

Get the (Optional) Reference to the well-defined measurement unit used to observe this feature (if feature is that concrete). E.g. mmHg.

Returns:

unit.

setUnit

public void setUnit(OntologyTerm unit)

Set the (Optional) Reference to the well-defined measurement unit used to observe this feature (if feature is that concrete). E.g. mmHg.

Parameters:

unit -

getDefinitions

public List<OntologyTerm> getDefinitions()

Get the The concept that is being measured in a specific way..

Returns:

definitions.

setDefinitions

public void setDefinitions(List<OntologyTerm> definitions)

Set the The concept that is being measured in a specific way..

Parameters:

definitions -

getDataType

public String getDataType()

Get the (Optional) Reference to the technical data type. E.g. 'int'.

Returns:

dataType.

setDataType

public void setDataType(String dataType)

Set the (Optional) Reference to the technical data type. E.g. 'int'.

Parameters:

dataType -

getDataTypeLabel

public String getDataTypeLabel()

Get tha label for enum DataType.

getDataTypeOptions

public List<ValueLabel> getDataTypeOptions()

DataType is enum. This method returns all available enum options.

getTemporal

public Boolean getTemporal()

Get the Whether this feature is time dependent and can have different values when measured on different times (e.g. weight, temporal=true) or generally only measured once (e.g. birth date, temporal=false).

Returns:

temporal.

setTemporal

public void setTemporal(Boolean temporal)

Set the Whether this feature is time dependent and can have different values when measured on different times (e.g. weight, temporal=true) or generally only measured once (e.g. birth date, temporal=false).

Parameters:

temporal -

getMinRange

public Long getMinRange()

Get the for numeric values this is used to set the 'min' value of the slider user interface.

Returns:

minRange.

setMinRange

public void setMinRange(Long minRange)

Set the for numeric values this is used to set the 'min' value of the slider user interface.

Parameters:

minRange -

getMaxRange

public Long getMaxRange()

Get the for numeric values this is used to set the 'max' value of the slider user interface.

Returns:

maxRange.

setMaxRange

public void setMaxRange(Long maxRange)

Set the for numeric values this is used to set the 'max' value of the slider user interface.

Parameters:

maxRange -

get

public Object get(String name)

Generic getter. Get the property by using the name.

Specified by:

get in interface Entity

Overrides:

get in class Characteristic

set

public void set(Entity entity,
       boolean strict)

Specified by:

set in interface Entity

Overrides:

set in class Characteristic

toString

public String toString()

Overrides:

toString in class Characteristic

toString

public String toString(boolean verbose)

Overrides:

toString in class Characteristic

getIdValue

public Integer getIdValue()

Specified by:

getIdValue in interface Entity

Overrides:

getIdValue in class Characteristic

getFeaturesProtocolCollection

public Collection<Protocol> getFeaturesProtocolCollection()

setFeaturesProtocolCollection

public void setFeaturesProtocolCollection(Collection<Protocol> collection)

getRequiredFeaturesProtocolCollection

public Collection<Protocol> getRequiredFeaturesProtocolCollection()

setRequiredFeaturesProtocolCollection

public void setRequiredFeaturesProtocolCollection(Collection<Protocol> collection)

getAttributeNames

public Iterable<String> getAttributeNames()

Specified by:

getAttributeNames in interface Entity

Overrides:

getAttributeNames in class Characteristic

getLabelAttributeNames

public List<String> getLabelAttributeNames()

Specified by:

getLabelAttributeNames in interface Entity

Overrides:

getLabelAttributeNames in class Characteristic

set

public void set(String attributeName,
       Object value)

Specified by:

set in interface Entity

Overrides:

set in class Characteristic

equals

public boolean equals(Object obj)

Overrides:

equals in class Characteristic

hashCode

public int hashCode()

Overrides:

hashCode in class Characteristic

getEntityMetaData

public EntityMetaData getEntityMetaData()

Specified by:

getEntityMetaData in interface Entity

Overrides:

getEntityMetaData in class Characteristic