Last update: 2011-06-23

org.proteios.core
Class XTandemParameterSetStorage

java.lang.Object
  extended by org.proteios.core.BasicItem<D>
      extended by org.proteios.core.OwnedItem<D>
          extended by org.proteios.core.SharedItem<D>
              extended by org.proteios.core.CommonItem<D>
                  extended by org.proteios.core.AnnotatedItem<XTandemParameterSetStorageData>
                      extended by org.proteios.core.XTandemParameterSetStorage
All Implemented Interfaces:
AccessControlled, Annotatable, Identifiable, Nameable, Ownable, Removable, Shareable

public class XTandemParameterSetStorage
extends AnnotatedItem<XTandemParameterSetStorageData>

This class represents XTandemParameterSetStorage.

Version:
2.0
Author:
olle
Last modified
$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Field Summary
static Item TYPE
          The type of item represented by this class.
 
Fields inherited from interface org.proteios.core.Nameable
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
 
Method Summary
 XTandemParameterSet fetchXTandemParameterSet()
          Fetch XTandemParameterSet from existing parameter file item.
 Set<Annotatable> getAnnotatableParents()
          Always null.
 File getParameterFile()
          Get the XTandem parameter file item coupled to this XTandem parameter set
static ItemQuery<XTandemParameterSetStorage> getQuery()
          Get a query that returns XTandemParameterSetStorage set items.
 Item getType()
          Get the type of item represented by the object.
 boolean isUsed()
          Check that: no item has been created from this peaklistset
 void save(XTandemParameterSet xTandemParameterSet)
          Save XTandemParameterSet in existing parameter file item.
 void setParameterFile(File parameterFile)
          Set the XTandem parameter file item
 
Methods inherited from class org.proteios.core.CommonItem
getDescription, getName, isRemoved, setDescription, setName, setRemoved
 
Methods inherited from class org.proteios.core.SharedItem
getItemKey, getProjectKey, isShared, setItemKey, setProjectKey
 
Methods inherited from class org.proteios.core.OwnedItem
getOwner, setOwner
 
Methods inherited from class org.proteios.core.BasicItem
checkPermission, equals, getDbControl, getId, getPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.proteios.core.Identifiable
getId, getVersion
 
Methods inherited from interface org.proteios.core.AccessControlled
checkPermission, hasPermission
 
Methods inherited from interface org.proteios.core.Ownable
getOwner, setOwner
 

Field Detail

TYPE

public static final Item TYPE
The type of item represented by this class.

See Also:
Item.PROTEIOS_XTANDEMPARAMETERSETSTORAGE, getType()
Method Detail

getQuery

public static ItemQuery<XTandemParameterSetStorage> getQuery()
Get a query that returns XTandemParameterSetStorage set items.

Returns:
An ItemQuery object.

getParameterFile

public File getParameterFile()
Get the XTandem parameter file item coupled to this XTandem parameter set

Returns:
File The XTandem parameter file item coupled to this XTandem parameter set

setParameterFile

public void setParameterFile(File parameterFile)
Set the XTandem parameter file item

Parameters:
parameterFile - File The XTandem parameter file item coupled to this XTandem parameter set

fetchXTandemParameterSet

public XTandemParameterSet fetchXTandemParameterSet()
Fetch XTandemParameterSet from existing parameter file item.

Returns:
XTandemParameterSet The X!Tandem parameter set stored in the parameter file item.
Throws:
BaseException - If no parameter file item exists.

save

public void save(XTandemParameterSet xTandemParameterSet)
Save XTandemParameterSet in existing parameter file item.

Parameters:
xTandemParameterSet - XTandemParameterSet The X!Tandem parameter set to store.
Throws:
BaseException - If no parameter file item exists, or data cannot be saved in it.

getType

public Item getType()
Description copied from interface: Identifiable
Get the type of item represented by the object. The returned value is one of the values defined in the Item enumeration.

Returns:
A value indicating the type of item

getAnnotatableParents

public Set<Annotatable> getAnnotatableParents()
                                       throws BaseException
Always null.

Throws:
BaseException

isUsed

public boolean isUsed()
               throws BaseException
Check that:

Specified by:
isUsed in class BasicItem<XTandemParameterSetStorageData>
Returns:
TRUE if this item is used, FALSE otherwise
Throws:
BaseException

Last update: 2011-06-23