org.molgenis.omx.observ
Class DataSet

java.lang.Object
  org.molgenis.util.AbstractEntity
      org.molgenis.omx.observ.Characteristic
          org.molgenis.omx.observ.DataSet

All Implemented Interfaces:

Serializable, Autoid, Identifiable, Entity

@Entity
public class DataSet
extends Characteristic

DataSet: Container for one or more observations that are measured using the same protocol and by the same performer(s). The dataset may be a file (having the same identifier) but in most cases it is a data table consisting of rows (Observation). This entity replaces ProtocolApplication. .

Author:

MOLGENIS generator

See Also:

Serialized Form

Field Summary

static String	ENDTIME
static String	ID
static String	PROTOCOLUSED
static String	PROTOCOLUSED_IDENTIFIER
static String	STARTTIME

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

__TYPE, DESCRIPTION, IDENTIFIER, NAME

Constructor Summary

DataSet()

DataSet(DataSet copyMe)
copy constructor

Method Summary

DataSet	create(Tuple tuple)
boolean	equals(Object obj)
static List<? extends DataSet>	find(Database db, QueryRule... rules) Shorthand for db.find(DataSet.class, org.molgenis.framework.db.QueryRule ...
static DataSet	findById(Database db, Integer id)
static DataSet	findByIdentifier(Database db, String identifier)
Object	get(String name) Generic getter.
Date	getEndTime() Get the (Optional) time when the protocol ended..
Date	getEndTime(Database db) Deprecated.
Vector<String>	getFields()
Vector<String>	getFields(boolean skipAutoIds) Get the names of all public properties of DataSet.
String	getFields(String sep) Deprecated.
String	getIdField()
Object	getIdValue()
List<String>	getLabelFields()
Integer	getProtocolUsed_Id()
String	getProtocolUsed_Identifier() Get a pretty label Identifier for cross reference ProtocolUsed to Protocol.Id.
Protocol	getProtocolUsed() Get the Reference to the protocol that is being used (if available).
Protocol	getProtocolUsed(Database db) Deprecated.
Date	getStartTime() Get the time when the protocol started..
Date	getStartTime(Database db) Deprecated.
String	getValues(String sep) Deprecated.
String	getXrefIdFieldName(String fieldName)
int	hashCode()
static Query<? extends DataSet>	query(Database db) Shorthand for db.query(DataSet.class).
void	set(Tuple tuple, boolean strict)
void	setEndTime(Date endTime) Set the (Optional) time when the protocol ended..
void	setProtocolUsed_Id(Integer protocolUsed_id) Set foreign key for field protocolUsed.
void	setProtocolUsed_Identifier(String protocolUsed_Identifier) Set a pretty label for cross reference ProtocolUsed to Protocol.Id.
void	setProtocolUsed(Integer protocolUsed_id)
void	setProtocolUsed(Protocol protocolUsed) Set the Reference to the protocol that is being used (if available).
void	setStartTime(Date startTime) Set the time when the protocol started..
String	toString()
String	toString(boolean verbose)
void	validate()

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

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

Methods inherited from class org.molgenis.util.AbstractEntity

getLabelValue, getValues, isObjectRepresentation, isReadonly, set, set, setReadonly, setValuesFromString, string2date

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.molgenis.util.Entity

getLabelValue, getValues, isReadonly, set, set, setReadonly

Field Detail

PROTOCOLUSED

public static final String PROTOCOLUSED

See Also:

Constant Field Values

PROTOCOLUSED_IDENTIFIER

public static final String PROTOCOLUSED_IDENTIFIER

See Also:

Constant Field Values

STARTTIME

public static final String STARTTIME

See Also:

Constant Field Values

ENDTIME

public static final String ENDTIME

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

DataSet

public DataSet()

DataSet

public DataSet(DataSet copyMe)
        throws Exception

copy constructor

Throws:

Exception

Method Detail

query

public static Query<? extends DataSet> query(Database db)

Shorthand for db.query(DataSet.class).

find

public static List<? extends DataSet> find(Database db,
                                           QueryRule... rules)
                                    throws DatabaseException

Shorthand for db.find(DataSet.class, org.molgenis.framework.db.QueryRule ... rules).

Throws:

DatabaseException

findById

public static DataSet findById(Database db,
                               Integer id)
                        throws DatabaseException

Throws:

DatabaseException

findByIdentifier

public static DataSet findByIdentifier(Database db,
                                       String identifier)
                                throws DatabaseException

Throws:

DatabaseException

getProtocolUsed

public Protocol getProtocolUsed()

Get the Reference to the protocol that is being used (if available).

Returns:

protocolUsed.

getProtocolUsed

@Deprecated
public Protocol getProtocolUsed(Database db)

Deprecated.

setProtocolUsed

public void setProtocolUsed(Protocol protocolUsed)

Set the Reference to the protocol that is being used (if available).

Parameters:

protocolUsed -

setProtocolUsed_Id

public void setProtocolUsed_Id(Integer protocolUsed_id)

Set foreign key for field protocolUsed. This will erase any foreign key objects currently set. FIXME: can we autoload the new object?

setProtocolUsed

public void setProtocolUsed(Integer protocolUsed_id)

getProtocolUsed_Id

public Integer getProtocolUsed_Id()

getProtocolUsed_Identifier

public String getProtocolUsed_Identifier()

Get a pretty label Identifier for cross reference ProtocolUsed to Protocol.Id.

setProtocolUsed_Identifier

public void setProtocolUsed_Identifier(String protocolUsed_Identifier)

Set a pretty label for cross reference ProtocolUsed to Protocol.Id. Implies setProtocolUsed(null) until save

getStartTime

public Date getStartTime()

Get the time when the protocol started..

Returns:

startTime.

getStartTime

@Deprecated
public Date getStartTime(Database db)

Deprecated.

setStartTime

public void setStartTime(Date startTime)

Set the time when the protocol started..

Parameters:

startTime -

getEndTime

public Date getEndTime()

Get the (Optional) time when the protocol ended..

Returns:

endTime.

getEndTime

@Deprecated
public Date getEndTime(Database db)

Deprecated.

setEndTime

public void setEndTime(Date endTime)

Set the (Optional) time when the protocol ended..

Parameters:

endTime -

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

validate

public void validate()
              throws DatabaseException

Specified by:

validate in interface Entity

Overrides:

validate in class Characteristic

Throws:

DatabaseException

set

public void set(Tuple tuple,
                boolean strict)
         throws Exception

Specified by:

set in interface Entity

Overrides:

set in class Characteristic

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Characteristic

toString

public String toString(boolean verbose)

Overrides:

toString in class Characteristic

getFields

public Vector<String> getFields(boolean skipAutoIds)

Get the names of all public properties of DataSet.

Specified by:

getFields in interface Entity

Overrides:

getFields in class Characteristic

getFields

public Vector<String> getFields()

Specified by:

getFields in interface Entity

Overrides:

getFields in class Characteristic

getIdField

public String getIdField()

Specified by:

getIdField in interface Entity

Overrides:

getIdField in class Characteristic

getLabelFields

public List<String> getLabelFields()

Specified by:

getLabelFields in interface Entity

Overrides:

getLabelFields in class Characteristic

getFields

@Deprecated
public String getFields(String sep)

Deprecated.

Specified by:

getFields in interface Entity

Overrides:

getFields in class Characteristic

getIdValue

public Object getIdValue()

Specified by:

getIdValue in interface Entity

Overrides:

getIdValue in class Characteristic

getXrefIdFieldName

public String getXrefIdFieldName(String fieldName)

Specified by:

getXrefIdFieldName in interface Entity

Overrides:

getXrefIdFieldName in class Characteristic

getValues

@Deprecated
public String getValues(String sep)

Deprecated.

Specified by:

getValues in interface Entity

Overrides:

getValues in class Characteristic

create

public DataSet create(Tuple tuple)
               throws Exception

Specified by:

create in interface Entity

Overrides:

create in class Characteristic

Throws:

Exception

equals

public boolean equals(Object obj)

Overrides:

equals in class Characteristic

hashCode

public int hashCode()

Overrides:

hashCode in class Characteristic