Lucene.Net.Index.FieldSortedTermVectorMapper Class Reference

For each Field, store a sorted collection of TermVectorEntrys This is not thread-safe. More...

Inherits Lucene.Net.Index.TermVectorMapper.

Public Member Functions
	FieldSortedTermVectorMapper (IComparer< TermVectorEntry > comparator)
	FieldSortedTermVectorMapper (bool ignoringPositions, bool ignoringOffsets, IComparer< TermVectorEntry > comparator)
override void	Map (System.String term, int frequency, TermVectorOffsetInfo[] offsets, int[] positions)
	Map the Term Vector information into your own structure
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.
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
virtual IDictionary< string, SortedSet< TermVectorEntry > >	FieldToTerms [get]
	Get the mapping between fields and terms, sorted by the comparator
virtual IComparer < TermVectorEntry >	Comparator [get]
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 a sorted collection of TermVectorEntrys

This is not thread-safe.

Definition at line 28 of file FieldSortedTermVectorMapper.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.FieldSortedTermVectorMapper.FieldSortedTermVectorMapper

(

IComparer< TermVectorEntry >

comparator

)

Parameters

comparator

A Comparator for sorting TermVectorEntrys

Definition at line 38 of file FieldSortedTermVectorMapper.cs.

Lucene.Net.Index.FieldSortedTermVectorMapper.FieldSortedTermVectorMapper	(	bool	ignoringPositions,
		bool	ignoringOffsets,
		IComparer< TermVectorEntry >	comparator
	)

Definition at line 44 of file FieldSortedTermVectorMapper.cs.

Member Function Documentation

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

virtual

Map the Term Vector information into your own structure

Parameters

term	The term to add to the vector
frequency	The frequency of the term in the document
offsets	null if the offset is not specified, otherwise the offset into the field of the term
positions	null if the position is not specified, otherwise the position in the field of the term

Implements Lucene.Net.Index.TermVectorMapper.

Definition at line 50 of file FieldSortedTermVectorMapper.cs.

override void Lucene.Net.Index.FieldSortedTermVectorMapper.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

field	The field the vector is for
numTerms	The number of terms that need to be mapped
storeOffsets	true if the mapper should expect offset information
storePositions	true if the mapper should expect positions info

Implements Lucene.Net.Index.TermVectorMapper.

Definition at line 56 of file FieldSortedTermVectorMapper.cs.

Property Documentation

virtual IComparer<TermVectorEntry> Lucene.Net.Index.FieldSortedTermVectorMapper.Comparator

get

Definition at line 74 of file FieldSortedTermVectorMapper.cs.

virtual IDictionary<string, SortedSet<TermVectorEntry> > Lucene.Net.Index.FieldSortedTermVectorMapper.FieldToTerms

get

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

A map between field names and <see cref="System.Collections.Generic.SortedDictionary{Object,Object}" />s per field. SortedSet entries are <see cref="TermVectorEntry" />

Definition at line 68 of file FieldSortedTermVectorMapper.cs.

---

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

• core/Index/FieldSortedTermVectorMapper.cs