Packages

trait GeoMesaStats extends Closeable

Tracks stats for a schema - spatial/temporal bounds, number of records, etc. Persistence of stats is not part of this trait, as different implementations will likely have different method signatures.

Linear Supertypes
Closeable, AutoCloseable, AnyRef, Any
Known Subclasses
MetadataBackedStats, NoopStats, RunnableStats, UnoptimizedRunnableStats, MergedStats, RoutedStats
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeoMesaStats
  2. Closeable
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Unit
    Definition Classes
    Closeable → AutoCloseable
    Annotations
    @throws( classOf[java.io.IOException] )
  2. abstract def getCount(sft: SimpleFeatureType, filter: Filter = Filter.INCLUDE, exact: Boolean = false, queryHints: Hints = new Hints()): Option[Long]

    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.

    queryHints

    query hints that should be used for query execution

    returns

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

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

    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.

  4. abstract def getFrequency[T](sft: SimpleFeatureType, attribute: String, precision: Int, filter: Filter = Filter.INCLUDE, exact: Boolean = false): Option[Frequency[T]]

    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.

  5. abstract def getHistogram[T](sft: SimpleFeatureType, attribute: String, bins: Int, min: T, max: T, filter: Filter = Filter.INCLUDE, exact: Boolean = false): Option[Histogram[T]]

    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.

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

    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

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

    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

  8. abstract def getTopK[T](sft: SimpleFeatureType, attribute: String, filter: Filter = Filter.INCLUDE, exact: Boolean = false): Option[TopK[T]]

    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.

  9. abstract def getZ3Histogram(sft: SimpleFeatureType, geom: String, dtg: String, period: TimePeriod, bins: Int, filter: Filter = Filter.INCLUDE, exact: Boolean = false): Option[Z3Histogram]

    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.

  10. abstract def writer: GeoMesaStatWriter

    Gets a writer for updating stats

Concrete 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def getBounds(sft: SimpleFeatureType, filter: Filter = Filter.INCLUDE, exact: Boolean = false): ReferencedEnvelope

    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

  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def getSeqStat[T <: Stat](sft: SimpleFeatureType, queries: Seq[String], filter: Filter = Filter.INCLUDE, exact: Boolean = false): Seq[T]

    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.

  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. 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 Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped