|
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.ChildItem<DataCubeFilterData> net.sf.basedb.core.DataCubeFilter
public class DataCubeFilter
This represents a filter in a datacube. A filter simply contains a
set of column/position coordinates of spots that has passed som filtering
criteria. In theory a filter can be used on any layer in the data cube, but
in practice filters are not reused among bioassaysets with different layers.
This item keeps track of two important things. The filter number
and the number of bytes the data in this layer occupies on disk.
The number of bytes is reported up to the Experiment
which is the
item that handles user quota.
DataCube
,
FilterBatcher
Field Summary | |
---|---|
static Item |
TYPE
The type of item represented by this class. |
Constructor Summary | |
---|---|
DataCubeFilter(DataCubeFilterData data)
Creates a new data cube item from the given data. |
Method Summary | |
---|---|
(package private) void |
addBytes(long bytes)
|
static DataCubeFilter |
getById(DbControl dc,
int id)
Get a DataCubeFilter item when you know the id. |
long |
getBytes()
Get the number of bytes the data stored in this filter occupies on disk. |
DataCube |
getDataCube()
Get the data cube this filter belongs to. |
short |
getDataCubeNo()
Get the number of the data cube this filter belongs to. |
short |
getFilterNo()
Get the number of this filter. |
(package private) static DataCubeFilter |
getNew(DbControl dc,
DataCube cube)
Create a new DataCubeFilter item. |
(package private) Permission |
getPermissionForWriteDeleteAndCreate()
USE permission is enough to be able to manage data cubes. |
(package private) SharedData |
getSharedParent()
Get the experiment. |
Item |
getType()
Get the type of item represented by the object. |
(package private) VirtualDb |
getVirtualDb()
Get the virtual database this filter belongs to. |
(package private) void |
onBeforeCommit(Transactional.Action action)
Delete data and update disk usage information on the experiment if action == Action.DELETE |
private void |
setDataCube(DataCube cube)
Set the data cube. |
private void |
setFilterNo(short filterNo)
|
Methods inherited from class net.sf.basedb.core.ChildItem |
---|
getPluginPermissions, initPermissions |
Methods inherited from class net.sf.basedb.core.BasicItem |
---|
addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getSessionControl, getUsingItems, getVersion, hashCode, hasPermission, isDetached, isInDatabase, isUsed, onAfterCommit, onAfterInsert, onRollback, setDbControl, setProjectDefaults, toString, toTransferable, validate |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Item TYPE
Item.DATACUBEFILTER
,
getType()
Constructor Detail |
---|
DataCubeFilter(DataCubeFilterData data)
data
- the dataMethod Detail |
---|
static DataCubeFilter getNew(DbControl dc, DataCube cube) throws BaseException
DataCubeFilter
item.
dc
- The DbControl
which will be used for
permission checking and database access.cube
- The cube the new filter is located in
DataCubeFilter
item
BaseException
- If there is an errorpublic static DataCubeFilter getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
DataCubeFilter
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
DataCubeFilter
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 Item getType()
Identifiable
Item
enumeration.
void onBeforeCommit(Transactional.Action action) throws BaseException
onBeforeCommit
in class BasicItem<DataCubeFilterData>
BaseException
- If there is an errorTransactional
,
Core API overview - Transaction handling,
Coding rules and guidelines for item classesSharedData getSharedParent()
getSharedParent
in class ChildItem<DataCubeFilterData>
Permission getPermissionForWriteDeleteAndCreate()
getPermissionForWriteDeleteAndCreate
in class ChildItem<DataCubeFilterData>
public DataCube getDataCube() throws PermissionDeniedException, BaseException
DataCube
object
PermissionDeniedException
- If the logged in user doesn't have
read permission to the item
BaseException
- If there is another errorprivate void setDataCube(DataCube cube)
public short getDataCubeNo()
public short getFilterNo()
private void setFilterNo(short filterNo)
public long getBytes()
void addBytes(long bytes)
VirtualDb getVirtualDb()
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |