Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Class AbstractExternalData

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractRegistrationHolder

ch.systemsx.cisd.openbis.generic.shared.basic.dto.CodeWithRegistration<T>

ch.systemsx.cisd.openbis.generic.shared.basic.dto.CodeWithRegistrationAndModificationDate<AbstractExternalData>

ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractExternalData

All Implemented Interfaces:

IEntityPropertiesHolder, ICodeHolder, IDeletionProvider, IEntityInformationHolder, IEntityInformationHolderWithIdentifier, IEntityInformationHolderWithPermId, IEntityInformationHolderWithProperties, IEntityWithDeletionInformation, IIdAndCodeHolder, IIdentifierHolder, IIdHolder, IIsStub, IPermIdHolder, IRegistratorAndModifierHolder, IRegistratorHolder, ITaggable, java.io.Serializable, java.lang.Comparable<AbstractExternalData>

Direct Known Subclasses:

ContainerDataSet, LinkDataSet, PhysicalDataSet, PlaceholderDataSet

public abstract class AbstractExternalData
extends CodeWithRegistrationAndModificationDate<AbstractExternalData>
implements IEntityWithDeletionInformation, IEntityInformationHolderWithProperties, IIdAndCodeHolder, IPermIdHolder, IIsStub, ITaggable

A DTO for any kind of data set.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractExternalData.DataSetComponentsComparator	Comparator for data sets contained in a (virtual) container which uses ascending order in container.

Constructor Summary

Constructors

Constructor	Description
AbstractExternalData(boolean isStub)

Method Summary

Modifier and Type	Method	Description
void	addContainer(ContainerDataSet containerDataSet, java.lang.Integer orderInContainer)
java.util.Date	getAccessTimestamp()
java.util.Collection<AbstractExternalData>	getChildren()
java.util.List<ContainerDataSet>	getContainerDataSets()
java.lang.String	getDataProducerCode()
DataSetKind	getDataSetKind()
DataSetType	getDataSetType()
DataStore	getDataStore()
Deletion	getDeletion()
EntityKind	getEntityKind()	Return the entity kind of this matching entity.
EntityType	getEntityType()	Returns the entity type of this matching entity.
Experiment	getExperiment()
java.lang.Long	getId()	Returns the technical ID of this instance.
java.lang.String	getIdentifier()
java.util.Collection<Metaproject>	getMetaprojects()
java.lang.Integer	getOrderInContainer(java.lang.Long containerDataSetTechId)
java.lang.Integer	getOrderInContainer(java.lang.String containerDataSetCode)
java.util.Collection<AbstractExternalData>	getParents()
java.lang.String	getPermId()
java.lang.String	getPermlink()
java.util.Date	getProductionDate()
Project	getProject()
java.util.List<IEntityProperty>	getProperties()
Sample	getSample()	NOTE: may be NULL
java.lang.String	getSampleCode()	NOTE: may be NULL
java.lang.String	getSampleIdentifier()	NOTE: may be NULL
SampleType	getSampleType()	NOTE: may be NULL
java.lang.Long	getSize()
java.lang.String	getSourceType()
Space	getSpace()
boolean	isAvailable()
boolean	isContainer()
boolean	isDerived()
boolean	isLinkData()
boolean	isPlaceHolderDataSet()
boolean	isPostRegistered()
boolean	isStorageConfirmation()
boolean	isStub()
void	setAccessTimestamp(java.util.Date accessTimestamp)
void	setChildren(java.util.Collection<AbstractExternalData> children)
void	setDataProducerCode(java.lang.String producerCode)
void	setDataSetProperties(java.util.List<IEntityProperty> dataSetProperties)
void	setDataSetType(DataSetType dataSetType)
void	setDataStore(DataStore dataStore)
void	setDeletion(Deletion deletion)
void	setDerived(boolean derived)
void	setExperiment(Experiment experiment)
void	setId(java.lang.Long id)
void	setMetaprojects(java.util.Collection<Metaproject> metaprojects)
void	setParents(java.util.Collection<AbstractExternalData> parents)
void	setPermlink(java.lang.String permlink)
void	setPostRegistered(boolean isPostRegistered)
void	setProductionDate(java.util.Date productionDate)
void	setSample(Sample sample)
void	setSize(java.lang.Long size)
void	setStorageConfirmation(boolean storageConfirmation)
ContainerDataSet	tryGetAsContainerDataSet()	Returns null if the data set is not a container data set, otherwise returns the container.
PhysicalDataSet	tryGetAsDataSet()	Will return non-null values for plain non-container data sets.
LinkDataSet	tryGetAsLinkDataSet()
ContainerDataSet	tryGetContainer()	Deprecated.

Methods inherited from class ch.systemsx.cisd.openbis.generic.shared.basic.dto.CodeWithRegistrationAndModificationDate

getModificationDate, getModifier, getVersion, setModificationDate, setModifier, setVersion

Methods inherited from class ch.systemsx.cisd.openbis.generic.shared.basic.dto.CodeWithRegistration

compareTo, getCode, setCode

Methods inherited from class ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractRegistrationHolder

getRegistrationDate, getRegistrator, setRegistrationDate, setRegistrator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.systemsx.cisd.openbis.generic.shared.basic.ICodeHolder

