Lucene.Net.Index.SortedTermVectorMapper Class Reference

Store a sorted collection of Lucene.Net.Index.TermVectorEntrys. Collects all term information into a single, SortedSet.
NOTE: This Mapper ignores all Field information for the Document. This means that if you are using offset/positions you will not know what Fields they correlate with.
This is not thread-safe More...

Inherits Lucene.Net.Index.TermVectorMapper.

Public Member Functions
	SortedTermVectorMapper (IComparer< TermVectorEntry > comparator)
	SortedTermVectorMapper (bool ignoringPositions, bool ignoringOffsets, IComparer< TermVectorEntry > comparator)
override void	Map (System.String term, int frequency, TermVectorOffsetInfo[] offsets, int[] positions)
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.

Public Attributes
const System.String	ALL = "_ALL_"
	Stand-in name for the field in TermVectorEntry.

Properties
virtual SortedSet < TermVectorEntry >	TermVectorEntrySet [get]
	The TermVectorEntrySet. A SortedSet of TermVectorEntry objects. Sort is by the comparator passed into the constructor. This set will be empty until after the mapping process takes place.
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

Store a sorted collection of Lucene.Net.Index.TermVectorEntrys. Collects all term information into a single, SortedSet.
NOTE: This Mapper ignores all Field information for the Document. This means that if you are using offset/positions you will not know what Fields they correlate with.
This is not thread-safe

Definition at line 33 of file SortedTermVectorMapper.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.SortedTermVectorMapper.SortedTermVectorMapper

(

IComparer< TermVectorEntry >

comparator

)

Parameters

comparator

A Comparator for sorting TermVectorEntrys

Definition at line 45 of file SortedTermVectorMapper.cs.

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

Definition at line 51 of file SortedTermVectorMapper.cs.

Member Function Documentation

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

virtual

Parameters

term	The term to map
frequency	The frequency of the term
offsets	Offset information, may be null
positions	Position information, may be null

Implements Lucene.Net.Index.TermVectorMapper.

Definition at line 67 of file SortedTermVectorMapper.cs.

override void Lucene.Net.Index.SortedTermVectorMapper.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 115 of file SortedTermVectorMapper.cs.

Member Data Documentation

const System.String Lucene.Net.Index.SortedTermVectorMapper.ALL = "_ALL_"

Stand-in name for the field in TermVectorEntry.

Definition at line 40 of file SortedTermVectorMapper.cs.

Property Documentation

virtual SortedSet<TermVectorEntry> Lucene.Net.Index.SortedTermVectorMapper.TermVectorEntrySet

get

The TermVectorEntrySet. A SortedSet of TermVectorEntry objects. Sort is by the comparator passed into the constructor.
This set will be empty until after the mapping process takes place.

The SortedSet of <see cref="TermVectorEntry" />.

Definition at line 129 of file SortedTermVectorMapper.cs.

---

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

• core/Index/SortedTermVectorMapper.cs