Textractor API textractor-720 (20091120123250)

textractor.mg4j.index
Class IndexerOptions

java.lang.Object
  extended by textractor.mg4j.index.IndexerOptions
Direct Known Subclasses:
DBIndexerOptions

public class IndexerOptions
extends Object

IndexerOptions.


Nested Class Summary
static class IndexerOptions.StemmerChoice
           
 
Field Summary
static String FILTER_ACRONYM
           
static String FILTER_NONE
           
 
Constructor Summary
IndexerOptions()
          Create a indexer options with a default Word Reader.
 
Method Summary
 void createSkips(int quantumVal, int heightVal)
          Call this method to create a skip index.
 String getBasename()
           
 String getBatchSize()
           
 int getChunkSize()
           
 Map<CompressionFlags.Component,CompressionFlags.Coding> getCompressionFlags()
           
 String getFilter()
           
static String getFilterAcronym()
           
static String getFilterNone()
           
 int getHeight()
           
 int getMinimumDashSplitLength()
           
 int getQuantum()
           
 IndexerOptions.StemmerChoice getStemmer()
           
 TermProcessor getTermProcessor()
           
 String getTermProcessorClassName()
           
 TextractorWordReader getWordReader()
           
 String getZipDocumentCollectionName()
           
 boolean isCreateSkips()
           
 boolean isLowercaseIndex()
           
 boolean isParenthesesAreWords()
           
 void setBasename(String basename)
           
 void setBatchSize(String batchSize)
           
 void setChunkSize(int chunkSize)
           
 void setCompressionFlags(Map<CompressionFlags.Component,CompressionFlags.Coding> compressionFlags)
           
 void setCreateSkips(boolean createSkips)
           
 void setFilter(String filter)
           
 void setHeight(int height)
           
 void setMinimumDashSplitLength(int minimumDashSplitLength)
           
 void setParenthesesAreWords(boolean parenthesesAreWords)
          Choose if parentheses should be indexed as words.
 void setQuantum(int quantum)
           
 void setStemmerChoice(IndexerOptions.StemmerChoice stemmerVal)
           
 void setStemmerChoice(String stemmerChoice)
           
 void setTermProcessor(TermProcessor termProcessor)
           
 void setTermProcessorClassName(String termProcessorClassName)
           
 void setWordReader(TextractorWordReader wordReader)
           
 void setWordReaderClassName(String wordReaderClassName)
           
 void setZipDocumentCollectionName(String name)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FILTER_NONE

public static final String FILTER_NONE
See Also:
Constant Field Values

FILTER_ACRONYM

public static final String FILTER_ACRONYM
See Also:
Constant Field Values
Constructor Detail

IndexerOptions

public IndexerOptions()
Create a indexer options with a default Word Reader.

Method Detail

setTermProcessorClassName

public void setTermProcessorClassName(String termProcessorClassName)

setWordReaderClassName

public void setWordReaderClassName(String wordReaderClassName)

createSkips

public final void createSkips(int quantumVal,
                              int heightVal)
Call this method to create a skip index. Skip indices have an embedded skip structure. The skip structure optimizes conjunctive queries.

Parameters:
quantumVal - Quantum for skip index.
heightVal - Maximum height of towers for skip index.

getWordReader

public final TextractorWordReader getWordReader()

setWordReader

public final void setWordReader(TextractorWordReader wordReader)

getBasename

public final String getBasename()

setBasename

public final void setBasename(String basename)

isLowercaseIndex

public final boolean isLowercaseIndex()

getTermProcessorClassName

public final String getTermProcessorClassName()

getFilter

public final String getFilter()

setFilter

public final void setFilter(String filter)

setParenthesesAreWords

public final void setParenthesesAreWords(boolean parenthesesAreWords)
Choose if parentheses should be indexed as words.

Parameters:
parenthesesAreWords - True if the index should be built with parentheses indexed as words.

setBatchSize

public final void setBatchSize(String batchSize)

getChunkSize

public final int getChunkSize()

setChunkSize

public final void setChunkSize(int chunkSize)

getFilterNone

public static String getFilterNone()

getFilterAcronym

public static String getFilterAcronym()

isCreateSkips

public final boolean isCreateSkips()

setCreateSkips

public final void setCreateSkips(boolean createSkips)

getQuantum

public final int getQuantum()

setQuantum

public final void setQuantum(int quantum)

getHeight

public final int getHeight()

setHeight

public final void setHeight(int height)

isParenthesesAreWords

public final boolean isParenthesesAreWords()

getBatchSize

public final String getBatchSize()

setTermProcessor

public void setTermProcessor(TermProcessor termProcessor)

getTermProcessor

public TermProcessor getTermProcessor()

getCompressionFlags

public final Map<CompressionFlags.Component,CompressionFlags.Coding> getCompressionFlags()

setCompressionFlags

public final void setCompressionFlags(Map<CompressionFlags.Component,CompressionFlags.Coding> compressionFlags)

getMinimumDashSplitLength

public final int getMinimumDashSplitLength()

setMinimumDashSplitLength

public final void setMinimumDashSplitLength(int minimumDashSplitLength)

getZipDocumentCollectionName

public final String getZipDocumentCollectionName()

setZipDocumentCollectionName

public final void setZipDocumentCollectionName(String name)

setStemmerChoice

public void setStemmerChoice(String stemmerChoice)

setStemmerChoice

public void setStemmerChoice(IndexerOptions.StemmerChoice stemmerVal)

getStemmer

public IndexerOptions.StemmerChoice getStemmer()

Textractor API textractor-720 (20091120123250)

Copyright © 2003-2008 Institute for Computational Biomedicine, All Rights Reserved.