org.proteios.core
Class Acquisition

java.lang.Object
  org.proteios.core.BasicItem<D>
      org.proteios.core.OwnedItem<D>
          org.proteios.core.SharedItem<D>
              org.proteios.core.CommonItem<AcquisitionData>
                  org.proteios.core.Acquisition

All Implemented Interfaces:

AccessControlled, Identifiable, Nameable, Ownable, Removable, Shareable

public class Acquisition
extends CommonItem<AcquisitionData>

This class represent acquisition items. An acquisition item has information about a scan in a mass spectrometry experiment.

Version:

2.0

Author:

Olle

Last modified

$Date: 2006-06-02 12:33:12Z $

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

int	getAcqNumber() Get the acquisition number.
InstrumentConfiguration	getAcquisitionInstrumentInfo() Get the InstrumentConfiguration acquisitionInstrumentInfo.
PeakList	getPeakList() Get the PeakList this acquisition is created from.
static ItemQuery<Acquisition>	getQuery() Get a query that returns acquisition items.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check that: no item has been created from this acquisition
void	setAcqNumber(int acqNumber) Set the acquisition number
void	setAcquisitionInstrumentInfo(InstrumentConfiguration acquisitionInstrumentInfo) Set the InstrumentConfiguration acquisitionInstrumentInfo.
void	setPeakList(PeakList peakList) Set the PeakList this acquisition is created from.

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_ACQUISITION, getType()

Method Detail

getQuery

public static ItemQuery<Acquisition> getQuery()

Get a query that returns acquisition items.

Returns:

An ItemQuery object.

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

isUsed

public boolean isUsed()
               throws BaseException

Check that:

• no item has been created from this acquisition

Specified by:

isUsed in class BasicItem<AcquisitionData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getAcquisitionInstrumentInfo

public InstrumentConfiguration getAcquisitionInstrumentInfo()
                                                     throws BaseException

Get the InstrumentConfiguration acquisitionInstrumentInfo.

Returns:

An InstrumentConfiguration object

Throws:

BaseException - If there is another error

setAcquisitionInstrumentInfo

public void setAcquisitionInstrumentInfo(InstrumentConfiguration acquisitionInstrumentInfo)
                                  throws InvalidDataException

Set the InstrumentConfiguration acquisitionInstrumentInfo.

Parameters:

acquisitionInstrumentInfo - The new InstrumentConfiguration item

Throws:

InvalidDataException - If the acquisitionInstrumentInfo is null

BaseException - If there is another error

getAcqNumber

public int getAcqNumber()

Get the acquisition number.

Returns:

An int holding the acquisition number

setAcqNumber

public void setAcqNumber(int acqNumber)

Set the acquisition number

Parameters:

acqNumber - The int acquisition number value

getPeakList

public PeakList getPeakList()
                     throws BaseException

Get the PeakList this acquisition is created from.

Returns:

The PeakList item or null if not known

Throws:

BaseException - If there is another error

setPeakList

public void setPeakList(PeakList peakList)

Set the PeakList this acquisition is created from.

Parameters:

peakList - The new PeakList item

Throws:

BaseException - If there is another error