Package org.fcrepo.search.api

Interface SearchIndex

public interface SearchIndex
An interface defining search index management operations
Author:
dbernstein

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addUpdateIndex(org.fcrepo.kernel.api.Transaction transaction, org.fcrepo.kernel.api.models.ResourceHeaders resourceHeaders)
    Adds or updates the index with the resource header information.
    void
    clearAllTransactions()
    Clear all transactions in the search index.
    void
    commitTransaction(org.fcrepo.kernel.api.Transaction tx)
    Commit the changes made in the transaction.
    SearchResult
    doSearch(SearchParameters parameters)
    Performs a search based on the parameters and returns the result.
    void
    removeFromIndex(org.fcrepo.kernel.api.Transaction transaction, org.fcrepo.kernel.api.identifiers.FedoraId fedoraId)
    Removes indexed fields associated with the specified Fedora ID
    void
    reset()
    Remove all persistent state associated with the index.
    void
    rollbackTransaction(org.fcrepo.kernel.api.Transaction tx)
    Rollback the changes in the transaction.

  • Method Details

    • addUpdateIndex

      void addUpdateIndex(org.fcrepo.kernel.api.Transaction transaction, org.fcrepo.kernel.api.models.ResourceHeaders resourceHeaders)
      Adds or updates the index with the resource header information.
      Parameters:
      transaction - The externally generated transaction.
      resourceHeaders - The resource headers associated with the resource

    • removeFromIndex

      void removeFromIndex(org.fcrepo.kernel.api.Transaction transaction, org.fcrepo.kernel.api.identifiers.FedoraId fedoraId)
      Removes indexed fields associated with the specified Fedora ID
      Parameters:
      transaction - The transaction
      fedoraId - The Fedora ID

    • doSearch

      SearchResult doSearch(SearchParameters parameters) throws InvalidQueryException
      Performs a search based on the parameters and returns the result.
      Parameters:
      parameters - The parameters defining the search
      Returns:
      The result of the search
      Throws:
      InvalidQueryException

    • reset

      void reset()
      Remove all persistent state associated with the index.

    • commitTransaction

      void commitTransaction(org.fcrepo.kernel.api.Transaction tx)
      Commit the changes made in the transaction.
      Parameters:
      tx - The transaction .

    • rollbackTransaction

      void rollbackTransaction(org.fcrepo.kernel.api.Transaction tx)
      Rollback the changes in the transaction.
      Parameters:
      tx - The transaction.

    • clearAllTransactions

      void clearAllTransactions()
      Clear all transactions in the search index.