Class SpatialPrefixTreeFactory

Abstract Factory for creating SpatialPrefixTree instances with useful defaults and passed on configurations defined in a System.Collections.Generic.IDictionary<TKey, TValue>.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
System.Object
SpatialPrefixTreeFactory
GeohashPrefixTreeFactory
QuadPrefixTreeFactory
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Spatial.Prefix.Tree
Assembly: Lucene.Net.Spatial.dll
Syntax
public abstract class SpatialPrefixTreeFactory

Fields

| Improve this Doc View Source

m_args

Declaration
protected IDictionary<string, string> m_args
Field Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>
| Improve this Doc View Source

m_ctx

Declaration
protected SpatialContext m_ctx
Field Value
Type Description
Spatial4n.Context.SpatialContext
| Improve this Doc View Source

m_maxLevels

Declaration
protected int? m_maxLevels
Field Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

MAX_DIST_ERR

Declaration
public const string MAX_DIST_ERR = "maxDistErr"
Field Value
Type Description
System.String
| Improve this Doc View Source

MAX_LEVELS

Declaration
public const string MAX_LEVELS = "maxLevels"
Field Value
Type Description
System.String
| Improve this Doc View Source

PREFIX_TREE

Declaration
public const string PREFIX_TREE = "prefixTree"
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

GetLevelForDistance(Double)

Calls GetLevelForDistance(Double).

Declaration
protected abstract int GetLevelForDistance(double degrees)
Parameters
Type Name Description
System.Double degrees
Returns
Type Description
System.Int32
| Improve this Doc View Source

Init(IDictionary<String, String>, SpatialContext)

Declaration
protected virtual void Init(IDictionary<string, string> args, SpatialContext ctx)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> args
Spatial4n.Context.SpatialContext ctx
| Improve this Doc View Source

InitMaxLevels()

Declaration
protected virtual void InitMaxLevels()
| Improve this Doc View Source

MakeSPT(IDictionary<String, String>, SpatialContext)

The factory is looked up via "prefixTree" in args, expecting "geohash" or "quad".

Declaration
public static SpatialPrefixTree MakeSPT(IDictionary<string, string> args, SpatialContext ctx)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> args
Spatial4n.Context.SpatialContext ctx
Returns
Type Description
SpatialPrefixTree
Remarks

The factory is looked up via "prefixTree" in args, expecting "geohash" or "quad". If its neither of these, then "geohash" is chosen for a geo context, otherwise "quad" is chosen.

Exceptions
Type Condition
System.ArgumentNullException

args or ctx is null.
| Improve this Doc View Source

MakeSPT(IDictionary<String, String>, Assembly, SpatialContext)

The factory is looked up via "prefixTree" in args, expecting "geohash" or "quad".

Declaration
public static SpatialPrefixTree MakeSPT(IDictionary<string, string> args, Assembly assembly, SpatialContext ctx)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> args
System.Reflection.Assembly assembly
Spatial4n.Context.SpatialContext ctx
Returns
Type Description
SpatialPrefixTree
Remarks

The factory is looked up via "prefixTree" in args, expecting "geohash" or "quad". If its neither of these, then "geohash" is chosen for a geo context, otherwise "quad" is chosen.

Exceptions
Type Condition
System.ArgumentNullException

args or ctx is null.
| Improve this Doc View Source

NewSPT()

Declaration
protected abstract SpatialPrefixTree NewSPT()
Returns
Type Description
SpatialPrefixTree