Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class DisjointSpatialFilter

    A Spatial Filter implementing IsDisjointTo in terms of a SpatialStrategy's support for Intersects. A document is considered disjoint if it has spatial data that does not intersect with the query shape. Another way of looking at this is that it's a way to invert a query shape.

    Note

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

    Inheritance
    object
    Filter
    DisjointSpatialFilter
    Inherited Members
    Filter.NewAnonymous(Func<AtomicReaderContext, IBits, DocIdSet>)
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Spatial
    Assembly: Lucene.Net.Spatial.dll
    Syntax
    public class DisjointSpatialFilter : Filter

    Constructors

    DisjointSpatialFilter(SpatialStrategy, SpatialArgs, string?)

    A Spatial Filter implementing IsDisjointTo in terms of a SpatialStrategy's support for Intersects. A document is considered disjoint if it has spatial data that does not intersect with the query shape. Another way of looking at this is that it's a way to invert a query shape.

    Note

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

    Declaration
    public DisjointSpatialFilter(SpatialStrategy strategy, SpatialArgs args, string? field)
    Parameters
    Type Name Description
    SpatialStrategy strategy

    Needed to compute intersects

    SpatialArgs args

    Used in spatial intersection

    string field

    This field is used to determine which docs have spatial data via GetDocsWithField(AtomicReader, string). Passing null will assume all docs have spatial data.

    Methods

    Equals(object?)

    Determines whether the specified object is equal to the current object.

    Declaration
    public override bool Equals(object? o)
    Parameters
    Type Name Description
    object o
    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)

    GetDocIdSet(AtomicReaderContext, IBits?)

    A Spatial Filter implementing IsDisjointTo in terms of a SpatialStrategy's support for Intersects. A document is considered disjoint if it has spatial data that does not intersect with the query shape. Another way of looking at this is that it's a way to invert a query shape.

    Note

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

    Declaration
    public override DocIdSet? GetDocIdSet(AtomicReaderContext context, IBits? acceptDocs)
    Parameters
    Type Name Description
    AtomicReaderContext context
    IBits acceptDocs
    Returns
    Type Description
    DocIdSet
    Overrides
    Lucene.Net.Search.Filter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext, Lucene.Net.Util.IBits)
    Exceptions
    Type Condition
    IOException

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()
    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.