Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree Class Reference

A SpatialPrefixGrid based on Geohashes. Uses GeohashUtils to do all the geohash work. More...

Inherits Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.

Classes

class  Factory
 Factory for creating GeohashPrefixTree instances with useful defaults More...
 
class  GhCell
 

Public Member Functions

 GeohashPrefixTree (SpatialContext ctx, int maxLevels)
 
override int GetLevelForDistance (double dist)
 Returns the level of the largest grid in which its longest side is less than or equal to the provided distance (in degrees). Consequently dist acts as an error epsilon declaring the amount of detail needed in the grid, such that you can get a grid with just the right amount of precision.
 
override Node GetNode (string token)
 
override Node GetNode (byte[] bytes, int offset, int len)
 
override IList< NodeGetNodes (Shape shape, int detailLevel, bool inclParents)
 
- Public Member Functions inherited from Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree
SpatialContext GetSpatialContext ()
 
int GetMaxLevels ()
 
override String ToString ()
 
Node GetWorldNode ()
 
abstract Node GetNode (String token)
 
Node GetNode (string token, Node target)
 

Static Public Member Functions

static int GetMaxLevelsPossible ()
 Any more than this and there's no point (double lat and lon are the same).
 
- Static Public Member Functions inherited from Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree
static List< String > NodesToTokenStrings (Collection< Node > nodes)
 

Protected Member Functions

override Node GetNode (Point p, int level)
 
- Protected Member Functions inherited from Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree
 SpatialPrefixTree (SpatialContext ctx, int maxLevels)
 
virtual IList< NodeGetNodesAltPoint (Point p, int detailLevel, bool inclParents)
 

Additional Inherited Members

- Protected Attributes inherited from Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree
readonly int maxLevels
 

Detailed Description

A SpatialPrefixGrid based on Geohashes. Uses GeohashUtils to do all the geohash work.

Definition at line 29 of file GeohashPrefixTree.cs.

Constructor & Destructor Documentation

Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.GeohashPrefixTree ( SpatialContext  ctx,
int  maxLevels 
)

Definition at line 49 of file GeohashPrefixTree.cs.

Member Function Documentation

override int Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.GetLevelForDistance ( double  dist)
virtual

Returns the level of the largest grid in which its longest side is less than or equal to the provided distance (in degrees). Consequently dist acts as an error epsilon declaring the amount of detail needed in the grid, such that you can get a grid with just the right amount of precision.

Parameters
dist>= 0
Returns
level [1 to maxLevels]

Implements Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.

Definition at line 70 of file GeohashPrefixTree.cs.

static int Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.GetMaxLevelsPossible ( )
static

Any more than this and there's no point (double lat and lon are the same).

Returns

Definition at line 65 of file GeohashPrefixTree.cs.

override Node Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.GetNode ( Point  p,
int  level 
)
protectedvirtual

Reimplemented from Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.

Definition at line 78 of file GeohashPrefixTree.cs.

override Node Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.GetNode ( string  token)

Definition at line 83 of file GeohashPrefixTree.cs.

override Node Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.GetNode ( byte[]  bytes,
int  offset,
int  len 
)
virtual
override IList<Node> Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.GetNodes ( Shape  shape,
int  detailLevel,
bool  inclParents 
)
virtual

Reimplemented from Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.

Definition at line 93 of file GeohashPrefixTree.cs.


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