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

object

SpatialOperation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Spatial.Queries

Assembly: Lucene.Net.Spatial.dll

Syntax

public abstract class SpatialOperation

Constructors

SpatialOperation(string, bool, bool, bool)

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.

Declaration

protected SpatialOperation(string name, bool scoreIsMeaningful, bool sourceNeedsArea, bool targetNeedsArea)

Parameters

Type	Name	Description
string	name
bool	scoreIsMeaningful
bool	sourceNeedsArea
bool	targetNeedsArea

Fields

BBoxIntersects

Bounding box of the indexed shape.

Declaration

public static readonly SpatialOperation BBoxIntersects

Field Value

Type	Description
SpatialOperation

BBoxWithin

Bounding box of the indexed shape.

Declaration

public static readonly SpatialOperation BBoxWithin

Field Value

Type	Description
SpatialOperation

Contains

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.

Declaration

public static readonly SpatialOperation Contains

Field Value

Type	Description
SpatialOperation

Intersects

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.

Declaration

public static readonly SpatialOperation Intersects

Field Value

Type	Description
SpatialOperation

IsDisjointTo

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.

Declaration

public static readonly SpatialOperation IsDisjointTo

Field Value

Type	Description
SpatialOperation

IsEqualTo

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.

Declaration

public static readonly SpatialOperation IsEqualTo

Field Value

Type	Description
SpatialOperation

IsWithin

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.

Declaration

public static readonly SpatialOperation IsWithin

Field Value

Type	Description
SpatialOperation

Overlaps

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.

Declaration

public static readonly SpatialOperation Overlaps

Field Value

Type	Description
SpatialOperation

Properties

IsScoreMeaningful

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.

Declaration

public virtual bool IsScoreMeaningful { get; }

Property Value

Type	Description
bool

IsTargetNeedsArea

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.

Declaration

public virtual bool IsTargetNeedsArea { get; }

Property Value

Type	Description
bool

Name

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.

Declaration

public virtual string Name { get; }

Property Value

Type	Description
string

SourceNeedsArea

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.

Declaration

public virtual bool SourceNeedsArea { get; }

Property Value

Type	Description
bool

Values

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.

Declaration

public static IList<SpatialOperation> Values { get; }

Property Value

Type	Description
IList<SpatialOperation>

Methods

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
IShape	indexedShape
IShape	queryShape

Returns

Type	Description
bool

Exceptions

Type	Condition
ArgumentNullException	indexedShape or queryShape is null.

Get(string)

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.

Declaration

public static SpatialOperation Get(string v)

Parameters

Type	Name	Description
string	v

Returns

Type	Description
SpatialOperation

Is(SpatialOperation, params 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.

Declaration

public static bool Is(SpatialOperation op, params SpatialOperation[] tst)

Parameters

Type	Name	Description
SpatialOperation	op
SpatialOperation[]	tst

Returns

Type	Description
bool

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()