|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.BasicItem<PlateGeometryData> net.sf.basedb.core.PlateGeometry
public class PlateGeometry
This class defines a plate geometry, which is the number of rows
and columns of wells on a Plate
. The number of rows and columns
must be specified when the item is created, and the values can't
be changed after that.
A PlateMapping
is a way to specify how one geometry can be
transformed to another. It holds information for how to map all source
wells to destination wells. For example it can
map four 96-well plates to one 384-well plate.
Plate
,
PlateMapping
Field Summary | |
---|---|
static Item |
TYPE
The type of item represented by this class. |
Fields inherited from interface net.sf.basedb.core.Nameable |
---|
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH |
Constructor Summary | |
---|---|
PlateGeometry(PlateGeometryData plateGeometryData)
|
Method Summary | |
---|---|
static PlateGeometry |
getById(DbControl dc,
int id)
Get a PlateGeometry item when you know the id. |
int |
getColumns()
Get the number of columns in this geometry. |
String |
getDescription()
Get the description for the item. |
Date |
getEntryDate()
Get the date that the item was registered in the database. |
String |
getName()
Get the name of the item. |
static PlateGeometry |
getNew(DbControl dc,
int rows,
int columns)
Create a new PlateGeometry item. |
ItemQuery<PlateType> |
getPlateTypes()
Get a query returning all plate types using this geometry. |
static ItemQuery<PlateGeometry> |
getQuery()
Get a query configured to retrieve plate geometries. |
int |
getRows()
Get the number of rows in this geometry. |
Item |
getType()
Get the type of item represented by the object. |
Set<ItemProxy> |
getUsingItems()
Get all: PlateType :s of this geometry
PlateMapping :s using this geometry
BioPlate :s using this geometry
|
boolean |
isRemoved()
Check if the removed flag is set for this item. |
boolean |
isUsed()
Check if: A PlateType with this geometry exists
A PlateMapping to/from this geometry exists
A BioPlate that uses this geometry exists
|
PlateType |
newPlateType()
Create a new PlateType of this geometry. |
private void |
setColumns(int columns)
The number of columns cannot be changed, used at object creation only. |
void |
setDescription(String description)
Set the description for the item. |
void |
setName(String name)
Set the name of the item. |
void |
setRemoved(boolean removed)
Set the removed flag for this item. |
private void |
setRows(int rows)
The number of rows cannot be changed, used at object creation only. |
Methods inherited from class net.sf.basedb.core.BasicItem |
---|
addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getVersion, hashCode, hasPermission, initPermissions, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, toTransferable, validate |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface net.sf.basedb.core.Identifiable |
---|
getId, getVersion |
Methods inherited from interface net.sf.basedb.core.AccessControlled |
---|
checkPermission, getPermissions, hasPermission |
Field Detail |
---|
public static final Item TYPE
Item.PLATEGEOMETRY
,
getType()
Constructor Detail |
---|
PlateGeometry(PlateGeometryData plateGeometryData)
Method Detail |
---|
public static PlateGeometry getNew(DbControl dc, int rows, int columns) throws InvalidDataException, BaseException
PlateGeometry
item.
dc
- The DbControl
which will be used for
permission checking and database accessrows
- The number of rowscolumns
- The number of columns
PlateGeometry
item
InvalidDataException
- If the number of rows or columns is
less than or equal to zero
BaseException
- If there is an errorpublic static PlateGeometry getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
PlateGeometry
item when you know the id.
dc
- The DbControl
which will be used for
permission checking and database access.id
- The id of the item to load
PlateGeometry
item
ItemNotFoundException
- If an item with the specified
id is not found
PermissionDeniedException
- If the logged in user doesn't
have Permission.READ
permission to the item
BaseException
- If there is another errorpublic static ItemQuery<PlateGeometry> getQuery()
ItemQuery
objectpublic Item getType()
Identifiable
Item
enumeration.
getType
in interface Identifiable
public String getName()
Nameable
getName
in interface Nameable
String
with the name of the itempublic void setName(String name) throws PermissionDeniedException, InvalidDataException
Nameable
Nameable.MAX_NAME_LENGTH
constant.
setName
in interface Nameable
name
- The new name for the item
PermissionDeniedException
- If the logged in user doesn't
have write permission
InvalidDataException
- If the name is null or longer
than specified by the Nameable.MAX_NAME_LENGTH
constantpublic String getDescription()
Nameable
getDescription
in interface Nameable
String
with a description of the itempublic void setDescription(String description) throws PermissionDeniedException, InvalidDataException
Nameable
Nameable.MAX_DESCRIPTION_LENGTH
constant.
setDescription
in interface Nameable
description
- The new description for the item
PermissionDeniedException
- If the logged in user doesn't
have write permission
InvalidDataException
- If the description longer
than specified by the Nameable.MAX_DESCRIPTION_LENGTH
constantpublic boolean isRemoved()
Removable
isRemoved
in interface Removable
public void setRemoved(boolean removed) throws PermissionDeniedException
Removable
setRemoved
in interface Removable
removed
- TRUE if the item should be flagged as removed,
FALSE otherwise
PermissionDeniedException
- If the logged in user doesn't
have Permission.DELETE
permission for setting the flag
to TRUE or Permission.WRITE
permission for setting the
flag to FALSEpublic Date getEntryDate()
Registered
getEntryDate
in interface Registered
public boolean isUsed() throws BaseException
PlateType
with this geometry exists
PlateMapping
to/from this geometry exists
BioPlate
that uses this geometry exists
isUsed
in class BasicItem<PlateGeometryData>
BaseException
- If not able to tell if item is used or not.BasicItem.getUsingItems()
public Set<ItemProxy> getUsingItems()
PlateType
:s of this geometry
PlateMapping
:s using this geometry
BioPlate
:s using this geometry
getUsingItems
in class BasicItem<PlateGeometryData>
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
public int getRows()
private void setRows(int rows) throws InvalidDataException
InvalidDataException
- If the row count is less than 1public int getColumns()
private void setColumns(int columns) throws InvalidDataException
InvalidDataException
- If the column count is less than 1public PlateType newPlateType() throws PermissionDeniedException, BaseException
PlateType
of this geometry.
PermissionDeniedException
- If the logged in user
doesn't have use permission for this plate geometry
BaseException
- If there is another errorpublic ItemQuery<PlateType> getPlateTypes()
ItemQuery
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |