org.proteios.core
Class MeasuredArea

java.lang.Object
  org.proteios.core.BasicItem<D>
      org.proteios.core.OwnedItem<D>
          org.proteios.core.SharedItem<D>
              org.proteios.core.CommonItem<D>
                  org.proteios.core.AnnotatedItem<D>
                      org.proteios.core.BioMaterial<D>
                          org.proteios.core.MeasuredBioMaterial<MeasuredAreaData>
                              org.proteios.core.MeasuredArea

All Implemented Interfaces:

AccessControlled, Annotatable, Identifiable, Nameable, Ownable, Removable, Shareable

public class MeasuredArea
extends MeasuredBioMaterial<MeasuredAreaData>

This class represent measured areas. A measured area has information about the measured area in a gel analysis experiment.

Version:

2.0

Author:

Olle

Last modified

$Date: 2007-02-20 12:33:12Z $

Field Summary

static Item

TYPE The type of item represented by this class.

Fields inherited from class org.proteios.core.BioMaterial

MAX_EXTERNAL_ID_LENGTH, MAX_STORAGE_LOCATION_LENGTH

Fields inherited from interface org.proteios.core.Nameable

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

MeasuredArea(MeasuredAreaData measuredAreaData)

Method Summary

Float	getApparentMass() Get the Float apparent mass value.
Float	getApparentPI() Get the Float apparent pI value.
int	getIntensity() Get the intensity.
int	getLane() Get the int lane value.
int	getLaneIndex() Get the int laneIndex value.
Float	getLocal_background() Get the local_background.
Float	getNormalized_volume() Get the Float normalized_volume value.
int	getPixel_radius() Get the int pixel_radius value.
int	getPixel_x_coord() Get the int pixel_x_coord value.
int	getPixel_y_coord() Get the int pixel_y_coord value.
static ItemQuery<MeasuredArea>	getQuery() Get a query that returns measuredArea items.
Item	getType() Get the type of item represented by the object.
Float	getVolume() Get the Float volume value.
boolean	isNormalized() Get the normalized flag of this MeasuredArea.
boolean	isUsed() Check that: no item has been created from this measuredArea
void	setApparentMass(Float apparentMass) Set the Float apparent mass value.
void	setApparentPI(Float apparentPI) Set the Float apparent pI value.
void	setIntensity(int intensity) Set the intensity
void	setLane(int lane) Set the int lane value.
void	setLaneIndex(int laneIndex) Set the int laneIndex value.
void	setLocal_background(Float local_background) Set the local_background
void	setNormalized_volume(Float normalized_volume) Set the Float normalized_volume value.
void	setNormalized(boolean normalized) Set the normalized flag for this MeasuredArea item.
void	setPixel_radius(int pixel_radius) Set the int pixel_radius value.
void	setPixel_x_coord(int pixel_x_coord) Set the int pixel_x_coord value.
void	setPixel_y_coord(int pixel_y_coord) Set the int pixel_y_coord value.
void	setVolume(Float volume) Set the Float volume value.

Methods inherited from class org.proteios.core.MeasuredBioMaterial

getConcentrationInGramsPerLiter, getCreationEvent, getEventQuery, getEvents, getOriginalQuantityInMicroLiters, getRemainingQuantityInMicroLiters, isPooled, setConcentrationInGramsPerLiter, setCreationEvent, setOriginalQuantityInMicroLiters, setPooled, setRemainingQuantityInMicroLiters

Methods inherited from class org.proteios.core.BioMaterial

addFile, getExternalId, getFiles, getStorageLocation, setExternalId, setFiles, setStorageLocation

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

Constructor Detail

MeasuredArea

public MeasuredArea(MeasuredAreaData measuredAreaData)

Method Detail

getQuery

public static ItemQuery<MeasuredArea> getQuery()

Get a query that returns measuredArea 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 measuredArea

Overrides:

isUsed in class MeasuredBioMaterial<MeasuredAreaData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getIntensity

public int getIntensity()

Get the intensity.

Returns:

An int holding the intensity

setIntensity

public void setIntensity(int intensity)
                  throws InvalidDataException,
                         BaseException

