net.sf.basedb.core
Class Label

java.lang.Object
  net.sf.basedb.core.BasicItem<D>
      net.sf.basedb.core.OwnedItem<D>
          net.sf.basedb.core.SharedItem<D>
              net.sf.basedb.core.CommonItem<LabelData>
                  net.sf.basedb.core.Label

All Implemented Interfaces:

AccessControlled, Identifiable, Nameable, Ownable, Registered, Removable, Shareable

public class Label
extends CommonItem<LabelData>
implements Registered

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: 2010-10-27 14:32:44 +0200 (Wed, 27 Oct 2010) $

Field Summary

static Item

TYPE The type of item represented by this class.

Fields inherited from interface net.sf.basedb.core.Nameable

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

Label(LabelData labelData)

Method Summary

static Label	getById(DbControl dc, int id) Get a Label item when you know the id.
Date	getEntryDate() Get the date that the item was registered in the database.
ItemQuery<LabeledExtract>	getLabeledExtracts() Get a query that returns all labeled extracts labeled with this label.
static Label	getNew(DbControl dc) Create a new Label item.
static ItemQuery<Label>	getQuery() Get a query that returns labels.
Item	getType() Get the type of item represented by the object.
Set<ItemProxy>	getUsingItems() Get all: LabeledExtract:s labeled with this label
boolean	isUsed() Check if: Some LabeledExtract:s are labeled with this label

Methods inherited from class net.sf.basedb.core.CommonItem

getDescription, getName, isRemoved, setDescription, setName, setRemoved, toTransferable

Methods inherited from class net.sf.basedb.core.SharedItem

getItemKey, getProjectKey, initPermissions, isShared, onBeforeCommit, setItemKey, setProjectKey, toTransferable

Methods inherited from class net.sf.basedb.core.OwnedItem

getOwner, isOwner, setOwner, takeOwnership, toTransferable

Methods inherited from class net.sf.basedb.core.BasicItem

addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onRollback, setDbControl, setProjectDefaults, toString, toTransferable, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.basedb.core.Identifiable

getId, getVersion

Methods inherited from interface net.sf.basedb.core.AccessControlled

checkPermission, getPermissions, hasPermission

Methods inherited from interface net.sf.basedb.core.Ownable

getOwner, isOwner, setOwner, takeOwnership

Field Detail

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

Item.LABEL, getType()

Constructor Detail

Label

Label(LabelData labelData)

Method Detail

getNew

public static Label getNew(DbControl dc)
                    throws BaseException

Create a new Label item.

Parameters:

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

Returns:

The new Label item

Throws:

BaseException - If there is an error

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.

Specified by:

getType in interface Identifiable

Returns:

A value indicating the type of item

getEntryDate

public Date getEntryDate()

Description copied from interface: Registered

Get the date that the item was registered in the database.

Specified by:

getEntryDate in interface Registered

Returns:

A date or null if this is not known

isUsed

public boolean isUsed()
               throws BaseException

Check if:

• Some LabeledExtract:s are labeled with this label

Overrides:

isUsed in class BasicItem<LabelData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException - If not able to tell if item is used or not.

See Also:

BasicItem.getUsingItems()

getUsingItems

public Set<ItemProxy> getUsingItems()

Get all:

• LabeledExtract:s labeled with this label

  Overrides:

  getUsingItems in class BasicItem<LabelData>

  Returns:

  A set containing proxies for the items, or an empty set if no items are using this item

  Since:

  2.2

  See Also:

  BasicItem.addUsingItems(Set, Item, org.hibernate.Query)

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 - If the query could not be created and configured.