Class DataSetImmutable

    • Field Detail

      • dataSet

        protected final ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractExternalData dataSet
      • service

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

      • DataSetImmutable

        public DataSetImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.AbstractExternalData dataSet,
                                ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISService service)
    • Method Detail

      • getDataSetCode

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

        public IObjectId getEntityId()
      • 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.
        Returns:
        The experiment for this data set (will be non-null for a valid data set)
      • getSample

        public ISampleImmutable getSample()
        Description copied from interface: IDataSetImmutable
        Get the sample for this data set, if there is one.
        Returns:
        A sample or null.
      • 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.

        Returns:
        The code of the FileFormatType for this data set.
      • isMeasuredData

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

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

        This property is undefined for container data sets.

      • 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.
      • getDataSetKind

        public ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKind getDataSetKind()
      • getDataSetTypeWithPropertyTypes

        public DataSetType getDataSetTypeWithPropertyTypes()
        Description copied from interface: IDataSetImmutable
        Returns data set type with property types and vocabulary terms for all property types with vocabulary data type.
      • getPropertyValue

        public java.lang.String getPropertyValue​(java.lang.String propertyCode)
        Description copied from interface: IDataSetImmutable
        Get the value for a property.
      • getParentDatasets

        public java.util.List<java.lang.String> getParentDatasets()
        Description copied from interface: IDataSetImmutable
        Gets the parents of the dataset.
      • isContainerDataSet

        public boolean isContainerDataSet()
        Description copied from interface: IDataSetImmutable
        Return true if this data set contains other data sets.
      • isContainedDataSet

        public boolean isContainedDataSet()
        Description copied from interface: IDataSetImmutable
        Return true if this data set is contained in other data set
      • 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.
      • 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.
      • 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.
        Returns:
        null if this data set is not a component of the specified container data set.
      • getChildrenDataSets

        public java.util.List<IDataSetImmutable> getChildrenDataSets()
        Description copied from interface: IDataSetImmutable
        Gets the children data sets. Only available for data sets existing prior the transaction start.
      • isLinkDataSet

        public boolean isLinkDataSet()
        Returns:
        true if this is a data set, that links to external data management system
      • getExternalCode

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

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

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • isPostRegistered

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

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