|
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<SoftwareData> net.sf.basedb.core.Software
public class Software
This class is used to represent individual software items and information about them. In the current version of BASE the only type of software we keep information about is feature extraction software.
Field Summary | |
---|---|
static int |
MAX_VERSIONSTRING_LENGTH
The maximum length of the version variable that can be stored in the database. |
private 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 | |
---|---|
Software(SoftwareData data)
Creates a new software item. |
Method Summary | |
---|---|
static Software |
getById(DbControl dc,
int id)
Get a Software item when you know the ID. |
Date |
getEntryDate()
Get the date that the item was registered in the database. |
static Software |
getNew(DbControl dc,
SoftwareType softwareType)
Create a new Software item. |
static ItemQuery<Software> |
getQuery()
Get a query configured to retrieve software. |
SoftwareType |
getSoftwareType()
Get the associated SoftwareType item. |
Item |
getType()
Get the type of item represented by the object. |
Set<ItemProxy> |
getUsingItems()
Get all: RawBioAssay :s created with this software
|
String |
getVersionString()
Get the versionstring of this Software item. |
boolean |
isUsed()
Check if: a RawBioAssay was created with this software |
void |
setSoftwareType(SoftwareType softwareType)
Set the SoftwareType of this Software item. |
void |
setVersionString(String versionString)
Set the versionstring for this Software 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 |
---|
private static final Item TYPE
Item.SOFTWARE
,
getType()
public static final int MAX_VERSIONSTRING_LENGTH
setVersionString(String)
method to avoid
exceptions.
Constructor Detail |
---|
Software(SoftwareData data)
data
- the dataMethod Detail |
---|
public static Software getNew(DbControl dc, SoftwareType softwareType) throws BaseException
Software
item.
dc
- The DbControl
which will be used for
permission checking and database access.softwareType
- The type of this software
Software
item
BaseException
- This exception is thrown if there is another
errorpublic static Software getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
Software
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
Software
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<Software> getQuery() throws BaseException
ItemQuery
object
BaseException
- If getting the query fails.public Item getType()
Identifiable
Item
enumeration.
getType
in interface Identifiable
public Date getEntryDate()
Registered
getEntryDate
in interface Registered
public boolean isUsed() throws BaseException
isUsed
in class BasicItem<SoftwareData>
BaseException
- If not able to tell if item is used or not.BasicItem.getUsingItems()
public Set<ItemProxy> getUsingItems()
RawBioAssay
:s created with this software
getUsingItems
in class BasicItem<SoftwareData>
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
public SoftwareType getSoftwareType() throws PermissionDeniedException, BaseException
SoftwareType
item.
All Software
items must have a type.
SoftwareType
item
PermissionDeniedException
- If the logged in user doesn't have
Permission.READ
permission for the software type
BaseException
- If there is another errorpublic void setSoftwareType(SoftwareType softwareType) throws PermissionDeniedException, InvalidUseOfNullException
SoftwareType
of this Software
item.
This parameter mustn't be null
.
softwareType
- The new SoftwareType
PermissionDeniedException
- If the logged in user doesn't have
Permission.WRITE
permission for the software or
Permission.USE
permission for the software type
InvalidUseOfNullException
- If software type is nullpublic String getVersionString()
Software
item.
public void setVersionString(String versionString) throws StringTooLongException, PermissionDeniedException
Software
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 the version is longer then MAX_VERSIONSTRING_LENGTH
PermissionDeniedException
- If the logged in user don't have write permission on this item
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |