Class SpatialPrefixTreeFactory

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

Note

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

Inheritance

object

SpatialPrefixTreeFactory

GeohashPrefixTreeFactory

QuadPrefixTreeFactory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Spatial.Prefix.Tree

Assembly: Lucene.Net.Spatial.dll

Syntax

public abstract class SpatialPrefixTreeFactory

Fields

MAX_DIST_ERR

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

Note

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

Declaration

public const string MAX_DIST_ERR = "maxDistErr"

Field Value

Type	Description
string

MAX_LEVELS

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

Note

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

Declaration

public const string MAX_LEVELS = "maxLevels"

Field Value

Type	Description
string

PREFIX_TREE

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

Note

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

Declaration

public const string PREFIX_TREE = "prefixTree"

Field Value

Type	Description
string

m_args

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

Note

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

Declaration

protected IDictionary<string, string>? m_args

Field Value

Type	Description
IDictionary<string, string>

m_ctx

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

Note

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

Declaration

protected SpatialContext? m_ctx

Field Value

Type	Description
SpatialContext

m_maxLevels

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

Note

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

Declaration

protected int? m_maxLevels

Field Value

Type	Description
int?

Methods

GetLevelForDistance(double)

Calls GetLevelForDistance(double).

Declaration

protected abstract int GetLevelForDistance(double degrees)

Parameters

Type	Name	Description
double	degrees

Returns

Type	Description
int

Init(IDictionary<string, string>, SpatialContext)

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

Note

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

Declaration

protected virtual void Init(IDictionary<string, string> args, SpatialContext ctx)

Parameters

Type	Name	Description
IDictionary<string, string>	args
SpatialContext	ctx

InitMaxLevels()

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

Note

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

Declaration

protected virtual void InitMaxLevels()

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
IDictionary<string, string>	args
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
ArgumentNullException	`args` or `ctx` is `null`.

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
IDictionary<string, string>	args
Assembly	assembly
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
ArgumentNullException	`args` or `ctx` is `null`.

NewSPT()

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

Note

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

Declaration

protected abstract SpatialPrefixTree NewSPT()

Returns

Type	Description
SpatialPrefixTree