Package ch.systemsx.cisd.etlserver.registrator.api.v2.impl

Class SampleImmutable

  • All Implemented Interfaces:
    ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent, ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
    Direct Known Subclasses:
    Sample
    public class SampleImmutable
extends java.lang.Object
implements ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

    • Constructor Summary

      Constructors 
      Constructor Description
      SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample)
      Creates a new object that wraps the sample, which is assumed be an existing sample with all fetch options retrieved.
      SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, boolean existingSample)
      Creates a new object that wraps the sample, which is assumed to have all fetch options retrieved.
      SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions)
      Creates a new object that wraps the sample, which is assumed be an existing sample.
      SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions, boolean existingSample)  

    • Constructor Detail

      • SampleImmutable

        public SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample)
        Creates a new object that wraps the sample, which is assumed be an existing sample with all fetch options retrieved.
        Parameters:
        sample - The sample to wrap.

      • SampleImmutable

        public SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample,
                       java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions)
        Creates a new object that wraps the sample, which is assumed be an existing sample.
        Parameters:
        sample - The sample to wrap.
        retrievedFetchOptions - The fetch options the sample includes.

      • SampleImmutable

        public SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample,
                       boolean existingSample)
        Creates a new object that wraps the sample, which is assumed to have all fetch options retrieved.
        Parameters:
        sample - The sample to wrap.
        existingSample - True if the sample exists in the DB.

      • SampleImmutable

        public SampleImmutable​(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample,
                       java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions,
                       boolean existingSample)

    • Method Detail

      • getExperiment

        public ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutable getExperiment()
        Specified by:
        getExperiment in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getProject

        public ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IProjectImmutable getProject()
        Specified by:
        getProject in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getSampleIdentifier

        public java.lang.String getSampleIdentifier()
        Specified by:
        getSampleIdentifier in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getId

        public java.lang.Long getId()

      • getEntityId

        public ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.id.IObjectId getEntityId()
        Specified by:
        getEntityId in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent

      • getSample

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

      • isExistingSample

        public boolean isExistingSample()
        Specified by:
        isExistingSample in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • checkExists

        protected void checkExists()
        Throw an exception if the sample does not exist

      • getPropertyValue

        public java.lang.String getPropertyValue​(java.lang.String propertyCode)
        Specified by:
        getPropertyValue in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getSampleType

        public java.lang.String getSampleType()
        Specified by:
        getSampleType in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getSpace

        public java.lang.String getSpace()
        Specified by:
        getSpace in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getCode

        public java.lang.String getCode()
        Specified by:
        getCode in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getPermId

        public java.lang.String getPermId()
        Specified by:
        getPermId in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getContainedSamples

        public java.util.List<ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable> getContainedSamples()
        Specified by:
        getContainedSamples in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • getParentSampleIdentifiers

        public java.util.List<java.lang.String> getParentSampleIdentifiers()
        Specified by:
        getParentSampleIdentifiers in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • canGetContainedSamples

        public boolean canGetContainedSamples()
        Specified by:
        canGetContainedSamples in interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

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