Class DataSet<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>

    • Field Detail

      • service

        protected final ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISService service
    • Constructor Detail

      • DataSet

        public DataSet​(DataSetRegistrationDetails<? extends T> registrationDetails,
                       java.io.File dataSetFolder,
                       ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService service)
    • Method Detail

      • getDataSetStagingFolder

        public java.io.File getDataSetStagingFolder()
      • tryDataSetContents

        public java.io.File tryDataSetContents()
      • getDataSetCode

        public java.lang.String getDataSetCode()
        Description copied from interface: IDataSetImmutable
        Get the data set code of the data set
        Specified by:
        getDataSetCode in interface IDataSetImmutable
        Returns:
        The code of this data set.
      • getExperiment

        public IExperimentImmutable getExperiment()
        Description copied from interface: IDataSetImmutable
        Get the experiment for this data set. This can only be null at initialization time, and will be non-null for a valid data set.
        Specified by:
        getExperiment in interface IDataSetImmutable
        Returns:
        The experiment for this data set (will be non-null for a valid data set)
      • setExperiment

        public void setExperiment​(IExperimentImmutable experiment)
        Description copied from interface: IDataSetUpdatable
        Set the experiment for this data set. The experiment may also be set by setting the sample.
        Specified by:
        setExperiment in interface IDataSetUpdatable
        Parameters:
        experiment - The experiment for this data set. Need not actually be immutable, but the immutable one is the supertype.
      • setSample

        public void setSample​(ISampleImmutable sampleOrNull)
        Description copied from interface: IDataSetUpdatable
        Set the sample for this data set. Will also set the experiment, since the sample must have an experiment.
        Specified by:
        setSample in interface IDataSetUpdatable
        Parameters:
        sampleOrNull - The sample to use. Need not actually be immutable, but the immutable one is the supertype.
      • getFileFormatType

        public java.lang.String getFileFormatType()
        Description copied from interface: IDataSetImmutable
        The file format type of the data set. Defaults to the default specified in FileFormatType.

        This property is undefined for container data sets.

        Specified by:
        getFileFormatType in interface IDataSetImmutable
        Returns:
        The code of the FileFormatType for this data set.
      • setFileFormatType

        public void setFileFormatType​(java.lang.String fileFormatTypeCode)
        Description copied from interface: IDataSetUpdatable
        Set the file format type.

        This property is undefined for container data sets.

        Specified by:
        setFileFormatType in interface IDataSetUpdatable
        Parameters:
        fileFormatTypeCode - The code of the desired FileFormatType.
      • isMeasuredData

        public boolean isMeasuredData()
        Description copied from interface: IDataSetImmutable
        Return true if the data set is measured data. Defaults to true.
        Specified by:
        isMeasuredData in interface IDataSetImmutable
        Returns:
        True if the data set is measured data, false otherwise.
      • setMeasuredData

        public void setMeasuredData​(boolean measuredData)
        Description copied from interface: IDataSet
        Set whether the data is measured or not.
        Specified by:
        setMeasuredData in interface IDataSet
      • getSpeedHint

        public int getSpeedHint()
        Description copied from interface: IDataSetImmutable
        Returns the speed hint.

        This property is undefined for container data sets.

        Specified by:
        getSpeedHint in interface IDataSetImmutable
      • setSpeedHint

        public void setSpeedHint​(int speedHint)
        Description copied from interface: IDataSet
        Sets the speed hint for the data set. The speed hint is a negative or positive number with an absolute value less than or equal Constants.MAX_SPEED.

        A positive value means that the data set should be stored in a storage with speed >= speedHint. A negative value means that the data set should be stored in a storage with speed <= abs(speedHint). The speed hint might be ignored.

        If no speed hint has been set the default value Constants.DEFAULT_SPEED_HINT is assumed.

        This property is undefined for container data sets.

        Specified by:
        setSpeedHint in interface IDataSet
      • getDataSetType

        public java.lang.String getDataSetType()
        Description copied from interface: IDataSetImmutable
        Get the data set type. This is only null during initialization and is non-null for a valid data set.
        Specified by:
        getDataSetType in interface IDataSetImmutable
      • getDataSetKind

        public ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKind getDataSetKind()
        Specified by:
        getDataSetKind in interface IDataSetImmutable
      • setDataSetType

        public void setDataSetType​(java.lang.String dataSetTypeCode)
        Description copied from interface: IDataSet
        Set the data set type.
        Specified by:
        setDataSetType in interface IDataSet
      • setDataSetKind

        public void setDataSetKind​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKind dataSetKind)
        Specified by:
        setDataSetKind in interface IDataSet
      • setExperiment

        protected void setExperiment​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Experiment exp)
      • setPropertyValue

        public void setPropertyValue​(java.lang.String propertyCode,
                                     java.lang.String propertyValue)
        Description copied from interface: IDataSetUpdatable
        Set the value for a property.
        Specified by:
        setPropertyValue in interface IDataSetUpdatable
      • setParentDatasets

        public void setParentDatasets​(java.util.List<java.lang.String> parentDatasetCodes)
        Description copied from interface: IDataSetUpdatable
        Sets the parents of the dataset.
        Specified by:
        setParentDatasets in interface IDataSetUpdatable
      • setContainedDataSetCodes

        public void setContainedDataSetCodes​(java.util.List<java.lang.String> containedDataSetCodes)
        Description copied from interface: IDataSetUpdatable
        Set the codes for contained data sets.
        Specified by:
        setContainedDataSetCodes in interface IDataSetUpdatable
      • getContainerDataSet

        public java.lang.String getContainerDataSet()
        Description copied from interface: IDataSetImmutable
        Return the code of the container in which this data set is contained. If the data set is in more than one container only the code of one of these containers is returned.
        Specified by:
        getContainerDataSet in interface IDataSetImmutable
      • getContainerDataSets

        public java.util.List<java.lang.String> getContainerDataSets()
        Description copied from interface: IDataSetImmutable
        Returns the codes of all containers in which this data set is contained.
        Specified by:
        getContainerDataSets in interface IDataSetImmutable
      • getOrderInContainer

        public java.lang.Integer getOrderInContainer​(java.lang.String containerDataSetCode)
        Description copied from interface: IDataSetImmutable
        Returns the order of this data set in the specified container data set.
        Specified by:
        getOrderInContainer in interface IDataSetImmutable
        Returns:
        null if this data set is not a component of the specified container data set.
      • isLinkDataSet

        public boolean isLinkDataSet()
        Specified by:
        isLinkDataSet in interface IDataSetImmutable
        Returns:
        true if this is a data set, that links to external data management system
      • setExternalCode

        public void setExternalCode​(java.lang.String externalCode)
        Description copied from interface: IDataSetUpdatable
        Set the code from the external data management system
        Specified by:
        setExternalCode in interface IDataSetUpdatable
      • getExternalCode

        public java.lang.String getExternalCode()
        Specified by:
        getExternalCode in interface IDataSetImmutable
        Returns:
        the code of this link data set in the external data management system
      • isNoFileDataSet

        public boolean isNoFileDataSet()
        Specified by:
        isNoFileDataSet in interface IDataSetImmutable
        Returns:
        true if this dataset doesn't contain any files. It can be for example container or link data set.
      • isPostRegistered

        public boolean isPostRegistered()
        Specified by:
        isPostRegistered in interface IDataSetImmutable
        Returns:
        true if, for this dataset, post registration has been finished.
      • getDataSetTypeWithPropertyTypes

        protected DataSetType getDataSetTypeWithPropertyTypes​(java.lang.String dataSetTypeCode)