Class/Object

org.locationtech.geomesa.index.stats

MetadataBackedStats

Related Docs: object MetadataBackedStats | package stats

Permalink

abstract class MetadataBackedStats extends RunnableStats with StatsBasedEstimator

Tracks stats via entries stored in metadata

Linear Supertypes
StatsBasedEstimator, RunnableStats, LazyLogging, GeoMesaStats, Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MetadataBackedStats
  2. StatsBasedEstimator
  3. RunnableStats
  4. LazyLogging
  5. GeoMesaStats
  6. Closeable
  7. AutoCloseable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MetadataBackedStats(ds: DataStore, metadata: GeoMesaMetadata[Stat])

    Permalink

Type Members

  1. class MetadataStatUpdater extends StatUpdater with LazyLogging

    Permalink

    Stores stats as metadata entries

    Stores stats as metadata entries

    Attributes
    protected
  2. class MetadataStatWriter extends GeoMesaStatWriter

    Permalink

    Stat writer implementation

    Stat writer implementation

    Attributes
    protected

Abstract Value Members

  1. abstract def write(typeName: String, stats: Seq[WritableStat]): Unit

    Permalink

    Write stats

    Write stats

    typeName

    simple feature type name

    stats

    stats to write

    Attributes
    protected

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. def close(): Unit

    Permalink
    Definition Classes
    MetadataBackedStatsRunnableStats → Closeable → AutoCloseable
  7. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def estimateCount(sft: SimpleFeatureType, filter: Filter): Option[Long]

    Permalink

    Estimates the count for a given filter, based off the per-attribute metadata we have stored

    Estimates the count for a given filter, based off the per-attribute metadata we have stored

    sft

    simple feature type

    filter

    filter to apply - should have been run through QueryPlanFilterVisitor so all props are right

    returns

    estimated count, if available

    Attributes
    protected
    Definition Classes
    StatsBasedEstimator
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def getBounds(sft: SimpleFeatureType, filter: Filter = Filter.INCLUDE, exact: Boolean = false): ReferencedEnvelope

    Permalink

    Get the bounds for data that will be returned for a query

    Get the bounds for data that will be returned for a query

    sft

    simple feature type

    filter

    cql filter

    exact

    rough estimate, or precise bounds. note: precise bounds will likely be expensive.

    returns

    bounds

    Definition Classes
    GeoMesaStats
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getCount(sft: SimpleFeatureType, filter: Filter, exact: Boolean): Option[Long]

    Permalink

    Gets the number of features that will be returned for a query.

    Gets the number of features that will be returned for a query. May return -1 if exact is false and estimate is unavailable.

    sft

    simple feature type

    filter

    cql filter

    exact

    rough estimate, or precise count. note: precise count will likely be expensive.

    returns

    count of features, if available - will always be Some if exact == true

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats
  14. def getEnumeration[T](sft: SimpleFeatureType, attribute: String, filter: Filter, exact: Boolean): Option[EnumerationStat[T]]

    Permalink

    Get an enumeration stat

    Get an enumeration stat

    T

    attribute type - must correspond to attribute binding

    sft

    simple feature type

    attribute

    attribute name to query

    filter

    cql filter

    exact

    rough estimates, or precise values. note: precise values will likely be expensive.

    Definition Classes
    RunnableStatsGeoMesaStats
  15. def getFrequency[T](sft: SimpleFeatureType, attribute: String, precision: Int, filter: Filter, exact: Boolean): Option[Frequency[T]]

    Permalink

    Get a frequency stat

    Get a frequency stat

    T

    attribute type - must correspond to attribute binding

    sft

    simple feature type

    attribute

    attribute name to query

    precision

    precision of the estimate - @see org.locationtech.geomesa.utils.stats.Frequency

    filter

    cql filter

    exact

    rough estimates, or precise values. note: precise values will likely be expensive.

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats
  16. def getHistogram[T](sft: SimpleFeatureType, attribute: String, bins: Int, min: T, max: T, filter: Filter, exact: Boolean): Option[Histogram[T]]

    Permalink

    Get a histogram stat

    Get a histogram stat

    T

    attribute type - must correspond to attribute binding

    sft

    simple feature type

    attribute

    attribute name to query

    bins

    number of buckets used to group values

    min

    minimum value used to create the initial histogram buckets

    max

    maximum value used to create the initial histogram buckets

    filter

    cql filter

    exact

    rough estimates, or precise values. note: precise values will likely be expensive.

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats
  17. def getMinMax[T](sft: SimpleFeatureType, attribute: String, filter: Filter, exact: Boolean): Option[MinMax[T]]

    Permalink

    Get the minimum and maximum values for the given attribute

    Get the minimum and maximum values for the given attribute

    T

    attribute type - must correspond to attribute binding

    sft

    simple feature type

    attribute

    attribute name to examine

    filter

    cql filter

    exact

    rough estimate, or precise values. note: precise values will likely be expensive.

    returns

    mix/max values and overall cardinality. types will be consistent with the binding of the attribute

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats
  18. def getSeqStat[T <: Stat](sft: SimpleFeatureType, queries: Seq[String], filter: Filter = Filter.INCLUDE, exact: Boolean = false): Seq[T]

    Permalink

    Gets arbitrary stats for multiple queries

    Gets arbitrary stats for multiple queries

    T

    type bounds, must match stat query strings

    sft

    simple feature type

    queries

    stats strings

    filter

    cql filter

    exact

    rough estimate, or precise values. note: precise values will likely be expensive.

    Definition Classes
    GeoMesaStats
  19. def getStat[T <: Stat](sft: SimpleFeatureType, query: String, filter: Filter = Filter.INCLUDE, exact: Boolean = false): Option[T]

    Permalink

    Get arbitrary stats

    Get arbitrary stats

    T

    type bounds, must match stat query strings

    sft

    simple feature type

    query

    stats string

    filter

    cql filter

    exact

    rough estimate, or precise values. note: precise values will likely be expensive.

    returns

    stats, if any

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats
  20. def getTopK[T](sft: SimpleFeatureType, attribute: String, filter: Filter, exact: Boolean): Option[TopK[T]]

    Permalink

    Get a top k stat

    Get a top k stat

    T

    attribute type - must correspond to attribute binding

    sft

    simple feature type

    attribute

    attribute name to query

    filter

    cql filter

    exact

    rough estimates, or precise values. note: precise values will likely be expensive.

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats
  21. def getZ3Histogram(sft: SimpleFeatureType, geom: String, dtg: String, period: TimePeriod, bins: Int, filter: Filter, exact: Boolean): Option[Z3Histogram]

    Permalink

    Get a Z3 histogram stat, where values are grouped based on combined geometry + date

    Get a Z3 histogram stat, where values are grouped based on combined geometry + date

    sft

    simple feature type

    geom

    geometry attribute to query

    dtg

    date attribute to query

    period

    time period used to calculate bins for each value

    bins

    number of buckets used to group values

    filter

    cql filter

    exact

    rough estimates, or precise values. note: precise values will likely be expensive.

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats
  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  28. def query[T <: Stat](sft: SimpleFeatureType, filter: Filter, query: String): Option[T]

    Permalink

    Run an exact query against the data store

    Run an exact query against the data store

    T

    stat type

    sft

    simple feature type

    filter

    filter

    query

    stat string

    Attributes
    protected
    Definition Classes
    RunnableStats
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. val writer: GeoMesaStatWriter

    Permalink

    Gets a writer for updating stats

    Gets a writer for updating stats

    Definition Classes
    MetadataBackedStatsRunnableStatsGeoMesaStats

