Class/Object

org.locationtech.geomesa.index.index.attribute

AttributeIndexKeySpace

Related Docs: object AttributeIndexKeySpace | package attribute

Permalink

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

Attribute index key

Linear Supertypes
LazyLogging, IndexKeySpace[AttributeIndexValues[Any], AttributeIndexKey], AnyRef, Any
Known Subclasses
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)

    Permalink

    sft

    simple feature type

    attributeField

    attribute being indexed

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. val attributes: Seq[String]

    Permalink

    The attributes used to create the index keys

    The attributes used to create the index keys

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def decodeRowValue(row: Array[Byte], offset: Int, length: Int): Try[AnyRef]

    Permalink

    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

    Permalink
    Attributes
    protected
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. val fieldIndex: Int

    Permalink
    Attributes
    protected
  12. val fieldIndexShort: Short

    Permalink
    Attributes
    protected
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def getIndexValues(filter: Filter, explain: Explainer): AttributeIndexValues[Any]

    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

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  16. def getRangeBytes(ranges: Iterator[ScanRange[AttributeIndexKey]], tier: Boolean): 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

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  17. def getRanges(values: AttributeIndexValues[Any], multiplier: Int): Iterator[ScanRange[AttributeIndexKey]]

    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

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  18. def getStandardRangeBytes(ranges: Iterator[ScanRange[AttributeIndexKey]], prefixes: Seq[Array[Byte]]): Iterator[ByteRange]

    Permalink
    Attributes
    protected
  19. def getTieredRangeBytes(ranges: Iterator[ScanRange[AttributeIndexKey]], prefixes: Seq[Array[Byte]]): Iterator[ByteRange]

    Permalink
    Attributes
    protected
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. val indexKeyByteLength: Left[(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)

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. val isList: Boolean

    Permalink
    Attributes
    protected
  24. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  25. def lower(key: AttributeIndexKey, prefix: Boolean = false): Array[Byte]

    Permalink

    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
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. val sft: SimpleFeatureType

    Permalink

    simple feature type

    simple feature type

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  30. val sharding: ShardStrategy

    Permalink

    Strategy for sharding

    Strategy for sharding

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  31. val sharing: Array[Byte]

    Permalink

    Table sharing

    Table sharing

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def tieredUpper(key: AttributeIndexKey): Option[Array[Byte]]

    Permalink

    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
  34. def toIndexKey(writable: WritableFeature, tier: Array[Byte], id: Array[Byte], lenient: Boolean): RowKeyValue[AttributeIndexKey]

    Permalink

    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
    AttributeIndexKeySpaceIndexKeySpace
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. def upper(key: AttributeIndexKey, prefix: Boolean = false): Array[Byte]

    Permalink

    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
  37. def useFullFilter(values: Option[AttributeIndexValues[Any]], 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

    Definition Classes
    AttributeIndexKeySpaceIndexKeySpace
  38. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

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

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped