org.lexevs.dao.index.service.entity
Interface EntityIndexService

All Known Implementing Classes:
LuceneEntityIndexService

public interface EntityIndexService

The Interface EntityIndexService.

Author:
Kevin Peterson

Method Summary
 void addEntityToIndex(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, Entity entity)
           
 void createIndex(AbsoluteCodingSchemeVersionReference reference)
          Creates the index.
 void createIndex(AbsoluteCodingSchemeVersionReference reference, IndexCreator.EntityIndexerProgressCallback callback)
           
 void deleteEntityFromIndex(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, Entity entity)
           
 boolean doesIndexExist(AbsoluteCodingSchemeVersionReference reference)
           
 void dropIndex(AbsoluteCodingSchemeVersionReference reference)
          Drop index.
 org.apache.lucene.search.Filter getBoundaryDocsHitAsAWholeFilter(java.lang.String codingSchemeUri, java.lang.String version, org.apache.lucene.search.Query query)
           
 org.apache.lucene.search.Filter getCodingSchemeFilter(java.lang.String uri, java.lang.String internalVersionString)
           
 org.apache.lucene.document.Document getDocumentById(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, int id)
           
 org.apache.lucene.document.Document getDocumentFromCommonIndexById(java.util.List<AbsoluteCodingSchemeVersionReference> references, int id)
           
 java.lang.String getIndexName(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion)
           
 org.apache.lucene.search.Query getMatchAllDocsQuery(AbsoluteCodingSchemeVersionReference reference)
          Gets the match all docs query.
 void optimizeAll()
           
 void optimizeIndex(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion)
           
 java.util.List<org.apache.lucene.search.ScoreDoc> query(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, java.util.List<? extends org.apache.lucene.search.Query> combinedQueries, java.util.List<? extends org.apache.lucene.search.Query> individualQueries)
          Query.
 java.util.List<org.apache.lucene.search.ScoreDoc> query(java.lang.String codingSchemeUri, java.lang.String version, org.apache.lucene.search.Query query)
           
 java.util.List<org.apache.lucene.search.ScoreDoc> queryCommonIndex(java.util.List<AbsoluteCodingSchemeVersionReference> codingSchemes, org.apache.lucene.search.Query query)
           
 void updateIndexForEntity(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, Entity entity)
          Update index for entity.
 

Method Detail

updateIndexForEntity

void updateIndexForEntity(java.lang.String codingSchemeUri,
                          java.lang.String codingSchemeVersion,
                          Entity entity)
Update index for entity.

Parameters:
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version
entity - the entity

addEntityToIndex

void addEntityToIndex(java.lang.String codingSchemeUri,
                      java.lang.String codingSchemeVersion,
                      Entity entity)

getIndexName

java.lang.String getIndexName(java.lang.String codingSchemeUri,
                              java.lang.String codingSchemeVersion)

optimizeAll

void optimizeAll()

optimizeIndex

void optimizeIndex(java.lang.String codingSchemeUri,
                   java.lang.String codingSchemeVersion)

getDocumentById

org.apache.lucene.document.Document getDocumentById(java.lang.String codingSchemeUri,
                                                    java.lang.String codingSchemeVersion,
                                                    int id)

deleteEntityFromIndex

void deleteEntityFromIndex(java.lang.String codingSchemeUri,
                           java.lang.String codingSchemeVersion,
                           Entity entity)

createIndex

void createIndex(AbsoluteCodingSchemeVersionReference reference)
Creates the index.

Parameters:
reference - the reference

createIndex

void createIndex(AbsoluteCodingSchemeVersionReference reference,
                 IndexCreator.EntityIndexerProgressCallback callback)

dropIndex

void dropIndex(AbsoluteCodingSchemeVersionReference reference)
Drop index.

Parameters:
reference - the reference

doesIndexExist

boolean doesIndexExist(AbsoluteCodingSchemeVersionReference reference)

query

java.util.List<org.apache.lucene.search.ScoreDoc> query(java.lang.String codingSchemeUri,
                                                        java.lang.String codingSchemeVersion,
                                                        java.util.List<? extends org.apache.lucene.search.Query> combinedQueries,
                                                        java.util.List<? extends org.apache.lucene.search.Query> individualQueries)
Query.

Parameters:
reference - the reference
combinedQueries - the combined queries
individualQueries - the individual queries
Returns:
the list< score doc>

query

java.util.List<org.apache.lucene.search.ScoreDoc> query(java.lang.String codingSchemeUri,
                                                        java.lang.String version,
                                                        org.apache.lucene.search.Query query)

getMatchAllDocsQuery

org.apache.lucene.search.Query getMatchAllDocsQuery(AbsoluteCodingSchemeVersionReference reference)
Gets the match all docs query.

Parameters:
reference - the reference
Returns:
the match all docs query

getBoundaryDocsHitAsAWholeFilter

org.apache.lucene.search.Filter getBoundaryDocsHitAsAWholeFilter(java.lang.String codingSchemeUri,
                                                                 java.lang.String version,
                                                                 org.apache.lucene.search.Query query)

getDocumentFromCommonIndexById

org.apache.lucene.document.Document getDocumentFromCommonIndexById(java.util.List<AbsoluteCodingSchemeVersionReference> references,
                                                                   int id)

queryCommonIndex

java.util.List<org.apache.lucene.search.ScoreDoc> queryCommonIndex(java.util.List<AbsoluteCodingSchemeVersionReference> codingSchemes,
                                                                   org.apache.lucene.search.Query query)

getCodingSchemeFilter

org.apache.lucene.search.Filter getCodingSchemeFilter(java.lang.String uri,
                                                      java.lang.String internalVersionString)

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.