Deprecated Value Members

  1. def clearStats(sft: SimpleFeatureType): Unit

    Permalink
    Definition Classes
    GeoMesaStats
    Annotations
    @deprecated
    Deprecated

    writer.clear

  2. def generateStats(sft: SimpleFeatureType): Seq[Stat]

    Permalink
    Definition Classes
    GeoMesaStats
    Annotations
    @deprecated
    Deprecated

    writer.analyze

  3. def getAttributeBounds[T](sft: SimpleFeatureType, attribute: String, filter: Filter = Filter.INCLUDE, exact: Boolean = false): Option[MinMax[T]]

    Permalink
    Definition Classes
    GeoMesaStats
    Annotations
    @deprecated
    Deprecated

    getMinMax

  4. def getStats[T <: Stat](sft: SimpleFeatureType, attributes: Seq[String] = Seq.empty, options: Seq[Any] = Seq.empty)(implicit ct: ClassTag[T]): Seq[T]

    Permalink
    Definition Classes
    GeoMesaStats
    Annotations
    @deprecated
    Deprecated

    getSeqStat(exact = false)

  5. def rename(sft: SimpleFeatureType, previous: SimpleFeatureType): Unit

    Permalink
    Definition Classes
    GeoMesaStats
    Annotations
    @deprecated
    Deprecated

    writer.rename

  6. def runStats[T <: Stat](sft: SimpleFeatureType, stats: String, filter: Filter = Filter.INCLUDE): Seq[T]

    Permalink
    Definition Classes
    GeoMesaStats
    Annotations
    @deprecated
    Deprecated

    getStat/getSeqStat(exact = true)

  7. def statUpdater(sft: SimpleFeatureType): StatUpdater

    Permalink
    Definition Classes
    GeoMesaStats
    Annotations
    @deprecated
    Deprecated

    writer.updater

Inherited from StatsBasedEstimator

Inherited from RunnableStats

Inherited from LazyLogging

Inherited from GeoMesaStats

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped