net.sf.basedb.core.data
Class BioPlateTypeData

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

All Implemented Interfaces:

IdentifiableData, NameableData, RemovableData

public class BioPlateTypeData
extends BasicData
implements NameableData, RemovableData

This class holds information about a biomaterial plate type.

Since:

2.16

Author:

Nicklas

See Also:

BioPlateType, Developer documentation: Biomaterials LIMS

Last modified

$Date: 2011-10-21 13:15:41 +0200 (Fri, 21 Oct 2011) $

Hibernate: class

table="`BioPlateTypes`" lazy="false"

Field Summary

private Integer	bioMaterialType
private Set<BioPlateData>	bioPlates
private String	description
private int	lockMode
private String	name
private boolean	removed
private ItemSubtypeData	subtype

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

BioPlateTypeData()

Method Summary

Integer	getBioMaterialType() If set, plates using this type can only hold the specific biomaterial type (eg. samples, extracts or labeled extracts).
(package private) Set<BioPlateData>	getBioPlates() The bioplates that use this type.
String	getDescription() Get the description for the item.
ItemSubtypeData	getItemSubtype() Get the subtype of biomaterials that can be placed on plates of this type.
int	getLockMode() A flag indicating if plates with this type have locked wells or not. 0 = not locked; 1 = locked-after-move; 2 = locked-after-add; 3=locked-after-create
String	getName() Get the name of the item.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setBioMaterialType(Integer bioMaterialType)
(package private) void	setBioPlates(Set<BioPlateData> bioPlates)
void	setDescription(String description) Set the description for the item.
void	setItemSubtype(ItemSubtypeData subtype)
void	setLockMode(int lockMode)
void	setName(String name) Set the name of the item.
void	setRemoved(boolean removed) Set the removed flag for this item.

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

Methods inherited from interface net.sf.basedb.core.data.IdentifiableData

getId, getVersion

Field Detail

name

private String name

description

private String description

removed

private boolean removed

bioMaterialType

private Integer bioMaterialType

subtype

private ItemSubtypeData subtype

lockMode

private int lockMode

bioPlates

private Set<BioPlateData> bioPlates

Constructor Detail

BioPlateTypeData

public BioPlateTypeData()

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

getBioMaterialType

public Integer getBioMaterialType()

If set, plates using this type can only hold the specific biomaterial type (eg. samples, extracts or labeled extracts).

Hibernate: property

column="`biomaterial_type`" type="int" update="false"

setBioMaterialType

public void setBioMaterialType(Integer bioMaterialType)

getItemSubtype

public ItemSubtypeData getItemSubtype()

Get the subtype of biomaterials that can be placed on plates of this type.

Since:

3.0

Hibernate: many-to-one

column="`subtype_id`" not-null="false" outer-join="false"

setItemSubtype

public void setItemSubtype(ItemSubtypeData subtype)

getLockMode

public int getLockMode()

A flag indicating if plates with this type have locked wells or not. 0 = not locked; 1 = locked-after-move; 2 = locked-after-add; 3=locked-after-create

Hibernate: property

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

setLockMode

public void setLockMode(int lockMode)

getBioPlates

Set<BioPlateData> getBioPlates()

The bioplates that use this type. This is the inverse end.

See Also:

BioPlateData.getBioPlateType()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`bioplatetype_id`"

Hibernate: collection-one-to-many

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

setBioPlates

void setBioPlates(Set<BioPlateData> bioPlates)