Table of Contents

Class WKTSpatialIndexFieldValueType

Namespace
Examine.Lucene.Spatial.Indexing
Assembly
Examine.Lucene.Spatial.dll

WKT Spatial Index Field Value Type

public class WKTSpatialIndexFieldValueType : SpatialIndexFieldValueTypeBase, IIndexFieldValueType, ISpatialIndexFieldValueTypeBase, ISpatialIndexFieldValueTypeShapesBase
Inheritance
WKTSpatialIndexFieldValueType
Implements
Inherited Members

Constructors

WKTSpatialIndexFieldValueType(string, ILoggerFactory, Func<string, SpatialStrategy>, bool)

Constructor

public WKTSpatialIndexFieldValueType(string fieldName, ILoggerFactory loggerFactory, Func<string, SpatialStrategy> spatialStrategyFactory, bool stored = true)

Parameters

fieldName string
loggerFactory ILoggerFactory
spatialStrategyFactory Func<string, SpatialStrategy>

Given field name, return Spatial Strategy

stored bool

Properties

ExamineSpatialShapeFactory

Gets the Shape Factory for the fields spatial strategy

public override IExamineSpatialShapeFactory ExamineSpatialShapeFactory { get; }

Property Value

IExamineSpatialShapeFactory

Methods

AddSingleValue(Document, object)

Adds a single value to the document

protected override void AddSingleValue(Document doc, object value)

Parameters

doc Document
value object

GetFilter(string, ExamineSpatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape>)

Gets a spatial filer as a Lucene Filter

public override Filter GetFilter(string field, ExamineSpatialOperation spatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape> shape)

Parameters

field string
spatialOperation ExamineSpatialOperation
shape Func<IExamineSpatialShapeFactory, IExamineSpatialShape>

Returns

Filter

GetQuery(string)

By default returns a Lucene.Net.Search.TermQuery

public override Query GetQuery(string query)

Parameters

query string

Returns

Query

GetQuery(string, ExamineSpatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape>)

Gets a spatial query as a Lucene Query

public override Query GetQuery(string field, ExamineSpatialOperation spatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape> shape)

Parameters

field string
spatialOperation ExamineSpatialOperation
shape Func<IExamineSpatialShapeFactory, IExamineSpatialShape>

Returns

Query

ToSpatialDistanceSortField(SortableField, SortDirection)

Converts an Examine Spatial SortableField to a Lucene SortField

public override SortField ToSpatialDistanceSortField(SortableField sortableField, SortDirection sortDirection)

Parameters

sortableField SortableField
sortDirection SortDirection

Returns

SortField