com.ibm.jarm.api.query

Class RMSearch

  • java.lang.Object
    • com.ibm.jarm.api.query.RMSearch


  • public class RMSearch
    extends java.lang.Object
    Class used to perform non-CBR repository search operations.
    • Constructor Summary

      Constructors 
      Constructor and Description
      RMSearch(Repository repository)
      Constructs an RMSearch instance whose search scope is a single given repository.
      RMSearch(Repository[] repositories, RMMergeMode mergeMode)
      Constructs an RMSearch instance whose search scope is a collection of given repositories.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      PageableSet<CBRResult> contentBasedRetrieval(RMContentSearchDefinition srchDef, java.lang.Integer pageSize, java.lang.Boolean continuable)
      Performs a content-based retrieval of a record management system where the source documents with content are typically stored in content repositories and the associated records are declared in a file plan repository.
      PageableSet<? extends BaseEntity> fetchObjects(java.lang.String sqlStatement, EntityType entityType, java.lang.Integer pageSize, RMPropertyFilter filter, java.lang.Boolean continuable)
      Performs a search query and returns results as a homogeneous collection of BaseEntity subclass instances as defined by the entityType parameter.
      PageableSet<ResultRow> fetchRows(java.lang.String sqlStatement, java.lang.Integer pageSize, RMPropertyFilter filter, java.lang.Boolean continuable)
      Performs a search query and returns results as a collection of ResultRow.
      RMMergeMode getMergeMode()
      Returns the MergeMode assigned to this RMSearch instance.
      Repository[] getRepositories()
      Returns the collection of Repository instances that this RMSearch applies to.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RMSearch

        public RMSearch(Repository repository)
        Constructs an RMSearch instance whose search scope is a single given repository.
        Parameters:
        repository - the Repository instance to perform the search against.
      • RMSearch

        public RMSearch(Repository[] repositories,
                RMMergeMode mergeMode)
        Constructs an RMSearch instance whose search scope is a collection of given repositories. All repositories must be members of the same RMDomain.
        Parameters:
        repositories - an array of Repository instances to perform the search against.
        mergeMode - a RMMergeMode value that controls how results from the separate repositories should be merged together.
    • Method Detail

      • getRepositories

        public Repository[] getRepositories()
        Returns the collection of Repository instances that this RMSearch applies to.
        Returns:
        an array of Repository instances.
      • fetchObjects

        public PageableSet<? extends BaseEntity> fetchObjects(java.lang.String sqlStatement,
                                                     EntityType entityType,
                                                     java.lang.Integer pageSize,
                                                     RMPropertyFilter filter,
                                                     java.lang.Boolean continuable)
        Performs a search query and returns results as a homogeneous collection of BaseEntity subclass instances as defined by the entityType parameter. This form of search query does not support SQL JOIN operations.
        Parameters:
        sqlStatement - The SQL statement String that defines the query.
        entityType - The EntityType common to the returned objects.
        pageSize - An Integer defining the maximum number of results per returned page. This entry can be null in which case a repository-specific default page size is used.
        filter - A RMPropertyFilter that controls which properties and the the level of detail for each, that is to be included the RMProperties collection for each returned entity.
        continuable - If false or null the search is not paged and the pageSize parameter is ignored. If true, paging is supported and the pageSize parameter is used, if available.
        Returns:
        a PagableSet collection of of type BaseEntity (or subclass thereof) representing the search query results.
      • fetchRows

        public PageableSet<ResultRow> fetchRows(java.lang.String sqlStatement,
                                       java.lang.Integer pageSize,
                                       RMPropertyFilter filter,
                                       java.lang.Boolean continuable)
        Performs a search query and returns results as a collection of ResultRow. This form of search query supports SQL statements that involve JOIN operations.
        Parameters:
        sqlStatement - The SQL statement String that defines the query.
        pageSize - An Integer defining the maximum number of results per returned page. This entry can be null in which case, a repository-specific default page size is used.
        filter - A PropertyFilter that controls the level of detail, and so forth for the RMProperties collections belonging to each returned ResultRow.
        continuable - If false or null the search is not paged and the pageSize parameter is ignored. If true, paging is supported and the pageSize parameter is used, if available.
        Returns:
        a PageableSet collection of of type ResultRow representing the search query results.
      • contentBasedRetrieval

        public PageableSet<CBRResult> contentBasedRetrieval(RMContentSearchDefinition srchDef,
                                                   java.lang.Integer pageSize,
                                                   java.lang.Boolean continuable)
        Performs a content-based retrieval of a record management system where the source documents with content are typically stored in content repositories and the associated records are declared in a file plan repository. This method returns results as a collection of CBRResult. This form of search query supports SQL statements that involve JOIN operations.
        Parameters:
        srchDef - an instance of RMContentSearchDefinition that defines the query.
        pageSize - an Integer defining the maximum number of results per returned page. This entry cannot be null.
        continuable - must set to true to support paging. It always returns paged results.
        Returns:
        a PageableSet collection of of type CBRResult representing the search query results.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.