GeoMesaFeatureIndex

Instance Constructors

new GeoMesaFeatureIndex(ds: GeoMesaDataStore[_], sft: SimpleFeatureType, name: String, version: Int, attributes: Seq[String], mode: IndexMode)

ds
data store
sft
simple feature type stored in this index
name
name of the index
version
version of the index
attributes
attributes used to create the index keys
mode
mode of the index (read/write/both)

Abstract Value Members

abstract def getFilterStrategy(filter: Filter, transform: Option[SimpleFeatureType], stats: Option[GeoMesaStats]): Option[FilterStrategy]

Gets options for a 'simple' filter, where each OR is on a single attribute, e.g.
Gets options for a 'simple' filter, where each OR is on a single attribute, e.g. (bbox1 OR bbox2) AND dtg bbox AND dtg AND (attr1 = foo OR attr = bar) not: bbox OR dtg
Because the inputs are simple, each one can be satisfied with a single query filter. The returned values will each satisfy the query.
filter
input filter
transform
attribute transforms
returns
a filter strategy which can satisfy the query, if available
abstract def keySpace: IndexKeySpace[T, U]

Primary key space used by this index
abstract def tieredKeySpace: Option[IndexKeySpace[_, _]]

Tiered key space beyond the primary one, if any

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val attributes: Seq[String]

attributes used to create the index keys
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def configureTableName(partition: Option[String] = None, limit: Option[Int] = None): String

Create the metadata entry for the initial index table or a new partition
Create the metadata entry for the initial index table or a new partition
partition
partition
returns
table name
def createConverter(): WriteConverter[U]

Creates a function to generate row keys from features
def deleteTableNames(partition: Option[String] = None): Seq[String]

Deletes the entire index
Deletes the entire index
partition
only delete a single partition, instead of the whole index
val ds: GeoMesaDataStore[_]

data store
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
GeoMesaFeatureIndex → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def generateTableName(partition: Option[String] = None, limit: Option[Int] = None): String

Creates a valid, unique string for the underlying table
Creates a valid, unique string for the underlying table
partition
partition
limit
limit on the length of a table name in the underlying database

Attributes
protected
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getIdFromRow(row: Array[Byte], offset: Int, length: Int, feature: SimpleFeature): String

Retrieve an ID from a row.
Retrieve an ID from a row. All indices are assumed to encode the feature ID into the row key.
The simple feature in the returned function signature is optional (null ok) - if provided the parsed UUID will be cached in the feature user data, if the sft is marked as using UUIDs
row
row bytes
offset
offset into the row bytes to the first valid byte for this row
length
number of valid bytes for this row
feature
simple feature (optional)
def getIdOffset(row: Array[Byte], offset: Int, length: Int): Int

Gets the offset (start) of the feature id from a row.
Gets the offset (start) of the feature id from a row. All indices are assumed to encode the feature ID into the row key.
row
row bytes
offset
offset into the row bytes to the first valid byte for this row
length
number of valid bytes for this row
def getPartitions: Seq[String]

Gets the partitions for this index, assuming that the schema is partitioned
def getQueryStrategy(filter: FilterStrategy, hints: Hints, explain: Explainer = ExplainNull): QueryStrategy

Plans the query
Plans the query
filter
filter strategy
hints
query hints
explain
explainer
def getSplits(partition: Option[String] = None): Seq[Array[Byte]]

Gets the initial splits for a table
Gets the initial splits for a table
partition
partition, if any
def getTableNames(partition: Option[String] = None): Seq[String]

Gets the table name for this index
Gets the table name for this index
partition
get the name for a particular partition, or all partitions
def getTablesForQuery(filter: Option[Filter]): Seq[String]

Gets the tables that should be scanned to satisfy a query
Gets the tables that should be scanned to satisfy a query
filter
filter
def hashCode(): Int

Definition Classes
GeoMesaFeatureIndex → AnyRef → Any
lazy val idFromRow: IdFromRow

Attributes
protected
val identifier: String

Unique (for the given sft) identifier string for this index.
Unique (for the given sft) identifier string for this index.
Can be parsed with IndexId.parse, although note that it does not include the read/write mode
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val logger: Logger

Attributes
protected
Definition Classes
LazyLogging
val mode: IndexMode

mode of the index (read/write/both)
val name: String

name of the index
name of the index

Definition Classes
GeoMesaFeatureIndex → NamedIndex
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val serializedWithId: Boolean

Is the feature id serialized with the feature? Needed for back-compatibility with old data formats
val sft: SimpleFeatureType

simple feature type stored in this index
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def tableNameKey(partition: Option[String] = None): String

The metadata key used to store the table name for this index
The metadata key used to store the table name for this index
partition
partition
val tableNameKey: String

Attributes
protected
def toString(): String

Definition Classes
GeoMesaFeatureIndex → AnyRef → Any
val version: Int

version of the index
version of the index

Definition Classes
GeoMesaFeatureIndex → NamedIndex
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object GeoMesaFeatureIndex | package api

abstract class GeoMesaFeatureIndex[T, U] extends NamedIndex with LazyLogging

Instance Constructors

new GeoMesaFeatureIndex(ds: GeoMesaDataStore[_], sft: SimpleFeatureType, name: String, version: Int, attributes: Seq[String], mode: IndexMode)

Abstract Value Members

abstract def getFilterStrategy(filter: Filter, transform: Option[SimpleFeatureType], stats: Option[GeoMesaStats]): Option[FilterStrategy]

abstract def keySpace: IndexKeySpace[T, U]

abstract def tieredKeySpace: Option[IndexKeySpace[_, _]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val attributes: Seq[String]

def clone(): AnyRef

def configureTableName(partition: Option[String] = None, limit: Option[Int] = None): String

def createConverter(): WriteConverter[U]

def deleteTableNames(partition: Option[String] = None): Seq[String]

val ds: GeoMesaDataStore[_]

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def finalize(): Unit

def generateTableName(partition: Option[String] = None, limit: Option[Int] = None): String

final def getClass(): Class[_]

def getIdFromRow(row: Array[Byte], offset: Int, length: Int, feature: SimpleFeature): String

def getIdOffset(row: Array[Byte], offset: Int, length: Int): Int

def getPartitions: Seq[String]

def getQueryStrategy(filter: FilterStrategy, hints: Hints, explain: Explainer = ExplainNull): QueryStrategy

def getSplits(partition: Option[String] = None): Seq[Array[Byte]]

def getTableNames(partition: Option[String] = None): Seq[String]

def getTablesForQuery(filter: Option[Filter]): Seq[String]

def hashCode(): Int

lazy val idFromRow: IdFromRow

val identifier: String

final def isInstanceOf[T0]: Boolean

lazy val logger: Logger

val mode: IndexMode

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val serializedWithId: Boolean

val sft: SimpleFeatureType

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

def tableNameKey(partition: Option[String] = None): String

val tableNameKey: String

def toString(): String

val version: Int

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from LazyLogging

Inherited from NamedIndex

Inherited from AnyRef

Inherited from Any

Ungrouped