Package net.sf.basedb.core.data
Class PlatformData
- java.lang.Object
-
- net.sf.basedb.core.data.BasicData
-
- net.sf.basedb.core.data.PlatformData
-
- All Implemented Interfaces:
IdentifiableData
,NameableData
,RemovableData
public class PlatformData extends BasicData implements NameableData, RemovableData
This class hols information about experimental platforms.- Version:
- 2.5
- Author:
- Nicklas
- See Also:
Platform
, Developer documentation: Experimental platforms and item subtypes- Last modified
- $Date: 2015-11-17 13:57:57 +0100 (ti, 17 nov 2015) $
- Hibernate: class
- table="`Platforms`" lazy="false"
-
-
Field Summary
Fields Modifier and Type Field Description private int
channels
private String
description
private String
externalId
private boolean
fileOnly
private Map<FileTypeIndex,PlatformFileTypeData>
fileTypes
static int
MAX_EXTERNAL_ID_LENGTH
The maximum length of the external ID that can be stored in the database.private String
name
private String
rawDataType
private Integer
removedBy
private Set<PlatformVariantData>
variants
-
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
-
-
Constructor Summary
Constructors Constructor Description PlatformData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getChannels()
The number of channels this platform uses.String
getDescription()
Get the description for the item.String
getExternalId()
Get the external id for the item.Map<FileTypeIndex,PlatformFileTypeData>
getFileTypes()
The file types that can be used on this platform.String
getName()
Get the name of the item.String
getRawDataType()
The raw data type this platform is locked to, or null.Integer
getRemovedBy()
Get the ID of the user that removed this item.(package private) Set<PlatformVariantData>
getVariants()
The variants of this platform.boolean
isFileOnly()
If this platform can only be used with files.void
setChannels(int channels)
void
setDescription(String description)
Set the description for the item.void
setExternalId(String externalId)
void
setFileOnly(boolean fileOnly)
(package private) void
setFileTypes(Map<FileTypeIndex,PlatformFileTypeData> fileTypes)
void
setName(String name)
Set the name of the item.void
setRawDataType(String rawDataType)
void
setRemovedBy(Integer removedBy)
Set the ID of the user that removed this item or null to restore the item.(package private) void
setVariants(Set<PlatformVariantData> variants)
-
Methods inherited from class net.sf.basedb.core.data.BasicData
equals, getId, getVersion, hashCode, setId, setVersion, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData
getId, getVersion
-
-
-
-
Field Detail
-
name
private String name
-
description
private String description
-
removedBy
private Integer removedBy
-
MAX_EXTERNAL_ID_LENGTH
public static final int MAX_EXTERNAL_ID_LENGTH
The maximum length of the external ID that can be stored in the database.- See Also:
setExternalId(String)
, Constant Field Values
-
externalId
private String externalId
-
fileOnly
private boolean fileOnly
-
rawDataType
private String rawDataType
-
channels
private int channels
-
fileTypes
private Map<FileTypeIndex,PlatformFileTypeData> fileTypes
-
variants
private Set<PlatformVariantData> variants
-
-
Method Detail
-
getName
public String getName()
Description copied from interface:NameableData
Get the name of the item.- Specified by:
getName
in interfaceNameableData
- Returns:
- A
String
with the name of the item
-
setName
public void setName(String name)
Description copied from interface:NameableData
Set the name of the item. The name cannot be null and mustn't be longer than the value specified by theMAX_NAME_LENGTH
constant.- Specified by:
setName
in interfaceNameableData
- Parameters:
name
- The new name for the item
-
getDescription
public String getDescription()
Description copied from interface:NameableData
Get the description for the item.- Specified by:
getDescription
in interfaceNameableData
- Returns:
- A
String
with a description of the item
-
setDescription
public void setDescription(String description)
Description copied from interface:NameableData
Set the description for the item. The description can be null but mustn't be longer than the value specified by theMAX_DESCRIPTION_LENGTH
constant.- Specified by:
setDescription
in interfaceNameableData
- Parameters:
description
- The new description for the item
-
getRemovedBy
public Integer getRemovedBy()
Description copied from interface:RemovableData
Get the ID of the user that removed this item.- Specified by:
getRemovedBy
in interfaceRemovableData
- Returns:
- The ID of a user or null if the item is not removed
-
setRemovedBy
public void setRemovedBy(Integer removedBy)
Description copied from interface:RemovableData
Set the ID of the user that removed this item or null to restore the item.- Specified by:
setRemovedBy
in interfaceRemovableData
-
getExternalId
public String getExternalId()
Get the external id for the item.- Returns:
- The external id of the item
- Hibernate: property
- column="`external_id`" type="string" length="255" not-null="true" update="false" unique="true"
-
setExternalId
public void setExternalId(String externalId)
-
isFileOnly
public boolean isFileOnly()
If this platform can only be used with files.- Hibernate: property
- column="`file_only`" type="boolean" not-null="true" update="false"
-
setFileOnly
public void setFileOnly(boolean fileOnly)
-
getRawDataType
public String getRawDataType()
The raw data type this platform is locked to, or null. Only used if fileOnly=false- Hibernate: property
- column="`rawdatatype`" type="string" length="255" not-null="false" update="false"
-
setRawDataType
public void setRawDataType(String rawDataType)
-
getChannels
public int getChannels()
The number of channels this platform uses. Only used if fileOnly=true- Hibernate: property
- column="`channels`" type="int" not-null="true" update="false"
-
setChannels
public void setChannels(int channels)
-
getFileTypes
public Map<FileTypeIndex,PlatformFileTypeData> getFileTypes()
The file types that can be used on this platform. This is the inverse end.- See Also:
PlatformFileTypeData.getPlatform()
- Hibernate: map
- lazy="true" cascade="delete" inverse="true"
- Hibernate: collection-key
- column="`platform_id`"
- Hibernate: collection-composite-index
- class="net.sf.basedb.core.data.FileTypeIndex"
- Hibernate: collection-one-to-many
- class="net.sf.basedb.core.data.PlatformFileTypeData"
-
setFileTypes
void setFileTypes(Map<FileTypeIndex,PlatformFileTypeData> fileTypes)
-
getVariants
Set<PlatformVariantData> getVariants()
The variants of this platform. This is the inverse end.- See Also:
PlatformVariantData.getPlatform()
- Hibernate: set
- lazy="true" cascade="delete" inverse="true"
- Hibernate: collection-key
- column="`platform_id`"
- Hibernate: collection-one-to-many
- class="net.sf.basedb.core.data.PlatformVariantData"
-
setVariants
void setVariants(Set<PlatformVariantData> variants)
-
-