Class SearchService

    • Constructor Detail

      • SearchService

        public SearchService​(ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISService openBisService)
    • Method Detail

      • getProject

        public IProjectImmutable getProject​(java.lang.String projectIdentifierString)
        Description copied from interface: ISearchService
        Get a project from the openBIS AS. Returns null if the project does not exist.
        Specified by:
        getProject in interface ISearchService
        Returns:
        A project or null
      • getProjectByIdentifier

        public IProjectImmutable getProjectByIdentifier​(java.lang.String projectIdentifierString)
        Description copied from interface: ISearchService
        Get a project from the openBIS AS. Returns null if the project does not exist.
        Specified by:
        getProjectByIdentifier in interface ISearchService
        Returns:
        A project or null
      • getSpace

        public ISpaceImmutable getSpace​(java.lang.String spaceCode)
        Description copied from interface: ISearchService
        Get a space from the openBIS AS. Returns null if the space does not exist.
        Specified by:
        getSpace in interface ISearchService
        Returns:
        A space or null
      • listExperiments

        public java.util.List<IExperimentImmutable> listExperiments​(java.lang.String projectIdentifierString)
        Description copied from interface: ISearchService
        List all experiments for a given project.
        Specified by:
        listExperiments in interface ISearchService
        Parameters:
        projectIdentifierString - The project identifier as a string (e.g., /SPACE-CODE/PROJECT-CODE).
        Returns:
        A list of experiments for the specified project.
      • searchForDataSets

        public java.util.List<IDataSetImmutable> searchForDataSets​(java.lang.String property,
                                                                   java.lang.String value,
                                                                   java.lang.String typeOrNull)
        Description copied from interface: ISearchService
        List all data sets with a given value for a particular property, optionally restricted to a specific type.
        Specified by:
        searchForDataSets in interface ISearchService
        Parameters:
        property - The property of interest.
        value - The value the property should have. This may contain wildcards.
        Returns:
        A list of matching data sets.
      • searchForDataSets

        public java.util.List<IDataSetImmutable> searchForDataSets​(java.lang.String property,
                                                                   java.lang.String value,
                                                                   java.lang.String typeOrNull,
                                                                   boolean escape)
        Description copied from interface: ISearchService
        List all data sets with a given value for a particular property, optionally restricted to a specific type.
        Specified by:
        searchForDataSets in interface ISearchService
        Parameters:
        property - The property of interest.
        value - The value the property should have. This may contain wildcards if escape is set to false.
        escape - If true, escape the value to search for it verbatimly.
        Returns:
        A list of matching data sets.
      • searchForSamples

        public java.util.List<ISampleImmutable> searchForSamples​(java.lang.String property,
                                                                 java.lang.String value,
                                                                 java.lang.String typeOrNull)
        Description copied from interface: ISearchService
        List all samples with a given value for a particular property, optionally restricted to a specific type.
        Specified by:
        searchForSamples in interface ISearchService
        Parameters:
        property - The property of interest.
        value - The value the property should have. This may contain wildcards.
        Returns:
        A list of matching samples.
      • searchForSamples

        public java.util.List<ISampleImmutable> searchForSamples​(java.lang.String property,
                                                                 java.lang.String value,
                                                                 java.lang.String typeOrNull,
                                                                 boolean escape)
        Description copied from interface: ISearchService
        List all samples with a given value for a particular property, optionally restricted to a specific type.
        Specified by:
        searchForSamples in interface ISearchService
        Parameters:
        property - The property of interest.
        value - The value the property should have. This may contain wildcards if escape is set to false.
        escape - If true, escape the value to search for it verbatimly.
        Returns:
        A list of matching samples.
      • searchForDataSets

        public java.util.List<IDataSetImmutable> searchForDataSets​(SearchCriteria searchCriteria)
        Description copied from interface: ISearchService
        List all data sets that match the given searchCriteria.
        Specified by:
        searchForDataSets in interface ISearchService
        Parameters:
        searchCriteria - The criteria to match against.
        Returns:
        A list of matching data sets.
      • searchForSamples

        public java.util.List<ISampleImmutable> searchForSamples​(SearchCriteria searchCriteria)
        Description copied from interface: ISearchService
        List all samples that match the given searchCriteria.
        Specified by:
        searchForSamples in interface ISearchService
        Parameters:
        searchCriteria - The criteria to match against.
        Returns:
        A list of matching samples.
      • listMaterials

        public java.util.List<IMaterialImmutable> listMaterials​(MaterialIdentifierCollection identifierCollection)
        Specified by:
        listMaterials in interface ISearchService
        Parameters:
        identifierCollection - a collection containing the identifiers of the matching materials. Identifiers that do not exist in the openBIS database are ignored.
        Returns:
        a list of materials matching the specified collection.
      • searchForVocabulary

        public IVocabularyImmutable searchForVocabulary​(java.lang.String code)
        Specified by:
        searchForVocabulary in interface ISearchService
        Returns:
        a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
      • getVocabulary

        public IVocabularyImmutable getVocabulary​(java.lang.String code)
        Specified by:
        getVocabulary in interface ISearchService
        Returns:
        a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
      • getDataSet

        public IDataSetImmutable getDataSet​(java.lang.String dataSetCode)
        Description copied from interface: ISearchService
        Get a data set from the openBIS AS. Returns null if the data set does not exist.
        Specified by:
        getDataSet in interface ISearchService
        Returns:
        A data set or null
      • getThinDataSet

        public IDataSetImmutable getThinDataSet​(java.lang.String dataSetCode)
        Description copied from interface: ISearchService
        Get a data set from the openBIS AS. Returns null if the data set does not exist. The returned data set will contain only basic information, and no related entities.
        Specified by:
        getThinDataSet in interface ISearchService
        Returns:
        A data set or null
      • getSample

        public ISampleImmutable getSample​(java.lang.String sampleIdentifierString)
        Description copied from interface: ISearchService
        Get a sample from the openBIS AS. Returns null if the sample does not exist.
        Specified by:
        getSample in interface ISearchService
        Returns:
        A sample or null
      • getSampleByIdentifier

        public ISampleImmutable getSampleByIdentifier​(java.lang.String sampleIdentifierString)
        Description copied from interface: ISearchService
        Get a sample from the openBIS AS. Returns null if the sample does not exist.
        Specified by:
        getSampleByIdentifier in interface ISearchService
        Returns:
        A sample or null
      • getSampleByPermId

        public ISampleImmutable getSampleByPermId​(java.lang.String permId)
        Description copied from interface: ISearchService
        Get a sample from the openBIS AS by its perm id. Returns null if the sample does not exist.
        Specified by:
        getSampleByPermId in interface ISearchService
        Returns:
        A sample or null
      • getMaterial

        public IMaterialImmutable getMaterial​(java.lang.String materialCode,
                                              java.lang.String materialType)
        Description copied from interface: ISearchService
        Get a material from the openBIS AS. Returns null if the material does not exist.
        Specified by:
        getMaterial in interface ISearchService
        Returns:
        A material or null
      • getMaterial

        public IMaterialImmutable getMaterial​(java.lang.String identifier)
        Description copied from interface: ISearchService
        Get a material from the openBIS AS. Returns null if the material does not exist.
        Specified by:
        getMaterial in interface ISearchService
        Returns:
        A material or null