org.molgenis.search

Interface SearchService

public interface SearchService

Interface that a concrete SearchService must implement.

Author:

erwin

Method Summary

Methods

Modifier and Type	Method and Description
long	count(String documentType, List<QueryRule> queryRules) Get the total hit count
void	deleteDocumentByIds(String documentType, List<String> documentIds) delete documents by Ids
void	deleteDocumentsByType(String documentType) delete documentType from index
boolean	documentTypeExists(String documentType) Check if a type exists in the index
void	indexTupleTable(String documentType, TupleTable tupleTable) Index a TupleTable
SearchResult	search(SearchRequest request) Search the index
void	updateDocumentById(String documentType, String documentId, String updateScript) update document by Id
void	updateIndex(String documentType, Iterable<? extends Entity> entities) Insert or update entities in the index of a documentType

Method Detail

documentTypeExists

boolean documentTypeExists(String documentType)

Check if a type exists in the index

Parameters:

documentType -

Returns:

updateIndex

void updateIndex(String documentType,
               Iterable<? extends Entity> entities)

Insert or update entities in the index of a documentType

Parameters:

documentType -

entities -

deleteDocumentByIds

void deleteDocumentByIds(String documentType,
                       List<String> documentIds)

delete documents by Ids

Parameters:

documentType -

documentId -

updateDocumentById

void updateDocumentById(String documentType,
                      String documentId,
                      String updateScript)

update document by Id

Parameters:

documentType -

documentId -

updateScript -

indexTupleTable

void indexTupleTable(String documentType,
                   TupleTable tupleTable)

Index a TupleTable

Parameters:

documentType - , teh documentType name

tupleTable -

search

SearchResult search(SearchRequest request)

Search the index

Parameters:

request -

Returns:

count

long count(String documentType,
         List<QueryRule> queryRules)

Get the total hit count

Parameters:

documentType -

queryRules -

Returns:

deleteDocumentsByType

void deleteDocumentsByType(String documentType)

delete documentType from index

Parameters:

indexname -