Set the intensity

Parameters:

intensity - The int intensity value

Throws:

InvalidDataException - If intensity is below zero

BaseException

getLocal_background

public Float getLocal_background()

Get the local_background.

Returns:

A Float holding the local_background

setLocal_background

public void setLocal_background(Float local_background)
                         throws InvalidDataException,
                                BaseException

Set the local_background

Parameters:

local_background - The Float local_background value

Throws:

InvalidDataException - If local_background is below zero

BaseException

getNormalized_volume

public Float getNormalized_volume()

Get the Float normalized_volume value.

Returns:

the Float normalized_volume value

setNormalized_volume

public void setNormalized_volume(Float normalized_volume)
                          throws InvalidDataException

Set the Float normalized_volume value.

Parameters:

normalized_volume - The Float normalized_volume value to set.

Throws:

InvalidDataException - If the normalized_volume is lower than zero

isNormalized

public boolean isNormalized()

Get the normalized flag of this MeasuredArea.

Returns:

the boolean normalized flag of this measured area

setNormalized

public void setNormalized(boolean normalized)

Set the normalized flag for this MeasuredArea item.

Parameters:

normalized - The new boolean normalized flag for this item

getPixel_radius

public int getPixel_radius()

Get the int pixel_radius value.

Returns:

the int pixel_radius value

setPixel_radius

public void setPixel_radius(int pixel_radius)
                     throws InvalidDataException

Set the int pixel_radius value.

Parameters:

pixel_radius - The int pixel_radius value to set.

Throws:

InvalidDataException - If the pixel_radius is lower than zero

getPixel_x_coord

public int getPixel_x_coord()

Get the int pixel_x_coord value.

Returns:

the int pixel_x_coord value

setPixel_x_coord

public void setPixel_x_coord(int pixel_x_coord)
                      throws InvalidDataException

Set the int pixel_x_coord value.

Parameters:

pixel_x_coord - The int pixel_x_coord value to set.

Throws:

InvalidDataException - If the pixel_x_coord is lower than zero

getPixel_y_coord

public int getPixel_y_coord()

Get the int pixel_y_coord value.

Returns:

the int pixel_y_coord value

setPixel_y_coord

public void setPixel_y_coord(int pixel_y_coord)
                      throws InvalidDataException

Set the int pixel_y_coord value.

Parameters:

pixel_y_coord - The int pixel_y_coord value to set.

Throws:

InvalidDataException - If the pixel_y_coord is lower than zero

getVolume

public Float getVolume()

Get the Float volume value.

Returns:

the Float volume value

setVolume

public void setVolume(Float volume)
               throws InvalidDataException

Set the Float volume value.

Parameters:

volume - The Float volume value to set.

Throws:

InvalidDataException - If the volume is lower than zero

getApparentMass

public Float getApparentMass()

Get the Float apparent mass value.

Returns:

the Float apparent mass value

setApparentMass

public void setApparentMass(Float apparentMass)
                     throws InvalidDataException

Set the Float apparent mass value.

Parameters:

apparentMass - The Float apparent mass value to set.

Throws:

InvalidDataException - If the apparent mass is lower than zero

getLane

public int getLane()

Get the int lane value.

Returns:

the int lane value

setLane

public void setLane(int lane)
             throws InvalidDataException

Set the int lane value.

Parameters:

lane - int The lane value to set.

Throws:

InvalidDataException - If the lane is lower than zero

getApparentPI

public Float getApparentPI()

Get the Float apparent pI value.

Returns:

the Float apparent pI value

setApparentPI

public void setApparentPI(Float apparentPI)
                   throws InvalidDataException

Set the Float apparent pI value.

Parameters:

apparentPI - The Float apparent pI value to set.

Throws:

InvalidDataException - If the apparent pI is lower than zero

getLaneIndex

public int getLaneIndex()

Get the int laneIndex value.

Returns:

the int laneIndex value

setLaneIndex

public void setLaneIndex(int laneIndex)
                  throws InvalidDataException

Set the int laneIndex value.

Parameters:

laneIndex - int The laneIndex value to set.

Throws:

InvalidDataException - If the laneIndex is lower than zero