Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Namespace Lucene.Net.Spatial.Queries

    Spatial Query options useful for client side requests

    Classes

    SpatialArgs

    Principally holds the query Spatial4n.Shapes.IShape and the SpatialOperation. It's used as an argument to some methods on SpatialStrategy.

    Note

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

    SpatialArgsParser

    Parses a string that usually looks like "OPERATION(SHAPE)" into a SpatialArgs object. The set of operations supported are defined in SpatialOperation, such as "Intersects" being a common one. The shape portion is defined by WKT Spatial4n.IO.WktShapeParser, but it can be overridden/customized via ParseShape(string, SpatialContext). There are some optional name-value pair parameters that follow the closing parenthesis. Example:

    Intersects(ENVELOPE(-10,-8,22,20)) distErrPct=0.025

    In the future it would be good to support something at least semi-standardized like a variant of [E]CQL.

    Note

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

    SpatialOperation

    A clause that compares a stored geometry to a supplied geometry. For more explanation of each operation, consider looking at the source implementation of Evaluate(IShape, IShape).

    See ESRIs docs on spatial relations

    Note

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

    UnsupportedSpatialOperationException

    Exception thrown when the SpatialStrategy cannot implement the requested operation.

    Note

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

    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.