Package net.sf.basedb.core
Class PlateType
- java.lang.Object
-
- net.sf.basedb.core.BasicItem
-
- net.sf.basedb.core.OwnedItem
-
- net.sf.basedb.core.SharedItem
-
- net.sf.basedb.core.CommonItem
-
- net.sf.basedb.core.PlateType
-
- All Implemented Interfaces:
AccessControlled
,Identifiable
,Nameable
,Ownable
,Registered
,Removable
,Shareable
public class PlateType extends CommonItem implements Registered
This class represents plate types, which is a name, description, geometry and a list of event types.- Version:
- 2.0
- Author:
- Nicklas
- Last modified
- $Date: 2017-05-22 14:35:27 +0200 (må, 22 maj 2017) $
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description PlateType(PlateTypeData plateTypeData)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PlateType
getById(DbControl dc, int id)
Get aPlateType
item when you know the id.(package private) PlateTypeData
getData()
Get theBasicData
object that holds all data for this item.Date
getEntryDate()
Get the date that the item was registered in the database.ItemQuery<PlateEventType>
getEventTypes()
Get a query that returns all event types for this plate type.static PlateType
getNew(DbControl dc, PlateGeometry plateGeometry)
Create a newPlateType
item.PlateGeometry
getPlateGeometry()
Get thePlateGeometry
of this plate type.ItemQuery<Plate>
getPlates()
Get a query that returns all plates of this plate type.static ItemQuery<PlateType>
getQuery()
Get a query that returns plate types.Item
getType()
Get the type of item represented by the object.Set<ItemProxy>
getUsingItems()
Get all:Plate
:s created from this plate typeboolean
isUsed()
Check if: AnyPlate
:s of this type existsPlateEventType
newEventType()
Create a new event type for this plate type.Plate
newPlate()
Create a new plate of this plate type.void
setEntryDate(Date entryDate)
Set the date the entry was registered in the database.private void
setPlateGeometry(PlateGeometry plateGeometry)
Set the plate geometry of this plate type.-
Methods inherited from class net.sf.basedb.core.CommonItem
getDescription, getName, getRemovedBy, isRemoved, setDescription, setName, setRemoved
-
Methods inherited from class net.sf.basedb.core.SharedItem
getItemKey, getProjectKey, initPermissions, isShared, onBeforeCommit, setItemKey, setProjectKey
-
Methods inherited from class net.sf.basedb.core.OwnedItem
getOwner, isOwner, setOwner, takeOwnership
-
Methods inherited from class net.sf.basedb.core.BasicItem
addAnnotatableParents, addUsingItems, addUsingItems, breakCircularReferences, checkBatchAnnotatableUsage, checkPermission, equals, getBasicData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onRollback, setDbControl, setProjectDefaults, toString, validate
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.basedb.core.AccessControlled
checkPermission, getPermissions, hasPermission
-
Methods inherited from interface net.sf.basedb.core.Identifiable
getId, getVersion
-
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.PLATETYPE
,getType()
-
-
Constructor Detail
-
PlateType
PlateType(PlateTypeData plateTypeData)
-
-
Method Detail
-
getNew
public static PlateType getNew(DbControl dc, PlateGeometry plateGeometry) throws BaseException
Create a newPlateType
item.- Parameters:
dc
- TheDbControl
which will be used for permission checking and database accessplateGeometry
- The geometry of the new plate type- Returns:
- The new
PlateType
item - Throws:
PermissionDeniedException
- If the loggged in user doesn't have use permission for the geometryInvalidDataException
- If the geometry is nullBaseException
- If there is an error
-
getById
public static PlateType getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
Get aPlateType
item when you know the id.- Parameters:
dc
- TheDbControl
which will be used for permission checking and database access.id
- The id of the item to load- Returns:
- The
PlateType
item - Throws:
ItemNotFoundException
- If an item with the specified id is not foundPermissionDeniedException
- If the logged in user doesn't havePermission.READ
permission to the itemBaseException
- If there is another error
-
getQuery
public static ItemQuery<PlateType> getQuery()
Get a query that returns plate types.- Returns:
- An
ItemQuery
object
-
getData
PlateTypeData getData()
Description copied from class:BasicItem
Get theBasicData
object that holds all data for this item.- Overrides:
getData
in classCommonItem
-
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 theItem
enumeration.- Specified by:
getType
in interfaceIdentifiable
- 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 interfaceRegistered
- Returns:
- A date or null if this is not known
-
setEntryDate
public void setEntryDate(Date entryDate)
Description copied from interface:Registered
Set the date the entry was registered in the database. Implementations should only allow this property to be set before the item is first stored in the database. The intention of this method is to facilitate export/import of data between server.- Specified by:
setEntryDate
in interfaceRegistered
- Parameters:
entryDate
- A date or null to use today's date
-
isUsed
public boolean isUsed() throws BaseException
Check if:- Any
Plate
:s of this type exists
- Overrides:
isUsed
in classBasicItem
- 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()
- Any
-
getUsingItems
public Set<ItemProxy> getUsingItems()
Get all:Plate
:s created from this plate type
- Overrides:
getUsingItems
in classBasicItem
- 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.Query)
-
getPlateGeometry
public PlateGeometry getPlateGeometry() throws PermissionDeniedException, BaseException
Get thePlateGeometry
of this plate type.- Returns:
- The
PlateGeometry
item - Throws:
PermissionDeniedException
- If the logged in user doesn't havePermission.READ
permission for the plate geometryBaseException
- If there is another error
-
setPlateGeometry
private void setPlateGeometry(PlateGeometry plateGeometry) throws PermissionDeniedException, InvalidDataException
Set the plate geometry of this plate type.- Throws:
PermissionDeniedException
- If the logged in user doesn't have use permission for the geometryInvalidDataException
- If the geometry is null
-
newEventType
public PlateEventType newEventType() throws PermissionDeniedException, BaseException
Create a new event type for this plate type.- Returns:
- The new
PlateEventType
item - Throws:
PermissionDeniedException
- If the logged in user doesn't have write permission for this plate typeBaseException
- If there is another error
-
getEventTypes
public ItemQuery<PlateEventType> getEventTypes()
Get a query that returns all event types for this plate type.- Returns:
- An
ItemQuery
object
-
newPlate
public Plate newPlate() throws PermissionDeniedException, BaseException
Create a new plate of this plate type.- Returns:
- The new
Plate
item - Throws:
PermissionDeniedException
- If the logged in user doesn't have use permission for this plate typeBaseException
- If there is another error
-
-