edu.northwestern.at.monk.model
Class AggregateCounter

java.lang.Object
  edu.northwestern.at.monk.model.AggregateCounter

public class AggregateCounter
extends java.lang.Object

An aggregate counter.

See Also:

MONK Datastore Overview, Licensing Agreement

Method Summary

long	getCount(CumKind kind) Gets the count.
long	getCountMain(CumKind kind) Gets the count over main text (non-paratext).
double	getFreq(CumKind kind) Gets the frequency.
double	getFreqMain(CumKind kind) Gets the frequency over main text (non-paratext).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCount

public long getCount(CumKind kind)

Gets the count.

Parameters:

kind - Kind of count: CumKind.CUM or CumKind.NON_CUM.

Returns:

Number of times feature occurs in container.

getCountMain

public long getCountMain(CumKind kind)

Gets the count over main text (non-paratext).

Parameters:

kind - Kind of count: CumKind.CUM or CumKind.NON_CUM.

Returns:

Number of times feature occurs in main text (non-paratext) in container.

getFreq

public double getFreq(CumKind kind)

Gets the frequency.

Parameters:

kind - Kind of count: CumKind.CUM or CumKind.NON_CUM.

Returns:

Frequency.

getFreqMain

public double getFreqMain(CumKind kind)

Gets the frequency over main text (non-paratext).

Parameters:

kind - Kind of count: CumKind.CUM or CumKind.NON_CUM.

Returns:

Frequency.