Z3Frequency

Instance Constructors

new Z3Frequency(sft: SimpleFeatureType, geom: String, dtg: String, period: TimePeriod, precision: Int, eps: Double = 0.005, confidence: Double = 0.95)

sft
simple feature type
geom
geometry attribute in the sft
dtg
date attribute in the sft
period
time period to use for z index
precision
number of bits of z-index that will be used
eps
(epsilon) with probability at least @see confidence, estimates will be within eps * N
confidence
percent - with probability at least confidence, estimates will be within @see eps * N

Type Members

type S = Z3Frequency

Definition Classes
Z3Frequency → Stat

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: Z3Frequency): Z3Frequency

Combine two stats into a new stat
Combine two stats into a new stat
other
the other stat to add

Definition Classes
Z3Frequency → Stat
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

Definition Classes
Stat
def +=(other: Z3Frequency): Unit

Add another stat to this stat.
Add another stat to this stat. Avoids allocating another object.
other
the other stat to add

Definition Classes
Z3Frequency → Stat
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

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

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

Definition Classes
Any
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.

Definition Classes
Z3Frequency → Stat
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val confidence: Double

percent - with probability at least confidence, estimates will be within @see eps * N
def count(geom: Geometry, dtg: Date): Long

Gets the count for the given values
Gets the count for the given values
geom
geometry
dtg
date
returns
count of the values
def countDirect(bin: Short, z3: Long): Long

Gets the count for a time bin and z3.
Gets the count for a time bin and z3. Useful if the values are known ahead of time.
bin
period since the epoch
z3
z value
returns
count of the values
val dtg: String

date attribute in the sft
val eps: Double

(epsilon) with probability at least @see confidence, estimates will be within eps * N
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

geometry attribute in the sft
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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

Definition Classes
Z3Frequency → Stat
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

Definition Classes
Z3Frequency → Stat
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val logger: Logger

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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

Definition Classes
Z3Frequency → Stat
val period: TimePeriod

time period to use for z index
val precision: Int

number of bits of z-index that will be used
val sft: SimpleFeatureType

simple feature type
simple feature type

Definition Classes
Z3Frequency → Stat
def size: Long

Number of observations in the frequency map
Number of observations in the frequency map
returns
number of observations
def splitByTime: Seq[(Short, Z3Frequency)]

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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toJson: String

Returns a JSON representation of the Stat
Returns a JSON representation of the Stat
returns
stat as a json string

Definition Classes
Stat
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

Definition Classes
Z3Frequency → Stat
def toString(): String

Definition Classes
AnyRef → Any
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

Definition Classes
Z3Frequency → Stat
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 Doc: package stats

class Z3Frequency extends Stat with LazyLogging

Instance Constructors

new Z3Frequency(sft: SimpleFeatureType, geom: String, dtg: String, period: TimePeriod, precision: Int, eps: Double = 0.005, confidence: Double = 0.95)

Type Members

type S = Z3Frequency

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: Z3Frequency): Z3Frequency

def +(other: Stat)(implicit d: DummyImplicit): Stat

def +=(other: Z3Frequency): Unit

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

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clear(): Unit

def clone(): AnyRef

val confidence: Double

def count(geom: Geometry, dtg: Date): Long

def countDirect(bin: Short, z3: Long): Long

val dtg: String

val eps: Double

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val geom: String

final def getClass(): Class[_]

def hashCode(): Int

def isEmpty: Boolean

def isEquivalent(other: Stat): Boolean

final def isInstanceOf[T0]: Boolean

lazy val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def observe(sf: SimpleFeature): Unit

val period: TimePeriod

val precision: Int

val sft: SimpleFeatureType

def size: Long

def splitByTime: Seq[(Short, Z3Frequency)]

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

def toJson: String

def toJsonObject: Any

def toString(): String

def unobserve(sf: SimpleFeature): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

lazy val dtgIndex: Int

lazy val geomIndex: Int

Inherited from LazyLogging

Inherited from Stat

Inherited from AnyRef

Inherited from Any

Ungrouped