Packages

class AttributeIndexKeySpace extends IndexKeySpace[AttributeIndexValues[Any], AttributeIndexKey] with LazyLogging

Attribute index key

Linear Supertypes
LazyLogging, IndexKeySpace[AttributeIndexValues[Any], AttributeIndexKey], AnyRef, Any
Known Subclasses
AttributeIndexKeySpaceV2, AttributeIndexKeySpaceV6, AttributeIndexKeySpaceV7
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AttributeIndexKeySpace
  2. LazyLogging
  3. IndexKeySpace
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AttributeIndexKeySpace(sft: SimpleFeatureType, sharding: ShardStrategy, attributeField: String)

    sft

    simple feature type

    attributeField

    attribute being indexed

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val attributes: Seq[String]

    The attributes used to create the index keys

    The attributes used to create the index keys

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def decodeRowValue(row: Array[Byte], offset: Int, length: Int): Try[AnyRef]

    Decodes an attribute value out of row string

    Decodes an attribute value out of row string

    row

    row bytes

    offset

    offset into the row bytes

    length

    length of the row bytes, from the offset

  8. val decodeValue: (String) ⇒ AnyRef
    Attributes
    protected
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. val fieldIndex: Int
    Attributes
    protected
  12. val fieldIndexShort: Short
    Attributes
    protected
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def getIndexValues(filter: Filter, explain: Explainer): AttributeIndexValues[Any]

    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

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  15. def getRangeBytes(ranges: Iterator[ScanRange[AttributeIndexKey]], tier: Boolean): Iterator[ByteRange]

    Creates bytes from ranges

    Creates bytes from ranges

    ranges

    typed scan ranges. @see getRanges

    tier

    will the ranges have tiered ranges appended, or not

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  16. def getRanges(values: AttributeIndexValues[Any], multiplier: Int): Iterator[ScanRange[AttributeIndexKey]]

    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

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  17. def getStandardRangeBytes(ranges: Iterator[ScanRange[AttributeIndexKey]], prefixes: Seq[Array[Byte]]): Iterator[ByteRange]
    Attributes
    protected
  18. def getTieredRangeBytes(ranges: Iterator[ScanRange[AttributeIndexKey]], prefixes: Seq[Array[Byte]]): Iterator[ByteRange]
    Attributes
    protected
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val indexKeyByteLength: Left[(Array[Byte], Int, Int) ⇒ Int, Int]

    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)

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val isList: Boolean
    Attributes
    protected
  23. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
    Annotations
    @transient()
  24. def lower(key: AttributeIndexKey, prefix: Boolean = false): Array[Byte]

    Gets a lower range bound for an attribute value.

    Gets a lower range bound for an attribute value. The bound can be used with additional tiering or not

    key

    attribute value

    prefix

    if this is a prefix scan or not

    Attributes
    protected
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. val sft: SimpleFeatureType

    Simple feature type being indexed

    Simple feature type being indexed

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  29. val sharding: ShardStrategy

    Strategy for sharding

    Strategy for sharding

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  30. val sharing: Array[Byte]

    Table sharing

    Table sharing

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def tieredUpper(key: AttributeIndexKey): Option[Array[Byte]]

    Gets an upper bound for a range that will be tiered.

    Gets an upper bound for a range that will be tiered. A bound will only be returned if it supports additional tiering.

    key

    attribute value

    Attributes
    protected
  33. def toIndexKey(writable: WritableFeature, tier: Array[Byte], id: Array[Byte], lenient: Boolean): RowKeyValue[AttributeIndexKey]

    Index key from the attributes of a simple feature

    Index key from the attributes of a simple feature

    tier

    tier bytes

    id

    feature id bytes

    lenient

    if input values should be strictly checked, or normalized instead

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. def upper(key: AttributeIndexKey, prefix: Boolean = false): Array[Byte]

    Gets an upper range bound for an attribute value.

    Gets an upper range bound for an attribute value. The bound is only suitable when there is no additional tiering

    key

    attribute value

    prefix

    if this is a prefix scan or not

    Attributes
    protected
  36. def useFullFilter(values: Option[AttributeIndexValues[Any]], config: Option[GeoMesaDataStoreConfig], hints: Hints): Boolean

    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

    Definition Classes
    AttributeIndexKeySpace → IndexKeySpace
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from LazyLogging

Inherited from IndexKeySpace[AttributeIndexValues[Any], AttributeIndexKey]

Inherited from AnyRef

Inherited from Any

Ungrouped