Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Classes | Public Member Functions | Properties | List of all members
Lucene.Net.Index.PositionBasedTermVectorMapper Class Reference

For each Field, store position by position information. It ignores frequency information This is not thread-safe. More...

Inherits Lucene.Net.Index.TermVectorMapper.

Classes

class  TVPositionInfo
 Container for a term at a position More...
 

Public Member Functions

 PositionBasedTermVectorMapper ()
 
 PositionBasedTermVectorMapper (bool ignoringOffsets)
 
override void Map (System.String term, int frequency, TermVectorOffsetInfo[] offsets, int[] positions)
 Callback for the TermVectorReader.
 
override void SetExpectations (System.String field, int numTerms, bool storeOffsets, bool storePositions)
 Callback mechanism used by the TermVectorReader
 
- 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.
 

Properties

override bool IsIgnoringPositions [get]
 Never ignores positions. This mapper doesn't make much sense unless there are positions
 
virtual IDictionary< string,
IDictionary< int,
TVPositionInfo > > 
FieldToTerms [get]
 Get the mapping between fields and terms, sorted by the comparator
 
- 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

For each Field, store position by position information. It ignores frequency information

This is not thread-safe.

Definition at line 29 of file PositionBasedTermVectorMapper.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.PositionBasedTermVectorMapper.PositionBasedTermVectorMapper ( )

Definition at line 38 of file PositionBasedTermVectorMapper.cs.

Lucene.Net.Index.PositionBasedTermVectorMapper.PositionBasedTermVectorMapper ( bool  ignoringOffsets)

Definition at line 42 of file PositionBasedTermVectorMapper.cs.

Member Function Documentation

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

Callback for the TermVectorReader.

Parameters
term
frequency
offsets
positions

Implements Lucene.Net.Index.TermVectorMapper.

Definition at line 62 of file PositionBasedTermVectorMapper.cs.

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

Callback mechanism used by the TermVectorReader

Parameters
fieldThe field being read
numTermsThe number of terms in the vector
storeOffsetsWhether offsets are available
storePositionsWhether positions are available

Implements Lucene.Net.Index.TermVectorMapper.

Definition at line 86 of file PositionBasedTermVectorMapper.cs.

Property Documentation

virtual IDictionary<string, IDictionary<int, TVPositionInfo> > Lucene.Net.Index.PositionBasedTermVectorMapper.FieldToTerms
get

Get the mapping between fields and terms, sorted by the comparator

A map between field names and a Map. The sub-Map key is the position as the integer, the value is <see cref="Lucene.Net.Index.PositionBasedTermVectorMapper.TVPositionInfo" />.

Definition at line 108 of file PositionBasedTermVectorMapper.cs.

override bool Lucene.Net.Index.PositionBasedTermVectorMapper.IsIgnoringPositions
get

Never ignores positions. This mapper doesn't make much sense unless there are positions

false

Definition at line 49 of file PositionBasedTermVectorMapper.cs.


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