3.0.1: 2011-11-10

net.sf.basedb.core
Class Tag

java.lang.Object
  extended by net.sf.basedb.core.BasicItem<D>
      extended by net.sf.basedb.core.OwnedItem<D>
          extended by net.sf.basedb.core.SharedItem<D>
              extended by net.sf.basedb.core.CommonItem<TagData>
                  extended by net.sf.basedb.core.Tag
All Implemented Interfaces:
AccessControlled, Identifiable, Nameable, Ownable, Registered, Removable, Shareable, Subtypable

public class Tag
extends CommonItem<TagData>
implements Registered, Subtypable

This class represents a tag. Tags are used on extracts so that they can be tracked on physical bioassays.

Since:
3.0
Author:
Nicklas
Last modified
$Date: 2011-05-25 12:56:04 +0200 (Wed, 25 May 2011) $

Field Summary
static String BARCODE
          The ID for the BARCODE tag type.
static String LABEL
          The ID for the LABEL tag type.
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
Tag(TagData data)
           
 
Method Summary
static Tag getById(DbControl dc, int id)
          Get a Tag item when you know the id.
 Date getEntryDate()
          Get the date that the item was registered in the database.
 ItemSubtype getItemSubtype()
          Get the subtype of the item.
static Tag getNew(DbControl dc)
          Create a new Tag item.
static ItemQuery<Tag> getQuery()
          Get a query that returns tags.
 Item getType()
          Get the type of item represented by the object.
 Set<ItemProxy> getUsingItems()
          Get all: Extract:s marked with this tag
 boolean isUsed()
          Check if: Some Extract:s are marked with this tag
 void setItemSubtype(ItemSubtype subtype)
          Set the subtype on the item.
 
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.TAG, getType()

LABEL

public static final String LABEL
The ID for the LABEL tag type.

See Also:
Constant Field Values

BARCODE

public static final String BARCODE
The ID for the BARCODE tag type.

See Also:
Constant Field Values
Constructor Detail

Tag

Tag(TagData data)
Method Detail

getNew

public static Tag getNew(DbControl dc)
                  throws BaseException
Create a new Tag 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 Tag getById(DbControl dc,
                          int id)
                   throws ItemNotFoundException,
                          PermissionDeniedException,
                          BaseException
Get a Tag 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 Tag 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<Tag> getQuery()
Get a query that returns tags.

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

getItemSubtype

public ItemSubtype getItemSubtype()
Description copied from interface: Subtypable
Get the subtype of the item.

Specified by:
getItemSubtype in interface Subtypable
Returns:
A subtype of null if not set
See Also:
SubtypableRelatedItems

setItemSubtype

public void setItemSubtype(ItemSubtype subtype)
Description copied from interface: Subtypable
Set the subtype on the item.

Specified by:
setItemSubtype in interface Subtypable
Parameters:
subtype - A subtype or null
See Also:
ItemSubtype.setOnItem(Subtypable)

isUsed

public boolean isUsed()
               throws BaseException
Check if:

Overrides:
isUsed in class BasicItem<TagData>
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:

3.0.1: 2011-11-10