net.sf.basedb.core.data
Class BioPlateEventParticipantData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.BioPlateEventParticipantData

All Implemented Interfaces:

IdentifiableData

public class BioPlateEventParticipantData
extends BasicData

Registers a plate as a participant in a bioplate event. Each participant may have a 'role' that is simply a free textual description of how the plate was used. Eg. for a 'move' event there can be 'source' and 'destination' plates. If the ordering of plates are important it is also possible to specify an index value. The index doesn't have to unique, but a plate can only be a registered as a participant once per event.

Since:

2.17

Author:

Nicklas

See Also:

BioPlateEventParticipant, Biomaterials overview

Last modified

$Date: 2010-12-02 14:35:04 +0100 (Thu, 02 Dec 2010) $

Hibernate: class

table="`BioPlateEventParticipants`" lazy="true"

Field Summary

private Set<BioMaterialEventData>	bioMaterialEvents
private BioPlateData	bioPlate
private BioPlateEventData	event
private int	index
static int	MAX_ROLE_LENGTH
private String	role

Constructor Summary

BioPlateEventParticipantData()

Method Summary

Set<BioMaterialEventData>	getBioMaterialEvents() This is the inverse end.
BioPlateData	getBioPlate() The bioplate that is participating in the event.
BioPlateEventData	getEvent() The bioplate event.
int	getIndex() Get the index of this plate in the event.
String	getRole() Get the role of the plate in the event.
(package private) void	setBioMaterialEvents(Set<BioMaterialEventData> bioMaterialEvents)
void	setBioPlate(BioPlateData bioPlate)
void	setEvent(BioPlateEventData event)
void	setIndex(int index)
void	setRole(String role)

Methods inherited from class net.sf.basedb.core.data.BasicData

equals, getId, getVersion, hashCode, setId, setVersion, toString

Methods inherited from class java.lang.Object

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

Field Detail

bioPlate

private BioPlateData bioPlate

event

private BioPlateEventData event

index

private int index

MAX_ROLE_LENGTH

public static final int MAX_ROLE_LENGTH

See Also:

Constant Field Values

role

private String role

bioMaterialEvents

private Set<BioMaterialEventData> bioMaterialEvents

Constructor Detail

BioPlateEventParticipantData

public BioPlateEventParticipantData()

Method Detail

getBioPlate

public BioPlateData getBioPlate()

The bioplate that is participating in the event.

Hibernate: many-to-one

column="`bioplate_id`" not-null="true" outer-join="false" update="false" unique-key="uniqueevent"

setBioPlate

public void setBioPlate(BioPlateData bioPlate)

getEvent

public BioPlateEventData getEvent()

The bioplate event.

Hibernate: many-to-one

column="`event_id`" not-null="true" outer-join="false" update="false" unique-key="uniqueevent"

setEvent

public void setEvent(BioPlateEventData event)

getIndex

public int getIndex()

Get the index of this plate in the event. The index may or may not be unique depending on the event.

Hibernate: property

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

setIndex

public void setIndex(int index)

getRole

public String getRole()

Get the role of the plate in the event. The role is only a textual description and is not of concern to the core. The role can be null.

Hibernate: property

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

setRole

public void setRole(String role)

getBioMaterialEvents

public Set<BioMaterialEventData> getBioMaterialEvents()

This is the inverse end.

See Also:

BioMaterialEventData.getBioPlateEventParticipant()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`bioplateeventparticipant_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.BioMaterialEventData"

setBioMaterialEvents

void setBioMaterialEvents(Set<BioMaterialEventData> bioMaterialEvents)