|
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<D> net.sf.basedb.core.OwnedItem<D> net.sf.basedb.core.SharedItem<D> net.sf.basedb.core.CommonItem<D> net.sf.basedb.core.AnnotatedItem<ArrayBatchData> net.sf.basedb.core.ArrayBatch
public class ArrayBatch
This class represents the making of a new batch of microarray slides of a particular design.
Field Summary | |
---|---|
private boolean |
protocolHasBeenSet
|
private boolean |
robotHasBeenSet
|
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 | |
---|---|
ArrayBatch(ArrayBatchData annotatedData)
|
Method Summary | |
---|---|
Set<Annotatable> |
getAnnotatableParents()
Get the array design. |
ArrayDesign |
getArrayDesign()
Get the ArrayDesign item that was used for this batch. |
ItemQuery<ArraySlide> |
getArraySlides()
Get a query that returns the slides in this batch. |
static ArrayBatch |
getById(DbControl dc,
int id)
Get a ArrayBatch object when you know the ID. |
Date |
getEntryDate()
Get the date that the item was registered in the database. |
static ArrayBatch |
getNew(DbControl dc,
ArrayDesign arrayDesign)
Create a new ArrayBatch item. |
Hardware |
getPrintRobot()
Get the print robot used for printing the arrays. |
Protocol |
getProtocol()
Get the Protocol used for printing the arrays. |
static ItemQuery<ArrayBatch> |
getQuery()
Get a ItemQuery that returns array batches. |
Item |
getType()
Get the type of item represented by the object. |
Set<ItemProxy> |
getUsingItems()
Get all: ArraySlide :s in this batch
|
boolean |
isUsed()
Check if this item is used by some other item. |
ArraySlide |
newArraySlide()
Create a new ArraySlide item for this batch. |
private void |
setArrayDesign(ArrayDesign arrayDesign)
Set the ArrayDesign used in this ArrayBatch. |
void |
setPrintRobot(Hardware printRobot)
Set the print robot used for this array batch. |
(package private) void |
setProjectDefaults(Project activeProject)
Set print robot and protocol from project default settings. |
void |
setProtocol(Protocol protocol)
Set the Protocol used for printing the arrays. |
Methods inherited from class net.sf.basedb.core.AnnotatedItem |
---|
getAnnotationSet, isAnnotated, removeAnnotations, toTransferable |
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, 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.ARRAYBATCH
,
getType()
private boolean protocolHasBeenSet
private boolean robotHasBeenSet
Constructor Detail |
---|
ArrayBatch(ArrayBatchData annotatedData)
Method Detail |
---|
public static ArrayBatch getNew(DbControl dc, ArrayDesign arrayDesign) throws BaseException
ArrayBatch
item.
dc
- The DbControl
which will be used for
permission checking and database accessarrayDesign
- The ArrayDesign
used for the batch
ArrayBatch
item
PermissionDeniedException
- If the logged in user doesn't
have create permission for this type
of item, or use permission for the design
BaseException
- If there is another errorpublic static ArrayBatch getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
ArrayBatch
object 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
ArrayBatch
item
ItemNotFoundException
- If an item with the specified ID is
not found
PermissionDeniedException
- If the logged in user doesn't
have read permission to the item
BaseException
- If there is another errorpublic static ItemQuery<ArrayBatch> getQuery()
ItemQuery
that returns array batches.
ItemQuery
objectpublic Item getType()
Identifiable
Item
enumeration.
getType
in interface Identifiable
public Set<Annotatable> getAnnotatableParents() throws BaseException
getAnnotatableParents
in interface Annotatable
BaseException
- If there is an errorpublic Date getEntryDate()
Registered
getEntryDate
in interface Registered
public boolean isUsed() throws BaseException
BasicItem
super.isUsed()
, unless it has decided
that the item is used by some other means.
isUsed
in class BasicItem<ArrayBatchData>
BaseException
- If not able to tell if item is used or not.BasicItem.getUsingItems()
public Set<ItemProxy> getUsingItems()
ArraySlide
:s in this batch
getUsingItems
in class BasicItem<ArrayBatchData>
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
void setProjectDefaults(Project activeProject) throws BaseException
setProjectDefaults
in class BasicItem<ArrayBatchData>
activeProject
- The currently active project
BaseException
public ArrayDesign getArrayDesign() throws PermissionDeniedException, BaseException
ArrayDesign
item that was used for this batch.
ArrayDesign
item
PermissionDeniedException
- If
the logged in user doesn't have read
permission to the item
BaseException
- If there is an errorprivate void setArrayDesign(ArrayDesign arrayDesign) throws InvalidDataException, PermissionDeniedException
ArrayDesign
used in this ArrayBatch.
arrayDesign
- the arrayDesign to be set. Cannot be null.
InvalidDataException
- if arrayDesign is null.
PermissionDeniedException
- If the
logged in user doesn't have use
permission for the array design.public Protocol getProtocol() throws PermissionDeniedException, BaseException
Protocol
used for printing the arrays.
getProtocol
in interface Annotatable
getProtocol
in class AnnotatedItem<ArrayBatchData>
Protocol
item
PermissionDeniedException
- If
the logged in user doesn't have read
permission to the item
BaseException
- If there is an errorpublic void setProtocol(Protocol protocol) throws PermissionDeniedException
Protocol
used for printing the arrays.
protocol
- A Protocol
item of the ProtocolType.PRINTING
protocol type
PermissionDeniedException
- If the
logged in user doesn't have write
permission on this array batch or use
permission for the protocolpublic Hardware getPrintRobot() throws PermissionDeniedException, BaseException
print robot
used for printing the arrays.
Hardware
item of type
HardwareType.PRINT_ROBOT
PermissionDeniedException
- If
the logged in user doesn't have read
permission to the item
BaseException
- If there is an errorpublic void setPrintRobot(Hardware printRobot) throws PermissionDeniedException
print robot
used for this array batch.
printRobot
- A Hardware
item of type
HardwareType.PRINT_ROBOT
PermissionDeniedException
- If the
logged in user doesn't have write
permission on this array batch or use
permission for the hardwarepublic ArraySlide newArraySlide() throws PermissionDeniedException, BaseException
ArraySlide
item for this batch.
ArraySlide
item
PermissionDeniedException
- If
the logged in user doesn't have use
permission for this batch
BaseException
- If there is another
errorpublic ItemQuery<ArraySlide> getArraySlides()
ItemQuery
object
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |