net.sf.basedb.core.data
Class ProtocolData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.OwnedData
          net.sf.basedb.core.data.SharedData
              net.sf.basedb.core.data.CommonData
                  net.sf.basedb.core.data.AnnotatedData
                      net.sf.basedb.core.data.ProtocolData

All Implemented Interfaces:

AnnotatableData, FileAttachableData, IdentifiableData, LoggableData, NameableData, OwnableData, RegisteredData, RemovableData, ShareableData

public class ProtocolData
extends AnnotatedData
implements FileAttachableData, RegisteredData

Version:

2.0

Author:

enell

See Also:

Protocol, Protocol overview

Hibernate: class

table="`Protocols`" lazy="true"

Field Summary

private Date	entryDate
private String	externalId
private FileData	file
static int	MAX_EXTERNAL_ID_LENGTH The maximum length of the external id that can be stored in the database.
private Set<AnnotationTypeData>	parameters
private ProtocolTypeData	protocolType

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

ProtocolData()

Method Summary

Date	getEntryDate() Get the date this item was added to the database.
String	getExternalId() Get the external id for the protocol.
FileData	getFile() Get the file that is attached to the item.
Set<AnnotationTypeData>	getParameters() This set manages the parameters for this protcol.
ProtocolTypeData	getProtocolType() Get the associated ProtocolTypeData item.
void	setEntryDate(Date entryDate)
void	setExternalId(String externalId)
void	setFile(FileData file) Attach a file to the item.
(package private) void	setParameters(Set<AnnotationTypeData> parameters)
void	setProtocolType(ProtocolTypeData protocolType)

Methods inherited from class net.sf.basedb.core.data.AnnotatedData

getAnnotationSet, setAnnotationSet

Methods inherited from class net.sf.basedb.core.data.CommonData

getDescription, getName, isRemoved, setDescription, setName, setRemoved

Methods inherited from class net.sf.basedb.core.data.SharedData

getItemKey, getProjectKey, setItemKey, setProjectKey

Methods inherited from class net.sf.basedb.core.data.OwnedData

getOwner, setOwner

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

Methods inherited from interface net.sf.basedb.core.data.OwnableData

getOwner, setOwner

Field Detail

file

private FileData file

entryDate

private Date entryDate

protocolType

private ProtocolTypeData protocolType

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.

Since:

2.15

See Also:

setExternalId(String), Constant Field Values

externalId

private String externalId

parameters

private Set<AnnotationTypeData> parameters

Constructor Detail

ProtocolData

public ProtocolData()

Method Detail

getFile

public FileData getFile()

Description copied from interface: FileAttachableData

Get the file that is attached to the item.

Specified by:

getFile in interface FileAttachableData

Returns:

A FileData object or null if no file is attached

setFile

public void setFile(FileData file)

Description copied from interface: FileAttachableData

Attach a file to the item. Null is allowed.

Specified by:

setFile in interface FileAttachableData

getEntryDate

public Date getEntryDate()

Description copied from interface: RegisteredData

Get the date this item was added to the database. The value is generated at creation time and can't be modified later.

Specified by:

getEntryDate in interface RegisteredData

setEntryDate

public void setEntryDate(Date entryDate)

getProtocolType

public ProtocolTypeData getProtocolType()

Get the associated ProtocolTypeData item.

Hibernate: many-to-one

column="`protocoltype_id`" not-null="true" outer-join="false"

setProtocolType

public void setProtocolType(ProtocolTypeData protocolType)

getExternalId

public String getExternalId()

Get the external id for the protocol.

Since:

2.15

Hibernate: property

column="`external_id`" type="string" length="255" not-null="false"

setExternalId

public void setExternalId(String externalId)

getParameters

public Set<AnnotationTypeData> getParameters()

This set manages the parameters for this protcol.

Since:

2.2

Hibernate: set

table="`ProtocolParameters`" lazy="true"

Hibernate: collection-key

column="`protocol_id`"

Hibernate: collection-many-to-many

column="`annotationtype_id`" class="net.sf.basedb.core.data.AnnotationTypeData"

setParameters

void setParameters(Set<AnnotationTypeData> parameters)