|
3.2.1: 2012-12-13 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.basedb.core.BasicItem<D>
net.sf.basedb.core.OwnedItem<D>
net.sf.basedb.core.SharedItem<D>
net.sf.basedb.core.CommonItem<HardwareData>
net.sf.basedb.core.Hardware
public class Hardware
This class is used to represent individual hardware items and information about them. In the current version of BASE the only type of hardware we keep information about is scanners.
Field Summary | |
---|---|
static String |
CABINET
The id for the HardwareType object representing a
cabinet. |
static String |
CLUSTER_GENERATOR
The id for the HardwareType object representing a
cluster generator station. |
static String |
FREEZER
The id for the HardwareType object representing a
freezer. |
static String |
HYBRIDIZATION_STATION
The id for the HardwareType object representing a
hybridization station. |
static int |
MAX_VERSIONSTRING_LENGTH
The maximum length of the version variable that can be stored in the database. |
static String |
OTHER
The id for the HardwareType object representing something
else. |
static String |
PRINT_ROBOT
The id for the HardwareType object representing a
print robot. |
static String |
SCANNER
The id for the HardwareType object representing a
scanner. |
static String |
SEQUENCER
The id for the HardwareType object representing a
sequencer. |
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 | |
---|---|
Hardware(HardwareData data)
Creates a new hardware item. |
Method Summary | |
---|---|
static Hardware |
getById(DbControl dc,
int id)
Get a Hardware item when you know the ID. |
static String |
getDefaultSystemId(Item itemType)
Get the system id for the hardware subtype that should be used on an item that doesn't have a subtype. |
Date |
getEntryDate()
Get the date that the item was registered in the database. |
ItemSubtype |
getItemSubtype()
Get the subtype of the item. |
static Hardware |
getNew(DbControl dc)
Create a new Hardware item. |
static ItemQuery<Hardware> |
getQuery()
Get a query configured to retrieve hardware. |
Item |
getType()
Get the type of item represented by the object. |
Set<ItemProxy> |
getUsingItems()
Get all: DerivedBioAssay :s with this hardware
ArrayBatch :s with this hardware
BioMaterial :s and PhysicalBioAssay :s with this hardware
Plate :s with this hardware
|
String |
getVersionString()
Get the versionstring of this Hardware item. |
boolean |
isUsed()
Check if: a DerivedBioAssay is linked to this hardware
an ArrayBatch is linked to this hardware
a BioMaterialEvent is linked to this hardware
a PlateEvent is linked to this hardware
|
void |
setItemSubtype(ItemSubtype subtype)
Set the subtype on the item. |
void |
setVersionString(String versionString)
Set the versionstring for this Hardware item. |
Methods inherited from class net.sf.basedb.core.CommonItem |
---|
getDescription, getName, isRemoved, setDescription, setName, setRemoved, toTransferable |
Methods inherited from class net.sf.basedb.core.SharedItem |
---|
getItemKey, getProjectKey, initPermissions, isShared, onBeforeCommit, setItemKey, setProjectKey, toTransferable |
Methods inherited from class net.sf.basedb.core.OwnedItem |
---|
getOwner, isOwner, setOwner, takeOwnership, toTransferable |
Methods inherited from class net.sf.basedb.core.BasicItem |
---|
addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, 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 |
Methods inherited from interface net.sf.basedb.core.Ownable |
---|
getOwner, isOwner, setOwner, takeOwnership |
Field Detail |
---|
public static final Item TYPE
Item.HARDWARE
,
getType()
public static final String SCANNER
HardwareType
object representing a
scanner.
public static final String PRINT_ROBOT
HardwareType
object representing a
print robot.
public static final String HYBRIDIZATION_STATION
HardwareType
object representing a
hybridization station.
public static final String CLUSTER_GENERATOR
HardwareType
object representing a
cluster generator station. Used when creating a PhysicalBioAssay
.
public static final String SEQUENCER
HardwareType
object representing a
sequencer.
public static final String FREEZER
HardwareType
object representing a
freezer.
public static final String CABINET
HardwareType
object representing a
cabinet.
public static final String OTHER
HardwareType
object representing something
else.
public static final int MAX_VERSIONSTRING_LENGTH
setVersionString(String)
method to avoid
exceptions.
Constructor Detail |
---|
Hardware(HardwareData data)
data
- the dataMethod Detail |
---|
public static String getDefaultSystemId(Item itemType)
Subtypable
items with a
null ItemSubtype
and all other non-subtypable items which can be
linked to a hardware.
itemType
- The item type
public static Hardware getNew(DbControl dc) throws BaseException
Hardware
item.
dc
- The DbControl
which will be used for
permission checking and database access.
Hardware
item
BaseException
- If there is an errorpublic static Hardware getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
Hardware
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
Hardware
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<Hardware> getQuery() throws BaseException
ItemQuery
object
BaseException
- When the query could not be configured.public Item getType()
Identifiable
Item
enumeration.
getType
in interface Identifiable
public Date getEntryDate()
Registered
getEntryDate
in interface Registered
public ItemSubtype getItemSubtype()
Subtypable
getItemSubtype
in interface Subtypable
SubtypableRelatedItems
public void setItemSubtype(ItemSubtype subtype)
Subtypable
setItemSubtype
in interface Subtypable
subtype
- A subtype or nullItemSubtype.setOnItem(Subtypable)
public boolean isUsed() throws BaseException
DerivedBioAssay
is linked to this hardware
ArrayBatch
is linked to this hardware
BioMaterialEvent
is linked to this hardware
PlateEvent
is linked to this hardware
isUsed
in class BasicItem<HardwareData>
BaseException
- if there is any error.BasicItem.getUsingItems()
public Set<ItemProxy> getUsingItems()
DerivedBioAssay
:s with this hardware
ArrayBatch
:s with this hardware
BioMaterial
:s and PhysicalBioAssay
:s with this hardware
Plate
:s with this hardware
getUsingItems
in class BasicItem<HardwareData>
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
public String getVersionString()
Hardware
item.
public void setVersionString(String versionString) throws StringTooLongException, PermissionDeniedException
Hardware
item. The value
must not be longer than the value specified by the MAX_VERSIONSTRING_LENGTH
constant.
versionString
- The new version for this item, or null if not known
StringTooLongException
- If versionString is longer then MAX_VERSIONSTRING_LENGTH
PermissionDeniedException
- If the logged in user don't have write permission on this item
|
3.2.1: 2012-12-13 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |