2.17.2: 2011-06-17

net.sf.basedb.core.data
Class PlatformData

java.lang.Object
  extended by net.sf.basedb.core.data.BasicData
      extended by 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, Data API - Experimental platforms
Last modified
$Date: 2008-09-11 22:11:02 +0200 (Thu, 11 Sep 2008) $
Hibernate: class
table="`Platforms`" lazy="false"

Field Summary
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  boolean removed
           
private  Set<PlatformVariantData> variants
           
 
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
 
Constructor Summary
PlatformData()
           
 
Method Summary
 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.
(package private)  Set<PlatformVariantData> getVariants()
          The variants of this platform.
 boolean isFileOnly()
          If this platform can only be used with files.
 boolean isRemoved()
          Check if the removed flag is set for this item.
 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 setRemoved(boolean removed)
          Set the removed flag for this 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

removed

private boolean removed

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
Constructor Detail

PlatformData

public PlatformData()
Method Detail

getName

public String getName()
Description copied from interface: NameableData
Get the name of the item.

Specified by:
getName in interface NameableData
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 the MAX_NAME_LENGTH constant.

Specified by:
setName in interface NameableData
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 interface NameableData
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 the MAX_DESCRIPTION_LENGTH constant.

Specified by:
setDescription in interface NameableData
Parameters:
description - The new description for the item

isRemoved

public boolean isRemoved()
Description copied from interface: RemovableData
Check if the removed flag is set for this item.

Specified by:
isRemoved in interface RemovableData
Returns:
TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)
Description copied from interface: RemovableData
Set the removed flag for this item.

Specified by:
setRemoved in interface RemovableData
Parameters:
removed - TRUE if the item should be flagged as removed, FALSE otherwise

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)

2.17.2: 2011-06-17