Class 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.

Inheritance
System.Object
SpatialOperation
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)
Namespace: Lucene.Net.Spatial.Queries
Assembly: Lucene.Net.Spatial.dll
Syntax
public abstract class SpatialOperation

Constructors

| Improve this Doc View Source

SpatialOperation(String, Boolean, Boolean, Boolean)

Declaration
protected SpatialOperation(string name, bool scoreIsMeaningful, bool sourceNeedsArea, bool targetNeedsArea)
Parameters
Type Name Description
System.String name
System.Boolean scoreIsMeaningful
System.Boolean sourceNeedsArea
System.Boolean targetNeedsArea

Fields

| Improve this Doc View Source

BBoxIntersects

Bounding box of the indexed shape.

Declaration
public static readonly SpatialOperation BBoxIntersects
Field Value
Type Description
SpatialOperation
| Improve this Doc View Source

BBoxWithin

Bounding box of the indexed shape.

Declaration
public static readonly SpatialOperation BBoxWithin
Field Value
Type Description
SpatialOperation
| Improve this Doc View Source

Contains

Declaration
public static readonly SpatialOperation Contains
Field Value
Type Description
SpatialOperation
| Improve this Doc View Source

Intersects

Declaration
public static readonly SpatialOperation Intersects
Field Value
Type Description
SpatialOperation
| Improve this Doc View Source

IsDisjointTo

Declaration
public static readonly SpatialOperation IsDisjointTo
Field Value
Type Description
SpatialOperation
| Improve this Doc View Source

IsEqualTo

Declaration
public static readonly SpatialOperation IsEqualTo
Field Value
Type Description
SpatialOperation
| Improve this Doc View Source

IsWithin

Declaration
public static readonly SpatialOperation IsWithin
Field Value
Type Description
SpatialOperation
| Improve this Doc View Source

Overlaps

Declaration
public static readonly SpatialOperation Overlaps
Field Value
Type Description
SpatialOperation

Properties

| Improve this Doc View Source

IsScoreMeaningful

Declaration
public virtual bool IsScoreMeaningful { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTargetNeedsArea

Declaration
public virtual bool IsTargetNeedsArea { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Name

Declaration
public virtual string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SourceNeedsArea

Declaration
public virtual bool SourceNeedsArea { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Values

Declaration
public static IList<SpatialOperation> Values { get; }
Property Value
Type Description
System.Collections.Generic.IList<SpatialOperation>

Methods

| Improve this Doc View Source

Evaluate(IShape, IShape)

Returns whether the relationship between indexedShape and queryShape is satisfied by this operation.

Declaration
public abstract bool Evaluate(IShape indexedShape, IShape queryShape)
Parameters
Type Name Description
Spatial4n.Shapes.IShape indexedShape
Spatial4n.Shapes.IShape queryShape
Returns
Type Description
System.Boolean
Exceptions
Type Condition
System.ArgumentNullException

indexedShape or queryShape is null.
| Improve this Doc View Source

Get(String)

Declaration
public static SpatialOperation Get(string v)
Parameters
Type Name Description
System.String v
Returns
Type Description
SpatialOperation
| Improve this Doc View Source

Is(SpatialOperation, SpatialOperation[])

Declaration
public static bool Is(SpatialOperation op, params SpatialOperation[] tst)
Parameters
Type Name Description
SpatialOperation op
SpatialOperation[] tst
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()