getCode

Methods inherited from interface ch.systemsx.cisd.openbis.generic.shared.basic.IRegistratorHolder

getRegistrator

Constructor Detail

AbstractExternalData

public AbstractExternalData(boolean isStub)

Method Detail

isAvailable

public boolean isAvailable()

Returns:

true if the data set is available for viewing/editing.

isContainer

public boolean isContainer()

Returns:

true if this is a container data set.

isLinkData

public boolean isLinkData()

Returns:

true if this is a link data set.

isPlaceHolderDataSet

public boolean isPlaceHolderDataSet()

Returns:

true if this is a place holder data set.

tryGetAsDataSet

public PhysicalDataSet tryGetAsDataSet()

Will return non-null values for plain non-container data sets.

tryGetAsContainerDataSet

public ContainerDataSet tryGetAsContainerDataSet()

Returns null if the data set is not a container data set, otherwise returns the container.

tryGetAsLinkDataSet

public LinkDataSet tryGetAsLinkDataSet()

getPermlink

public java.lang.String getPermlink()

setPermlink

public void setPermlink(java.lang.String permlink)

getSample

public Sample getSample()

NOTE: may be NULL

setSample

public void setSample(Sample sample)

getSampleIdentifier

public final java.lang.String getSampleIdentifier()

NOTE: may be NULL

getSampleCode

public final java.lang.String getSampleCode()

NOTE: may be NULL

getSampleType

public final SampleType getSampleType()

NOTE: may be NULL

getChildren

public java.util.Collection<AbstractExternalData> getChildren()

setChildren

public void setChildren(java.util.Collection<AbstractExternalData> children)

isDerived

public final boolean isDerived()

setDerived

public final void setDerived(boolean derived)

getDataSetType

public final DataSetType getDataSetType()

setDataSetType

public final void setDataSetType(DataSetType dataSetType)

getProductionDate

public final java.util.Date getProductionDate()

setProductionDate

public final void setProductionDate(java.util.Date productionDate)

getDataProducerCode

public final java.lang.String getDataProducerCode()

setDataProducerCode

public final void setDataProducerCode(java.lang.String producerCode)

getParents

public java.util.Collection<AbstractExternalData> getParents()

setParents

public void setParents(java.util.Collection<AbstractExternalData> parents)

getSize

public java.lang.Long getSize()

setSize

public void setSize(java.lang.Long size)

getDeletion

public final Deletion getDeletion()

Specified by:

getDeletion in interface IDeletionProvider

setDeletion

public final void setDeletion(Deletion deletion)

getExperiment

public final Experiment getExperiment()

setExperiment

public final void setExperiment(Experiment experiment)

setDataSetProperties

public void setDataSetProperties(java.util.List<IEntityProperty> dataSetProperties)

getProperties

public java.util.List<IEntityProperty> getProperties()

Specified by:

getProperties in interface IEntityPropertiesHolder

getDataStore

public final DataStore getDataStore()

setDataStore

public final void setDataStore(DataStore dataStore)

getEntityKind

public EntityKind getEntityKind()

Description copied from interface: IEntityInformationHolder

Return the entity kind of this matching entity.

Specified by:

getEntityKind in interface IEntityInformationHolder

getEntityType

public EntityType getEntityType()

Description copied from interface: IEntityInformationHolder

Returns the entity type of this matching entity.

Specified by:

getEntityType in interface IEntityInformationHolder

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in interface IIdentifierHolder

getId

public java.lang.Long getId()

Description copied from interface: IIdHolder

Returns the technical ID of this instance.

Specified by:

getId in interface IIdHolder

Returns:

null if there is no Id.

setId

public void setId(java.lang.Long id)

getPermId

public java.lang.String getPermId()

Specified by:

getPermId in interface IPermIdHolder

tryGetContainer

@Deprecated
public ContainerDataSet tryGetContainer()

Deprecated.

Returns:

the "virtual" container of this data set or null.

addContainer

public void addContainer(ContainerDataSet containerDataSet,
                         java.lang.Integer orderInContainer)

getContainerDataSets

public java.util.List<ContainerDataSet> getContainerDataSets()

getOrderInContainer

public java.lang.Integer getOrderInContainer(java.lang.Long containerDataSetTechId)

getOrderInContainer

public java.lang.Integer getOrderInContainer(java.lang.String containerDataSetCode)

isStorageConfirmation

public boolean isStorageConfirmation()

setStorageConfirmation

public void setStorageConfirmation(boolean storageConfirmation)

setMetaprojects

public void setMetaprojects(java.util.Collection<Metaproject> metaprojects)

getMetaprojects

public java.util.Collection<Metaproject> getMetaprojects()

Specified by:

getMetaprojects in interface ITaggable

getDataSetKind

public DataSetKind getDataSetKind()

getSourceType

public java.lang.String getSourceType()

isStub

public boolean isStub()

Specified by:

isStub in interface IIsStub

isPostRegistered

public boolean isPostRegistered()

setPostRegistered

public void setPostRegistered(boolean isPostRegistered)

getAccessTimestamp

public java.util.Date getAccessTimestamp()

setAccessTimestamp

public void setAccessTimestamp(java.util.Date accessTimestamp)

getSpace

public Space getSpace()

getProject

public Project getProject()