Class/Object

org.locationtech.geomesa.utils.stats

Z3Histogram

Related Docs: object Z3Histogram | package stats

Permalink

class Z3Histogram extends Stat with LazyLogging

The histogram's state is stored in an indexed array, where the index is the bin number and the values are the counts.

Tracks geometry and date attributes as a single value.

Linear Supertypes
LazyLogging, Stat, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Z3Histogram
  2. LazyLogging
  3. Stat
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Z3Histogram(sft: SimpleFeatureType, geom: String, dtg: String, period: TimePeriod, length: Int)

    Permalink

    sft

    simple feature type

    geom

    geometry attribute in the sft

    dtg

    date attribute in the sft

    period

    time period to use for z index

    length

    number of bins the histogram has, per period

Type Members

  1. type S = Z3Histogram

    Permalink
    Definition Classes
    Z3HistogramStat

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: Z3Histogram): Z3Histogram

    Permalink

    Creates a new histogram by combining another histogram with this one

    Creates a new histogram by combining another histogram with this one

    other

    the other stat to add

    Definition Classes
    Z3HistogramStat
  4. def +(other: Stat)(implicit d: DummyImplicit): Stat

    Permalink

    Non type-safe add - if stats are not the same type, will throw an exception

    Non type-safe add - if stats are not the same type, will throw an exception

    other

    the other stat to add

    Definition Classes
    Stat
  5. def +=(other: Z3Histogram): Unit

    Permalink

    Copies another histogram into this one

    Copies another histogram into this one

    other

    the other stat to add

    Definition Classes
    Z3HistogramStat
  6. def +=(other: Stat)(implicit d: DummyImplicit): Unit

    Permalink

    Non type-safe add - if stats are not the same type, will throw an exception

    Non type-safe add - if stats are not the same type, will throw an exception

    other

    the other stat to add

    Definition Classes
    Stat
  7. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  9. def clear(): Unit

    Permalink

    Clears the stat to its original state when first initialized.

    Clears the stat to its original state when first initialized. Necessary method used by the StatIterator.

    Definition Classes
    Z3HistogramStat
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def count(timeBin: Short, i: Int): Long

    Permalink
  12. def directIndex(timeBin: Short, value: Long): Int

    Permalink
  13. val dtg: String

    Permalink

    date attribute in the sft

  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. val geom: String

    Permalink

    geometry attribute in the sft

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. def indexOf(value: (Geometry, Date)): (Short, Int)

    Permalink
  21. def isEmpty: Boolean

    Permalink

    Necessary method used by the StatIterator.

    Necessary method used by the StatIterator. Indicates if the stat has any values or not

    returns

    true if stat contains values

    Definition Classes
    Z3HistogramStat
  22. def isEquivalent(other: Stat): Boolean

    Permalink

    Compares the two stats for equivalence.

    Compares the two stats for equivalence. We don't use standard 'equals' as it gets messy with mutable state and hash codes

    other

    other stat to compare

    returns

    true if equals

    Definition Classes
    Z3HistogramStat
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. val length: Int

    Permalink

    number of bins the histogram has, per period

  25. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  26. def medianValue(timeBin: Short, i: Int): (Geometry, Date)

    Permalink
  27. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  30. def observe(sf: SimpleFeature): Unit

    Permalink

    Compute statistics based upon the given simple feature.

    Compute statistics based upon the given simple feature. This method will be called for every SimpleFeature a query returns.

    sf

    feature to evaluate

    Definition Classes
    Z3HistogramStat
  31. val period: TimePeriod

    Permalink

    time period to use for z index

  32. val sft: SimpleFeatureType

    Permalink

    simple feature type

    simple feature type

    Definition Classes
    Z3HistogramStat
  33. def splitByTime: Seq[(Short, Z3Histogram)]

    Permalink

    Split the stat into a separate stat per time bin of z data.

    Split the stat into a separate stat per time bin of z data. Allows for separate handling of the reduced data set.

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

    Permalink
    Definition Classes
    AnyRef
  35. def timeBins: Seq[Short]

    Permalink
  36. def toJson: String

    Permalink

    Returns a JSON representation of the Stat

    Returns a JSON representation of the Stat

    returns

    stat as a json string

    Definition Classes
    Stat
  37. def toJsonObject: Any

    Permalink

    Returns a representation of the Stat to be serialized

    Returns a representation of the Stat to be serialized

    This function should return a representation (view) of the Stat to be serialized as JSON. Instances of Map can be used to represent JSON dictionaries or Seq for JSON arrays. A collection.SortedMap such as collection.immutable.ListMap is recommended if key order should be deterministic. Other types may be used but could require the creation and registration of custom serializers dependent on the JSON framework being utilized (currently Gson).

    returns

    stat as a json serializable object

    Definition Classes
    Z3HistogramStat
  38. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  39. def unobserve(sf: SimpleFeature): Unit

    Permalink

    Tries to remove the given simple feature from the compiled statistics.

    Tries to remove the given simple feature from the compiled statistics. Note: may not be possible to un-observe a feature, in which case this method will have no effect.

    sf

    feature to un-evaluate

    Definition Classes
    Z3HistogramStat
  40. final def wait(): Unit

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

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

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

Deprecated Value Members

  1. lazy val dtgIndex: Int

    Permalink
    Annotations
    @deprecated
    Deprecated

    dtg

  2. lazy val geomIndex: Int

    Permalink
    Annotations
    @deprecated
    Deprecated

    geom

Inherited from LazyLogging

Inherited from Stat

Inherited from AnyRef

Inherited from Any

Ungrouped