DLESE Tools
v1.2

org.dlese.dpc.index
Interface LuceneIndex

All Known Implementing Classes:
SimpleLuceneIndex

public interface LuceneIndex


Field Summary
static int SIMPLE_ANALYSIS
           
static int STANDARD_ANALYSIS
           
static int STOP_ANALYSIS
           
static int WHITESPACE_ANALYSIS
           
 
Method Summary
 boolean addDoc(Document doc)
           
 boolean addDocs(Document[] docs)
           
 void create(String location, String defaultDocField, int analysisType)
           
 void create(String location, String defaultDocField, String[] stopWords, int analysisType)
           
 int getTermFrequency(String value)
           
 int getTermFrequency(String field, String value)
           
 Map getTermLists()
           
 List listDocs()
           
 List listDocs(String field, String value)
           
 List listFields()
           
 List listStopWords()
           
 List listTerms()
           
 int numDocs()
           
 int numDocs(String query)
           
 boolean removeDocs(String field, String value)
           
 boolean removeDocs(String field, String[] values)
           
 ResultDoc[] searchDocs(String query)
           
 ResultDoc[] searchDocs(String query, String defaultField)
           
 ResultDoc[] searchDocs(String query, String defaultField, Collector collector)
           
 ResultDoc[] searchDocs(String query, String defaultField, Filter filter)
           
 ResultDoc[] searchDocs(String query, String defaultField, Filter filter, Collector collector)
           
 boolean tryConfig(int AnalysisType, String defaultDocField, String[] stopWords, String indexReader)
           
 boolean update(String field, String[] values, Document[] docs)
           
 void use(String location)
           
 

Field Detail

STOP_ANALYSIS

public static final int STOP_ANALYSIS
See Also:
Constant Field Values

SIMPLE_ANALYSIS

public static final int SIMPLE_ANALYSIS
See Also:
Constant Field Values

STANDARD_ANALYSIS

public static final int STANDARD_ANALYSIS
See Also:
Constant Field Values

WHITESPACE_ANALYSIS

public static final int WHITESPACE_ANALYSIS
See Also:
Constant Field Values
Method Detail

use

public void use(String location)
         throws InvalidIndexException,
                IndexInitializationException
Throws:
InvalidIndexException
IndexInitializationException

create

public void create(String location,
                   String defaultDocField,
                   int analysisType)
            throws IndexInitializationException
Throws:
IndexInitializationException

create

public void create(String location,
                   String defaultDocField,
                   String[] stopWords,
                   int analysisType)
            throws IndexInitializationException
Throws:
IndexInitializationException

tryConfig

public boolean tryConfig(int AnalysisType,
                         String defaultDocField,
                         String[] stopWords,
                         String indexReader)

addDoc

public boolean addDoc(Document doc)

addDocs

public boolean addDocs(Document[] docs)

removeDocs

public boolean removeDocs(String field,
                          String value)

removeDocs

public boolean removeDocs(String field,
                          String[] values)

update

public boolean update(String field,
                      String[] values,
                      Document[] docs)

searchDocs

public ResultDoc[] searchDocs(String query)

searchDocs

public ResultDoc[] searchDocs(String query,
                              String defaultField)

searchDocs

public ResultDoc[] searchDocs(String query,
                              String defaultField,
                              Filter filter)

searchDocs

public ResultDoc[] searchDocs(String query,
                              String defaultField,
                              Collector collector)

searchDocs

public ResultDoc[] searchDocs(String query,
                              String defaultField,
                              Filter filter,
                              Collector collector)

numDocs

public int numDocs(String query)

numDocs

public int numDocs()

listDocs

public List listDocs()

listDocs

public List listDocs(String field,
                     String value)

listTerms

public List listTerms()

listFields

public List listFields()

getTermLists

public Map getTermLists()

listStopWords

public List listStopWords()

getTermFrequency

public int getTermFrequency(String value)

getTermFrequency

public int getTermFrequency(String field,
                            String value)

DLESE Tools
v1.2