org.molgenis.omx.observ

Class Protocol

java.lang.Object

org.molgenis.data.support.AbstractEntity

org.molgenis.omx.observ.Characteristic

org.molgenis.omx.observ.Protocol

All Implemented Interfaces:

Serializable, Entity, Autoid, Identifiable

@Entity
public class Protocol
extends Characteristic
implements Entity

Protocol: The Protocol class defines parameterizable descriptions of (analysis)methods. Examples of protocols are: Questionaires, SOPs, Assay platforms, Statistical analyses, etc. Each protocol has a unique identifier. Protocol has an association to OntologyTerm to represent the type of protocol. .

Author:

MOLGENIS generator

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE
static String	ENTITY_NAME
static String	FEATURES
static String	ID
static String	PROTOCOLTYPE
static String	REQUIREDFEATURES
static String	ROOT
static String	SUBPROTOCOLS

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

__TYPE, DESCRIPTION, IDENTIFIER, NAME

Constructor Summary

Constructors

Constructor and Description
Protocol()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(String name) Generic getter.
Boolean	getActive() Get the whether this protocol is considered active/inactive.
Iterable<String>	getAttributeNames()
EntityMetaData	getEntityMetaData()
String	getEntityName()
List<ObservableFeature>	getFeatures() Get the parameters (in/out) that are used or produced by this protocol..
Integer	getIdValue()
List<String>	getLabelAttributeNames()
OntologyTerm	getProtocolType() Get the classification of protocol.
List<ObservableFeature>	getRequiredFeatures() Get the ...........
Boolean	getRoot() Get the Indicator whether this protocol defines a workflow (e.g is the first protocol of a workflow)..
List<Protocol>	getSubprotocols() Get the Subprotocols of this protocol.
Collection<Protocol>	getSubprotocolsProtocolCollection()
int	hashCode()
void	set(Entity entity, boolean strict)
void	set(String attributeName, Object value)
void	setActive(Boolean active) Set the whether this protocol is considered active/inactive.
void	setFeatures(List<ObservableFeature> features) Set the parameters (in/out) that are used or produced by this protocol..
void	setProtocolType(OntologyTerm protocolType) Set the classification of protocol.
void	setRequiredFeatures(List<ObservableFeature> requiredFeatures) Set the ...........
void	setRoot(Boolean root) Set the Indicator whether this protocol defines a workflow (e.g is the first protocol of a workflow)..
void	setSubprotocols(List<Protocol> subprotocols) Set the Subprotocols of this protocol.
void	setSubprotocolsProtocolCollection(Collection<Protocol> collection)
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

PROTOCOLTYPE

public static final String PROTOCOLTYPE

See Also:

Constant Field Values

SUBPROTOCOLS

public static final String SUBPROTOCOLS

See Also:

Constant Field Values

FEATURES

public static final String FEATURES

See Also:

Constant Field Values

REQUIREDFEATURES

public static final String REQUIREDFEATURES

See Also:

Constant Field Values

ROOT

public static final String ROOT

See Also:

Constant Field Values

ACTIVE

public static final String ACTIVE

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

Protocol

public Protocol()

Method Detail

getEntityName

public String getEntityName()

Overrides:

getEntityName in class Characteristic

getProtocolType

public OntologyTerm getProtocolType()

Get the classification of protocol.

Returns:

protocolType.

setProtocolType

public void setProtocolType(OntologyTerm protocolType)

Set the classification of protocol.

Parameters:

protocolType -

getSubprotocols

public List<Protocol> getSubprotocols()

Get the Subprotocols of this protocol.

Returns:

subprotocols.

setSubprotocols

public void setSubprotocols(List<Protocol> subprotocols)

Set the Subprotocols of this protocol.

Parameters:

subprotocols -

getFeatures

public List<ObservableFeature> getFeatures()

Get the parameters (in/out) that are used or produced by this protocol..

Returns:

features.

setFeatures

public void setFeatures(List<ObservableFeature> features)

Set the parameters (in/out) that are used or produced by this protocol..

Parameters:

features -

getRequiredFeatures

public List<ObservableFeature> getRequiredFeatures()

Get the ...........

Returns:

requiredFeatures.

setRequiredFeatures

public void setRequiredFeatures(List<ObservableFeature> requiredFeatures)

Set the ...........

Parameters:

requiredFeatures -

getRoot

public Boolean getRoot()

Get the Indicator whether this protocol defines a workflow (e.g is the first protocol of a workflow)..

Returns:

root.

setRoot

public void setRoot(Boolean root)

Set the Indicator whether this protocol defines a workflow (e.g is the first protocol of a workflow)..

Parameters:

root -

getActive

public Boolean getActive()

Get the whether this protocol is considered active/inactive.

Returns:

active.

setActive

public void setActive(Boolean active)

Set the whether this protocol is considered active/inactive.

Parameters:

active -

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

getSubprotocolsProtocolCollection

public Collection<Protocol> getSubprotocolsProtocolCollection()

setSubprotocolsProtocolCollection

public void setSubprotocolsProtocolCollection(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