Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Index.ParallelArrayTermVectorMapper Class Reference

Models the existing parallel array structure More...

Inherits Lucene.Net.Index.TermVectorMapper.

Public Member Functions

override void SetExpectations (System.String field, int numTerms, bool storeOffsets, bool storePositions)
 Tell the mapper what to expect in regards to field, number of terms, offset and position storage. This method will be called once before retrieving the vector for a field.
 
override void Map (System.String term, int frequency, TermVectorOffsetInfo[] offsets, int[] positions)
 Map the Term Vector information into your own structure
 
virtual ITermFreqVector MaterializeVector ()
 Construct the vector
 
- Public Member Functions inherited from Lucene.Net.Index.TermVectorMapper
virtual void SetDocumentNumber (int documentNumber)
 Passes down the index of the document whose term vector is currently being mapped, once for each top level call to a term vector reader. Default implementation IGNORES the document number. Override if your implementation needs the document number. NOTE: Document numbers are internal to Lucene and subject to change depending on indexing operations.
 

Additional Inherited Members

- Properties inherited from Lucene.Net.Index.TermVectorMapper
virtual bool IsIgnoringPositions [get]
 Indicate to Lucene that even if there are positions stored, this mapper is not interested in them and they can be skipped over. Derived classes should set this to true if they want to ignore positions. The default is false, meaning positions will be loaded if they are stored.
 
virtual bool IsIgnoringOffsets [get]
 
 

Detailed Description

Models the existing parallel array structure

Definition at line 671 of file TermVectorsReader.cs.

Member Function Documentation

override void Lucene.Net.Index.ParallelArrayTermVectorMapper.Map ( System.String  term,
int  frequency,
TermVectorOffsetInfo[]  offsets,
int[]  positions 
)
virtual

Map the Term Vector information into your own structure

Parameters
termThe term to add to the vector
frequencyThe frequency of the term in the document
offsetsnull if the offset is not specified, otherwise the offset into the field of the term
positionsnull if the position is not specified, otherwise the position in the field of the term

Implements Lucene.Net.Index.TermVectorMapper.

Definition at line 696 of file TermVectorsReader.cs.

virtual ITermFreqVector Lucene.Net.Index.ParallelArrayTermVectorMapper.MaterializeVector ( )
virtual

Construct the vector

Returns
The ITermFreqVector based on the mappings.

Definition at line 714 of file TermVectorsReader.cs.

override void Lucene.Net.Index.ParallelArrayTermVectorMapper.SetExpectations ( System.String  field,
int  numTerms,
bool  storeOffsets,
bool  storePositions 
)
virtual

Tell the mapper what to expect in regards to field, number of terms, offset and position storage. This method will be called once before retrieving the vector for a field.

This method will be called before Map(String,int,TermVectorOffsetInfo[],int[]).

Parameters
fieldThe field the vector is for
numTermsThe number of terms that need to be mapped
storeOffsetstrue if the mapper should expect offset information
storePositionstrue if the mapper should expect positions info

Implements Lucene.Net.Index.TermVectorMapper.

Definition at line 683 of file TermVectorsReader.cs.


The documentation for this class was generated from the following file: