org.lexevs.dao.index.connection
Class IndexInterface

java.lang.Object
  extended by org.lexevs.dao.index.connection.IndexInterface

public class IndexInterface
extends java.lang.Object

This classes manages the interactions with a single lucene index directory.

Version:
subversion $Revision: $ checked in on $Date: $
Author:
Dan Armbrust, Jesse Erdmann, Kevin Peterson

Constructor Summary
IndexInterface(IndexerService service)
          Instantiates a new index interface.
IndexInterface(java.lang.String location)
          Instantiates a new index interface.
 
Method Summary
 void close()
          Close.
 void deleteIndex(java.lang.String internalCodeSystemName, java.lang.String internalVersionString)
          Delete index.
 IndexerService getBaseIndexerService()
          Gets the base indexer service.
 org.apache.lucene.search.DocIdSetIterator getBoundaryDocumentIterator(java.lang.String internalCodeSystemName, java.lang.String internalVersionString)
          Gets the boundary document iterator.
 org.apache.lucene.search.Filter getCodeBoundryFilter()
          Gets the code boundry filter.
 java.util.ArrayList<java.lang.String> getCodeSystemKeys()
          Gets the code system keys.
 java.lang.String getIndexLocation(java.lang.String internalCodeSystemName, java.lang.String internalVersionString)
          Gets the index location.
 LuceneIndexReader getIndexReader(java.lang.String internalCodeSystemName, java.lang.String internalVersionString)
          Gets the index reader.
protected  LgLoggerIF getLogger()
          Gets the logger.
 LuceneIndexReader getMetaDataIndexReader()
          Gets the meta data index reader.
 SearchServiceInterface getMetaDataSearcher()
          Gets the meta data searcher.
 java.lang.String getMetaLocation()
          Gets the meta location.
 SearchServiceInterface getSearcher(java.lang.String internalCodeSystemName, java.lang.String internalVersionString)
          Gets the searcher.
 void initCodingSchemes()
          Inits the coding schemes.
 void reopenIndex(java.lang.String internalCodeSystemName, java.lang.String internalVersionString)
          Reopen index.
 void reopenMetaDataIndexReader()
          Reopen meta data index reader.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexInterface

public IndexInterface(IndexerService service)
Instantiates a new index interface.

Parameters:
service - the service

IndexInterface

public IndexInterface(java.lang.String location)
Instantiates a new index interface.

Parameters:
location - the location
Method Detail

getLogger

protected LgLoggerIF getLogger()
Gets the logger.

Returns:
the logger

initCodingSchemes

public void initCodingSchemes()
                       throws LBInvocationException
Inits the coding schemes.

Throws:
LBInvocationException - the LB invocation exception

getCodeBoundryFilter

public org.apache.lucene.search.Filter getCodeBoundryFilter()
Gets the code boundry filter.

Returns:
the code boundry filter

getCodeSystemKeys

public java.util.ArrayList<java.lang.String> getCodeSystemKeys()
Gets the code system keys.

Returns:
the code system keys

getBoundaryDocumentIterator

public org.apache.lucene.search.DocIdSetIterator getBoundaryDocumentIterator(java.lang.String internalCodeSystemName,
                                                                             java.lang.String internalVersionString)
Gets the boundary document iterator.

Parameters:
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string
Returns:
the boundary document iterator

getIndexReader

public LuceneIndexReader getIndexReader(java.lang.String internalCodeSystemName,
                                        java.lang.String internalVersionString)
Gets the index reader.

Parameters:
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string
Returns:
the index reader

reopenMetaDataIndexReader

public void reopenMetaDataIndexReader()
Reopen meta data index reader.


getMetaDataIndexReader

public LuceneIndexReader getMetaDataIndexReader()
Gets the meta data index reader.

Returns:
the meta data index reader

reopenIndex

public void reopenIndex(java.lang.String internalCodeSystemName,
                        java.lang.String internalVersionString)
                 throws LBInvocationException
Reopen index.

Parameters:
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string
Throws:
LBInvocationException - the LB invocation exception

getSearcher

public SearchServiceInterface getSearcher(java.lang.String internalCodeSystemName,
                                          java.lang.String internalVersionString)
Gets the searcher.

Parameters:
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string
Returns:
the searcher

getMetaDataSearcher

public SearchServiceInterface getMetaDataSearcher()
Gets the meta data searcher.

Returns:
the meta data searcher

deleteIndex

public void deleteIndex(java.lang.String internalCodeSystemName,
                        java.lang.String internalVersionString)
                 throws InternalException
Delete index.

Parameters:
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string
Throws:
InternalException - the internal exception

getMetaLocation

public java.lang.String getMetaLocation()
Gets the meta location.

Returns:
the meta location

getBaseIndexerService

public IndexerService getBaseIndexerService()
Gets the base indexer service.

Returns:
the base indexer service

getIndexLocation

public java.lang.String getIndexLocation(java.lang.String internalCodeSystemName,
                                         java.lang.String internalVersionString)
Gets the index location.

Parameters:
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string
Returns:
the index location

close

public void close()
Close.


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.