Trait/Object

org.locationtech.geomesa.index.api

IndexKeySpace

Related Docs: object IndexKeySpace | package api

Permalink

trait IndexKeySpace[T, U] extends AnyRef

Conversions to/from index keys

T

values extracted from a filter and used for creating ranges - extracted geometries, z-ranges, etc

U

a single key space index value, e.g. Long for a z-value, etc

Linear Supertypes
AnyRef, Any
Known Subclasses
AttributeIndexKeySpace, AttributeIndexKeySpaceV2, AttributeIndexKeySpaceV6, AttributeIndexKeySpaceV7, DateIndexKeySpace, IdIndexKeySpace, IdIndexKeySpaceV1, IdIndexKeySpaceV3, LegacyDateIndexKeySpace, S2IndexKeySpace, S3IndexKeySpace, XZ2IndexKeySpace, XZ2IndexKeySpaceV1, XZ3IndexKeySpace, XZ3IndexKeySpaceV1, Z2IndexKeySpace, Z2IndexKeySpaceV1, Z2IndexKeySpaceV2, Z2IndexKeySpaceV3, Z2IndexKeySpaceV4, Z3IndexKeySpace, Z3IndexKeySpaceV2, Z3IndexKeySpaceV3, Z3IndexKeySpaceV4, Z3IndexKeySpaceV5
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IndexKeySpace
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def attributes: Seq[String]

    Permalink

    The attributes used to create the index keys

  2. abstract def getIndexValues(filter: Filter, explain: Explainer): T

    Permalink

    Extracts values out of the filter used for range and push-down predicate creation

    Extracts values out of the filter used for range and push-down predicate creation

    filter

    query filter

    explain

    explainer

  3. abstract def getRangeBytes(ranges: Iterator[ScanRange[U]], tier: Boolean = false): Iterator[ByteRange]

    Permalink

    Creates bytes from ranges

    Creates bytes from ranges

    ranges

    typed scan ranges. @see getRanges

    tier

    will the ranges have tiered ranges appended, or not

  4. abstract def getRanges(values: T, multiplier: Int = 1): Iterator[ScanRange[U]]

    Permalink

    Creates ranges over the index keys

    Creates ranges over the index keys

    values

    index values @see getIndexValues

    multiplier

    hint for how many times the ranges will be multiplied. can be used to inform the number of ranges generated

  5. abstract def indexKeyByteLength: Either[(Array[Byte], Int, Int) ⇒ Int, Int]

    Permalink

    Length of an index key.

    Length of an index key. If static (general case), will return a Right with the length. If dynamic, will return Left with a function to determine the length from a given (row, offset, length)

  6. abstract def sft: SimpleFeatureType

    Permalink

    Simple feature type being indexed

  7. abstract def sharding: ShardStrategy

    Permalink

    Strategy for sharding

  8. abstract def sharing: Array[Byte]

    Permalink

    Table sharing

  9. abstract def toIndexKey(feature: WritableFeature, tier: Array[Byte], id: Array[Byte], lenient: Boolean = false): RowKeyValue[U]

    Permalink

    Index key from the attributes of a simple feature

    Index key from the attributes of a simple feature

    feature

    simple feature with cached values

    tier

    tier bytes

    id

    feature id bytes

    lenient

    if input values should be strictly checked, or normalized instead

  10. abstract def useFullFilter(values: Option[T], config: Option[GeoMesaDataStoreConfig], hints: Hints): Boolean

    Permalink

    Determines if the ranges generated by getRanges are sufficient to fulfill the query, or if additional filtering needs to be done

    Determines if the ranges generated by getRanges are sufficient to fulfill the query, or if additional filtering needs to be done

    values

    index values @see getIndexValues

    config

    data store config

    hints

    query hints

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped