ch.systemsx.cisd.openbis.dss.generic.shared.dto
Class DataSetInformation

java.lang.Object
  extended by ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation
All Implemented Interfaces:
java.io.Serializable

public class DataSetInformation
extends java.lang.Object
implements java.io.Serializable

Container class for data extracted from the data set directory.

See Also:
Serialized Form

Constructor Summary
DataSetInformation()
          This constructor is for serialization.
 
Method Summary
 java.lang.String describe()
           
 java.util.List<java.lang.String> getContainedDataSetCodes()
           
 java.lang.String getDataSetCode()
           
 java.util.List<ch.systemsx.cisd.openbis.generic.shared.dto.NewProperty> getDataSetProperties()
           
 ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetType getDataSetType()
           
 ch.systemsx.cisd.openbis.generic.shared.dto.identifier.ExperimentIdentifier getExperimentIdentifier()
          Returns the identifier of experiment which makes it unique.
 java.lang.String getExternalCode()
           
 java.lang.String getExternalDataManagementSystem()
           
 ch.systemsx.cisd.openbis.generic.shared.dto.ExtractableData getExtractableData()
           
 java.lang.String getInstanceCode()
           
 java.lang.String getInstanceUUID()
           
 ch.systemsx.cisd.openbis.common.types.BooleanOrUnknown getIsCompleteFlag()
           
 java.util.List<java.lang.String> getParentDataSetCodes()
           
 java.lang.String getProducerCode()
           
 java.util.Date getProductionDate()
           
 java.lang.String getSampleCode()
           
 ch.systemsx.cisd.openbis.generic.shared.dto.identifier.SampleIdentifier getSampleIdentifier()
          Returns the sample identifier.
 ch.systemsx.cisd.openbis.generic.shared.basic.dto.IEntityProperty[] getSampleProperties()
          Returns the sample properties.
 java.lang.String getShareId()
           
 java.lang.String getSpaceCode()
           
 int getSpeedHint()
           
 java.lang.String getUploadingUserIdOrNull()
           
 boolean isContainerDataSet()
           
 boolean isLinkDataSet()
           
 boolean isLinkSample()
           
 boolean isNoFileDataSet()
           
 void setComplete(boolean complete)
           
 void setContainedDataSetCodes(java.util.List<java.lang.String> containedDataSetCodes)
           
 void setContainerDataSet(ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractExternalData containerDataSetOrNull)
           
 void setContainerDatasetPermId(java.lang.String containerDatasetPermIdOrNull)
           
 void setDataSetCode(java.lang.String dataSetCode)
           
 void setDataSetProperties(java.util.List<ch.systemsx.cisd.openbis.generic.shared.dto.NewProperty> dataSetProperties)
           
 void setDataSetType(ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetType dataSetType)
           
 void setExperiment(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Experiment experiment)
           
 void setExperimentIdentifier(ch.systemsx.cisd.openbis.generic.shared.dto.identifier.ExperimentIdentifier experimentIdentifier)
          Sets experimentIdentifier.
 void setExternalCode(java.lang.String externalCode)
           
 void setExternalDataManagementSystem(java.lang.String code)
           
 void setExtractableData(ch.systemsx.cisd.openbis.generic.shared.dto.ExtractableData extractableData)
           
 void setInstanceCode(java.lang.String instanceCode)
           
 void setInstanceUUID(java.lang.String instanceUUID)
           
 void setLinkSample(boolean linkSample)
           
 void setParentDataSetCodes(java.util.List<java.lang.String> parentDataSetCodes)
           
 void setProducerCode(java.lang.String producerCode)
           
 void setProductionDate(java.util.Date productionDate)
           
 void setSample(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample)
           
 void setSampleCode(java.lang.String sampleCode)
           
 void setSampleIdentifier(ch.systemsx.cisd.openbis.generic.shared.dto.identifier.SampleIdentifier sampleIdentifier)
          Sets the sample identifier.
 void setSampleIdentifier(java.lang.String sampleIdentifier)
           
 void setSampleProperties(ch.systemsx.cisd.openbis.generic.shared.basic.dto.IEntityProperty[] properties)
           
 void setShareId(java.lang.String shareId)
           
 void setSpaceCode(java.lang.String spaceCode)
           
 void setSpeedHint(int speedHint)
           
 void setUploadingUserEmail(java.lang.String uploadingUserEmail)
           
 void setUploadingUserId(java.lang.String uploadingUserIdOrNull)
           
 java.lang.String toString()
           
 ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractExternalData tryGetContainerDataSet()
           
 java.lang.String tryGetContainerDatasetPermId()
           
 java.lang.String tryGetUploadingUserEmail()
           
 ch.systemsx.cisd.openbis.generic.shared.basic.dto.Experiment tryToGetExperiment()
          Returns the basic information about the experiment.
 ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample tryToGetSample()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataSetInformation

public DataSetInformation()
This constructor is for serialization.

Method Detail

getShareId

public java.lang.String getShareId()

setShareId

public void setShareId(java.lang.String shareId)

getSpeedHint

public int getSpeedHint()

setSpeedHint

public void setSpeedHint(int speedHint)

tryGetUploadingUserEmail

public java.lang.String tryGetUploadingUserEmail()

