|
3.0.1: 2011-11-10 | ||||||||
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<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 String |
ALIGNMENT
The id for the SoftwareType item representing software
used for aligning sequenced data against a known reference database. |
static String |
FEATURE_EXTRACTION
The id for the SoftwareType item representing the
softwaretype "feature extraction software". |
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. |
static String |
getDefaultSystemId(Item itemType)
Get the system id for the software 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 Software |
getNew(DbControl dc)
Create a new Software item. |
static ItemQuery<Software> |
getQuery()
Get a query configured to retrieve software. |
Item |
getType()
Get the type of item represented by the object. |
Set<ItemProxy> |
getUsingItems()
Get all: RawBioAssay :s created with this software
DerivedBioAssay : created with this software
|
String |
getVersionString()
Get the versionstring of this Software item. |
boolean |
isUsed()
Check if: a RawBioAssay was created with this software a DerivedBioassay was created with this software |
void |
setItemSubtype(ItemSubtype subtype)
Set the subtype on the 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 String FEATURE_EXTRACTION
SoftwareType
item representing the
softwaretype "feature extraction software".
public static final String ALIGNMENT
SoftwareType
item representing software
used for aligning sequenced data against a known reference database.
public static final int MAX_VERSIONSTRING_LENGTH
setVersionString(String)
method to avoid
exceptions.
Constructor Detail |
---|
Software(SoftwareData 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 software.
itemType
- The item type
public static Software getNew(DbControl dc) throws BaseException
Software
item.
dc
- The DbControl
which will be used for
permission checking and database access.
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 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
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
DerivedBioAssay
: created with this software
getUsingItems
in class BasicItem<SoftwareData>
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
public 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
|
3.0.1: 2011-11-10 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |