Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextTermVectorsWriter

java.lang.Object

org.apache.lucene.codecs.TermVectorsWriter

org.apache.lucene.codecs.simpletext.SimpleTextTermVectorsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable

public class SimpleTextTermVectorsWriter
extends TermVectorsWriter

Writes plain-text term vectors.

FOR RECREATIONAL USE ONLY

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final BytesRef	DOC
(package private) static final BytesRef	END
(package private) static final BytesRef	ENDOFFSET
(package private) static final BytesRef	FIELD
(package private) static final BytesRef	FIELDNAME
(package private) static final BytesRef	FIELDOFFSETS
(package private) static final BytesRef	FIELDPAYLOADS
(package private) static final BytesRef	FIELDPOSITIONS
(package private) static final BytesRef	FIELDTERMCOUNT
private int	numDocsWritten
(package private) static final BytesRef	NUMFIELDS
private boolean	offsets
private IndexOutput	out
(package private) static final BytesRef	PAYLOAD
private boolean	payloads
(package private) static final BytesRef	POSITION
private boolean	positions
private final BytesRefBuilder	scratch
(package private) static final BytesRef	STARTOFFSET
(package private) static final BytesRef	TERMFREQ
(package private) static final BytesRef	TERMTEXT
(package private) static final String	VECTORS_EXTENSION

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
SimpleTextTermVectorsWriter(Directory directory, String segment, IOContext context)

Method Summary

Modifier and Type	Method	Description
void	addPosition(int position, int startOffset, int endOffset, BytesRef payload)	Adds a term position and offsets
void	close()
void	finish(int numDocs)	Called before TermVectorsWriter.close(), passing in the number of documents that were written.
private void	newLine()
long	ramBytesUsed()	Return the memory usage of this object in bytes.
void	startDocument(int numVectorFields)	Called before writing the term vectors of the document.
void	startField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads)	Called before writing the terms of the field.
void	startTerm(BytesRef term, int freq)	Adds a term and its term frequency freq.
private void	write(String s)
private void	write(BytesRef bytes)

Methods inherited from class org.apache.lucene.codecs.TermVectorsWriter

addAllDocVectors, addProx, finishDocument, finishField, finishTerm, merge

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Details

END

static final BytesRef END

DOC

static final BytesRef DOC

NUMFIELDS

static final BytesRef NUMFIELDS

FIELD

static final BytesRef FIELD

FIELDNAME

static final BytesRef FIELDNAME

FIELDPOSITIONS

static final BytesRef FIELDPOSITIONS

FIELDOFFSETS

static final BytesRef FIELDOFFSETS

FIELDPAYLOADS

static final BytesRef FIELDPAYLOADS

FIELDTERMCOUNT

static final BytesRef FIELDTERMCOUNT

TERMTEXT

static final BytesRef TERMTEXT

TERMFREQ

static final BytesRef TERMFREQ

POSITION

static final BytesRef POSITION

PAYLOAD

static final BytesRef PAYLOAD

STARTOFFSET

static final BytesRef STARTOFFSET

ENDOFFSET

static final BytesRef ENDOFFSET

VECTORS_EXTENSION

static final String VECTORS_EXTENSION

See Also:

• Constant Field Values

out

private IndexOutput out

numDocsWritten

private int numDocsWritten

scratch

private final BytesRefBuilder scratch

offsets

private boolean offsets

positions

private boolean positions

payloads

private boolean payloads

Constructor Details

SimpleTextTermVectorsWriter

public SimpleTextTermVectorsWriter(Directory directory,
 String segment,
 IOContext context)
                            throws IOException

Throws:

IOException

Method Details

startDocument

public void startDocument(int numVectorFields)
                   throws IOException

Description copied from class: TermVectorsWriter

Called before writing the term vectors of the document. TermVectorsWriter.startField(FieldInfo, int, boolean, boolean, boolean) will be called numVectorFields times. Note that if term vectors are enabled, this is called even if the document has no vector fields, in this case numVectorFields will be zero.

Specified by:

startDocument in class TermVectorsWriter

Throws:

IOException

startField

public void startField(FieldInfo info,
 int numTerms,
 boolean positions,
 boolean offsets,
 boolean payloads)
                throws IOException

Description copied from class: TermVectorsWriter

Called before writing the terms of the field. TermVectorsWriter.startTerm(BytesRef, int) will be called numTerms times.

Specified by:

startField in class TermVectorsWriter

Throws:

IOException

startTerm

public void startTerm(BytesRef term,
 int freq)
               throws IOException

Description copied from class: TermVectorsWriter

Adds a term and its term frequency freq. If this field has positions and/or offsets enabled, then TermVectorsWriter.addPosition(int, int, int, BytesRef) will be called freq times respectively.

Specified by:

startTerm in class TermVectorsWriter

Throws:

IOException

addPosition

public void addPosition(int position,
 int startOffset,
 int endOffset,
 BytesRef payload)
                 throws IOException

Description copied from class: TermVectorsWriter

Adds a term position and offsets

Specified by:

addPosition in class TermVectorsWriter

Throws:

IOException

finish

public void finish(int numDocs)
            throws IOException

Description copied from class: TermVectorsWriter

Called before TermVectorsWriter.close(), passing in the number of documents that were written. Note that this is intentionally redundant (equivalent to the number of calls to TermVectorsWriter.startDocument(int), but a Codec should check that this is the case to detect the JRE bug described in LUCENE-1282.

Specified by:

finish in class TermVectorsWriter

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class TermVectorsWriter

Throws:

IOException

write

private void write(String s)
            throws IOException

Throws:

IOException

write

private void write(BytesRef bytes)
            throws IOException

Throws:

IOException

newLine

private void newLine()
              throws IOException

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.