setUploadingUserEmail

public void setUploadingUserEmail(java.lang.String uploadingUserEmail)

setUploadingUserId

public void setUploadingUserId(java.lang.String uploadingUserIdOrNull)

getUploadingUserIdOrNull

public java.lang.String getUploadingUserIdOrNull()

getIsCompleteFlag

public final ch.systemsx.cisd.openbis.common.types.BooleanOrUnknown getIsCompleteFlag()

setComplete

public final void setComplete(boolean complete)

getSampleProperties

public final ch.systemsx.cisd.openbis.generic.shared.basic.dto.IEntityProperty[] getSampleProperties()
Returns the sample properties.

Returns:
never null but could return an empty array.

setSampleProperties

public final void setSampleProperties(ch.systemsx.cisd.openbis.generic.shared.basic.dto.IEntityProperty[] properties)

getDataSetType

public ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetType getDataSetType()

setDataSetType

public void setDataSetType(ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetType dataSetType)

getInstanceCode

public final java.lang.String getInstanceCode()

setInstanceCode

public final void setInstanceCode(java.lang.String instanceCode)

getInstanceUUID

public final java.lang.String getInstanceUUID()

setInstanceUUID

public final void setInstanceUUID(java.lang.String instanceUUID)

setExperimentIdentifier

public final void setExperimentIdentifier(ch.systemsx.cisd.openbis.generic.shared.dto.identifier.ExperimentIdentifier experimentIdentifier)
Sets experimentIdentifier.


getExperimentIdentifier

public final ch.systemsx.cisd.openbis.generic.shared.dto.identifier.ExperimentIdentifier getExperimentIdentifier()
Returns the identifier of experiment which makes it unique.

Returns:
null if no ExperimentIdentifier has been set.

tryToGetExperiment

public ch.systemsx.cisd.openbis.generic.shared.basic.dto.Experiment tryToGetExperiment()
Returns the basic information about the experiment.


setExperiment

public void setExperiment(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Experiment experiment)

tryToGetSample

public ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample tryToGetSample()

setSample

public void setSample(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample)

getSampleIdentifier

public final ch.systemsx.cisd.openbis.generic.shared.dto.identifier.SampleIdentifier getSampleIdentifier()
Returns the sample identifier.

Returns:
null if sampleCode has not been set.

setSampleIdentifier

public final void setSampleIdentifier(ch.systemsx.cisd.openbis.generic.shared.dto.identifier.SampleIdentifier sampleIdentifier)
Sets the sample identifier.


setSampleIdentifier

public final void setSampleIdentifier(java.lang.String sampleIdentifier)

getSampleCode

public final java.lang.String getSampleCode()

setSampleCode

public final void setSampleCode(java.lang.String sampleCode)

isLinkSample

public boolean isLinkSample()

setLinkSample

public void setLinkSample(boolean linkSample)

getDataSetCode

public final java.lang.String getDataSetCode()

setDataSetCode

public final void setDataSetCode(java.lang.String dataSetCode)

getProducerCode

public final java.lang.String getProducerCode()

setProducerCode

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

getProductionDate

public final java.util.Date getProductionDate()

setProductionDate

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

getExtractableData

public final ch.systemsx.cisd.openbis.generic.shared.dto.ExtractableData getExtractableData()

setExtractableData

public final void setExtractableData(ch.systemsx.cisd.openbis.generic.shared.dto.ExtractableData extractableData)

getParentDataSetCodes

public final java.util.List<java.lang.String> getParentDataSetCodes()

setParentDataSetCodes

public final void setParentDataSetCodes(java.util.List<java.lang.String> parentDataSetCodes)

setSpaceCode

public final void setSpaceCode(java.lang.String spaceCode)

getSpaceCode

public final java.lang.String getSpaceCode()

setDataSetProperties

public void setDataSetProperties(java.util.List<ch.systemsx.cisd.openbis.generic.shared.dto.NewProperty> dataSetProperties)

getDataSetProperties

public java.util.List<ch.systemsx.cisd.openbis.generic.shared.dto.NewProperty> getDataSetProperties()

getContainedDataSetCodes

public java.util.List<java.lang.String> getContainedDataSetCodes()

setContainedDataSetCodes

public void setContainedDataSetCodes(java.util.List<java.lang.String> containedDataSetCodes)

isContainerDataSet

public boolean isContainerDataSet()

setExternalDataManagementSystem

public void setExternalDataManagementSystem(java.lang.String code)

getExternalDataManagementSystem

public java.lang.String getExternalDataManagementSystem()

isLinkDataSet

public boolean isLinkDataSet()

isNoFileDataSet

public boolean isNoFileDataSet()

getExternalCode

public java.lang.String getExternalCode()

setExternalCode

public void setExternalCode(java.lang.String externalCode)

describe

public final java.lang.String describe()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

tryGetContainerDatasetPermId

public java.lang.String tryGetContainerDatasetPermId()

setContainerDatasetPermId

public void setContainerDatasetPermId(java.lang.String containerDatasetPermIdOrNull)

tryGetContainerDataSet

public ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractExternalData tryGetContainerDataSet()

setContainerDataSet

public void setContainerDataSet(ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractExternalData containerDataSetOrNull)