nl.inl.blacklab.index

Class DocIndexerPlainTextBasic

java.lang.Object

nl.inl.blacklab.index.DocIndexer

nl.inl.blacklab.index.DocIndexerAbstract

nl.inl.blacklab.index.DocIndexerPlainTextBasic

All Implemented Interfaces:

AutoCloseable

public class DocIndexerPlainTextBasic
extends DocIndexerAbstract

Simple example indexer for plain text files. Reads a line, chops it into words to index and keeps track of word positions.

Field Summary

Fields inherited from class nl.inl.blacklab.index.DocIndexerAbstract

nDocumentsSkipped, reader, skippingCurrentDocument, wordsDone

Fields inherited from class nl.inl.blacklab.index.DocIndexer

currentLuceneDoc, documentName, docWriter, logger, MAX_DOCVALUES_LENGTH, metadataFieldValues, omitNorms, parameters

Constructor Summary

Constructors

Constructor and Description
DocIndexerPlainTextBasic(DocWriter indexer, String fileName, Reader reader)

Method Summary

Modifier and Type	Method and Description
AnnotationWriter	addAnnotation(String propName, AnnotationWriter.SensitivitySetting sensitivity)
AnnotatedFieldWriter	getContentsField()
AnnotationWriter	getMainAnnotation()
AnnotationWriter	getPropPunct()
int	getWordPosition() Returns the current word in the content.
void	index() Index documents contained in a file.

Methods inherited from class nl.inl.blacklab.index.DocIndexerAbstract

appendContent, appendContent, close, getCharacterPosition, getDescription, getDisplayName, isVisible, processContent, processContent, reportCharsProcessed, reportTokensProcessed, setDocument, startCaptureContent, storeCapturedContent, storePartCapturedContent

Methods inherited from class nl.inl.blacklab.index.DocIndexer

addMetadataField, addMetadataFieldsFromParameters, addMetadataToDocument, addNumericFields, addToForwardIndex, getCurrentLuceneDoc, getDocWriter, getMetadataField, getMetadataFieldTypeFromIndexerProperties, getParameter, getParameter, getParameter, getParameter, getSensitivitySetting, hasParameter, luceneTypeFromIndexMetadataType, optTranslateFieldName, setDocument, setDocument, setDocument, setDocumentName, setDocWriter, setOmitNorms, setParameter, setParameters, tokenizeField, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocIndexerPlainTextBasic

public DocIndexerPlainTextBasic(DocWriter indexer,
                                String fileName,
                                Reader reader)

Method Detail

getPropPunct

public AnnotationWriter getPropPunct()

getMainAnnotation

public AnnotationWriter getMainAnnotation()

getContentsField

public AnnotatedFieldWriter getContentsField()

getWordPosition

public int getWordPosition()

Returns the current word in the content. This is the position the next word will be stored at.

Returns:

the current word position

addAnnotation

public AnnotationWriter addAnnotation(String propName,
                                      AnnotationWriter.SensitivitySetting sensitivity)

index

public void index()
           throws IOException,
                  MalformedInputFile

Description copied from class: DocIndexer

Index documents contained in a file.

Specified by:

index in class DocIndexer

Throws:

IOException - if an I/O error occurred

MalformedInputFile - if the input file wasn't valid