org.proteios.core
Class Label

java.lang.Object
  org.proteios.core.BasicItem<D>
      org.proteios.core.OwnedItem<D>
          org.proteios.core.SharedItem<D>
              org.proteios.core.CommonItem<LabelData>
                  org.proteios.core.Label

All Implemented Interfaces:

AccessControlled, Identifiable, Nameable, Ownable, Removable, Shareable

public class Label
extends CommonItem<LabelData>

This class represents a labelling compund. Labels are used together with Extract:s to create LabeledExtract:s.

Version:

2.0

Author:

Nicklas

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

static Label	getById(DbControl dc, int id) Get a Label item when you know the id.
ItemQuery<LabeledExtract>	getLabeledExtracts() Get a query that returns all labeled extracts labeled with this label.
static ItemQuery<Label>	getQuery() Get a query that returns labels.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check if: Some LabeledExtract:s are labeled with this label

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

Method Detail

getById

public static Label getById(DbControl dc,
                            int id)
                     throws ItemNotFoundException,
                            PermissionDeniedException,
                            BaseException

Get a Label item when you know the id.

Parameters:

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

id - The id of the item to load

Returns:

The Label item

Throws:

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 error

getQuery

public static ItemQuery<Label> getQuery()

Get a query that returns labels.

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 if:

• Some LabeledExtract:s are labeled with this label

Specified by:

isUsed in class BasicItem<LabelData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getLabeledExtracts

public ItemQuery<LabeledExtract> getLabeledExtracts()
                                             throws BaseException

Get a query that returns all labeled extracts labeled with this label.

Returns:

An ItemQuery object

Throws:

BaseException