Packages

trait Stat extends AnyRef

Stats used by the StatsIterator to compute various statistics server-side for a given query.

Linear Supertypes
AnyRef, Any
Known Subclasses
ImmutableStat, CountStat, DescriptiveStats, EnumerationStat, Frequency, GroupBy, Histogram, IteratorStackCount, MinMax, SeqStat, TopK, Z3Frequency, Z3Histogram
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Stat
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type S <: Stat

Abstract Value Members

  1. abstract def +(other: S): S

    Combine two stats into a new stat

    Combine two stats into a new stat

    other

    the other stat to add

  2. abstract def +=(other: S): Unit

    Add another stat to this stat.

    Add another stat to this stat. Avoids allocating another object.

    other

    the other stat to add

  3. abstract def clear(): Unit

    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.

  4. abstract def isEmpty: Boolean

    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

  5. abstract def isEquivalent(other: Stat): Boolean

    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

  6. abstract def observe(sf: SimpleFeature): Unit

    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

  7. abstract def sft: SimpleFeatureType

    The simple feature type that this stat operates on

  8. abstract def toJsonObject: Any

    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

  9. abstract def unobserve(sf: SimpleFeature): Unit

    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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: Stat)(implicit d: DummyImplicit): Stat

    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

  4. def +=(other: Stat)(implicit d: DummyImplicit): Unit

    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

  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  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() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toJson: String

    Returns a JSON representation of the Stat

    Returns a JSON representation of the Stat

    returns

    stat as a json string

  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. 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 AnyRef

Inherited from Any

Ungrouped