org.proteios.core

Class BioSource

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<BioSourceData>

org.proteios.core.BioSource

All Implemented Interfaces:

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

public class BioSource
extends BioMaterial<BioSourceData>

This class represent biosource items. A biosource has information about the source of material used in an experiment, such as a cell line or patient. A biosource can be used to create Sample:s.

Version:

2.0

Author:

Nicklas

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Field Summary

Fields

Modifier and Type	Field and Description
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

Method Summary

Methods

Modifier and Type	Method and Description
Set<Annotatable>	getAnnotatableParents() Always null.
static ItemQuery<BioSource>	getQuery() Get a query that returns biosource items.
ItemQuery<Sample>	getSamples() Get a query that returns all samples created from this biosource.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check that: no Sample has been created from this biosource

Methods inherited from class org.proteios.core.BioMaterial

addFile, getExternalId, getFiles, getStorageLocation, removeFile, 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.BIOSOURCE, getType()

Method Detail

getQuery

public static ItemQuery<BioSource> getQuery()

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

getAnnotatableParents

public Set<Annotatable> getAnnotatableParents()
                                       throws BaseException

Always null.

Throws:

BaseException

isUsed

public boolean isUsed()
               throws BaseException

Check that:

• no Sample has been created from this biosource

Specified by:

isUsed in class BasicItem<BioSourceData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getSamples

public ItemQuery<Sample> getSamples()

Get a query that returns all samples created from this biosource.

Returns:

An ItemQuery object