org.proteios.core
Class IPG

java.lang.Object
  org.proteios.core.BasicItem<D>
      org.proteios.core.OwnedItem<D>
          org.proteios.core.SharedItem<D>
              org.proteios.core.SeparationMethod<IPGData>
                  org.proteios.core.IPG

All Implemented Interfaces:

AccessControlled, Identifiable, Ownable, Shareable

public class IPG
extends SeparationMethod<IPGData>

This class represent IPG (Immobilized pH Gradient) items. An IPG has information about the separation method used in an experiment.

Version:

2.0

Author:

Olle

Last modified

$Date: 2006-09-19 12:33:12Z $

Field Summary

static Item

TYPE The type of item represented by this class.

Fields inherited from class org.proteios.core.SeparationMethod

MAX_EXTERNAL_ID_LENGTH

Method Summary

Set<Annotatable>	getAnnotatableParents() Always null.
static IPG	getByExternalId(DbControl dc, String externalId) Get an IPG item when you know the external ID.
int	getLengthInCentiMeters() Get the int length value.
int	getPiEnd() Get the int piEnd value.
int	getPiStart() Get the int piStart value.
static ItemQuery<IPG>	getQuery() Get a query that returns IPG items.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check that: no item has been created from this IPG
void	setLengthInCentiMeters(int length) Set the int length value.
void	setPiEnd(int piEnd) Set the int piEnd value.
void	setPiStart(int piStart) Set the int piStart value.

Methods inherited from class org.proteios.core.SeparationMethod

getExternalId, getIdsForSeparationMethodsWithSeaprationEvent, getSeparationEvents, setExternalId

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.Ownable

getOwner, setOwner

Methods inherited from interface org.proteios.core.Identifiable

getId, getVersion

Methods inherited from interface org.proteios.core.AccessControlled

checkPermission, hasPermission

Field Detail

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

Item.PROTEIOS_IPG, getType()

Method Detail

getQuery

public static ItemQuery<IPG> getQuery()

Get a query that returns IPG items.

Returns:

An ItemQuery object.

getByExternalId

public static IPG getByExternalId(DbControl dc,
                                  String externalId)
                           throws ItemNotFoundException,
                                  PermissionDeniedException,
                                  BaseException

Get an IPG item when you know the external ID. The method with the same name inherited from the super class is used to retrieve the item, which is then casted to the right type.

Parameters:

dc - The DbControl which will be used for permission checking and database access.

externalId - The external id of the item to load

Returns:

The IPG item

Throws:

ItemNotFoundException - If an item with the specified ID is not found

PermissionDeniedException - If the logged in user doesn't have READ permission for the item

BaseException - If there is another error

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.

Specified by:

getType in interface Identifiable

Overrides:

getType in class SeparationMethod<IPGData>

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:

• no item has been created from this IPG

Overrides:

isUsed in class SeparationMethod<IPGData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getLengthInCentiMeters

public int getLengthInCentiMeters()

Get the int length value.

Returns:

the int length value

setLengthInCentiMeters

public void setLengthInCentiMeters(int length)

Set the int length value.

Parameters:

length - The int length value to set.

getPiEnd

public int getPiEnd()

Get the int piEnd value.

Returns:

the int piEnd value

setPiEnd

public void setPiEnd(int piEnd)

Set the int piEnd value.

Parameters:

piEnd - The int piEnd value to set.

getPiStart

public int getPiStart()

Get the int piStart value.

Returns:

the int piStart value

setPiStart

public void setPiStart(int piStart)

Set the int piStart value.

Parameters:

piStart - The int piStart value to set.