Package org.fcrepo.search.api
Interface SearchIndex
-
public interface SearchIndex
An interface defining search index management operations- Author:
- dbernstein
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddUpdateIndex(String dbTxId, org.fcrepo.kernel.api.models.ResourceHeaders resourceHeaders)Adds or updates the index with the resource header information.voidaddUpdateIndex(org.fcrepo.kernel.api.models.ResourceHeaders resourceHeaders)Adds or updates the index with the resource header information.SearchResultdoSearch(SearchParameters parameters)Performs a search based on the parameters and returns the result.voidremoveFromIndex(org.fcrepo.kernel.api.identifiers.FedoraId fedoraId)Removes indexed fields associated with the specified Fedora IDvoidreset()Remove all persistent state associated with the index.
-
-
-
Method Detail
-
addUpdateIndex
void addUpdateIndex(org.fcrepo.kernel.api.models.ResourceHeaders resourceHeaders)
Adds or updates the index with the resource header information.- Parameters:
resourceHeaders- The resource headers associated with the resource
-
addUpdateIndex
void addUpdateIndex(String dbTxId, org.fcrepo.kernel.api.models.ResourceHeaders resourceHeaders)
Adds or updates the index with the resource header information.- Parameters:
dbTxId- The database transaction idresourceHeaders- The resource headers associated with the resource
-
removeFromIndex
void removeFromIndex(org.fcrepo.kernel.api.identifiers.FedoraId fedoraId)
Removes indexed fields associated with the specified Fedora ID- Parameters:
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.
-
-