org.gephi.graph.api.types

Class TimestampBooleanMap

java.lang.Object

org.gephi.graph.api.types.TimestampMap<Boolean>

org.gephi.graph.api.types.TimestampBooleanMap

All Implemented Interfaces:

TimeMap<Double,Boolean>

public final class TimestampBooleanMap
extends TimestampMap<Boolean>

Sorted map where keys are timestamp indices and values boolean values.

Constructor Summary

Constructors

Constructor and Description
TimestampBooleanMap() Default constructor.
TimestampBooleanMap(double[] keys, boolean[] vals) Constructor with an initial timestamp map.
TimestampBooleanMap(int capacity) Constructor with capacity.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(double timestamp) Get the value for the given timestamp.
boolean	getBoolean(double timestamp, boolean defaultValue) Get the value for the given timestamp.
Class<Boolean>	getTypeClass() Returns the value type class.
boolean	isSupported(Estimator estimator) Returns whether estimator is supported.
boolean[]	toBooleanArray() Returns an array of all values in this map.

Methods inherited from class org.gephi.graph.api.types.TimestampMap

clear, contains, equals, get, get, getTimestamps, hashCode, isEmpty, put, remove, size, toKeysArray, toString, toString, toString, toValuesArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimestampBooleanMap

public TimestampBooleanMap()

Default constructor.

The map is empty with zero capacity.

TimestampBooleanMap

public TimestampBooleanMap(int capacity)

Constructor with capacity.

Using this constructor can improve performances if the number of timestamps is known in advance as it minimizes array resizes.

Parameters:

capacity - timestamp capacity

TimestampBooleanMap

public TimestampBooleanMap(double[] keys,
                           boolean[] vals)

Constructor with an initial timestamp map.

The keys array must be sorted and contain no duplicates.

Parameters:

keys - initial keys content

vals - initial values content

Method Detail

getBoolean

public boolean getBoolean(double timestamp)

Get the value for the given timestamp.

Parameters:

timestamp - timestamp

Returns:

found value or the default value if not found

Throws:

IllegalArgumentException - if the element doesn't exist

getBoolean

public boolean getBoolean(double timestamp,
                          boolean defaultValue)

Get the value for the given timestamp.

Return defaultValue if the value is not found.

Parameters:

timestamp - timestamp

defaultValue - default value

Returns:

found value or the default value if not found

getTypeClass

public Class<Boolean> getTypeClass()

Description copied from interface: TimeMap

Returns the value type class.

Specified by:

getTypeClass in interface TimeMap<Double,Boolean>

Specified by:

getTypeClass in class TimestampMap<Boolean>

Returns:

type class

toBooleanArray

public boolean[] toBooleanArray()

Returns an array of all values in this map.

This method may return a reference to the underlying array so clients should make a copy if the array is written to.

Returns:

array of all values

isSupported

public boolean isSupported(Estimator estimator)

Description copied from interface: TimeMap

Returns whether estimator is supported.

Specified by:

isSupported in interface TimeMap<Double,Boolean>

Specified by:

isSupported in class TimestampMap<Boolean>

Parameters:

estimator - estimator

Returns:

true if this map supports estimator