org.cesiumjs.cs.collections

Class TimeIntervalCollection

java.lang.Object

org.cesiumjs.cs.collections.TimeIntervalCollection

@JsType(isNative=true,
        namespace="Cesium",
        name="TimeIntervalCollection")
public class TimeIntervalCollection
extends Object

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
TimeIntervalCollection() A non-overlapping collection of TimeInterval instances sorted by start time.
TimeIntervalCollection(TimeInterval[] intervals) A non-overlapping collection of TimeInterval instances sorted by start time.

Method Summary

Modifier and Type	Method and Description
void	addInterval(TimeInterval interval) Adds an interval to the collection, merging intervals that contain the same data and splitting intervals of different data as needed in order to maintain a non-overlapping collection.
void	addInterval(TimeInterval interval, TimeInterval.DataComparer dataComparer) Adds an interval to the collection, merging intervals that contain the same data and splitting intervals of different data as needed in order to maintain a non-overlapping collection.
Event	changedEvent() Gets an event that is raised whenever the collection of intervals change.
boolean	contains(JulianDate julianDate) Checks if the specified date is inside this collection.
boolean	equals(TimeIntervalCollection right) Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.
boolean	equals(TimeIntervalCollection right, TimeInterval.DataComparer dataComparer) Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.
Object	findDataForIntervalContainingDate(JulianDate date) Finds and returns the data for the interval that contains the specified date.
TimeInterval	findInterval() Returns the first interval in the collection that matches the specified parameters.
TimeInterval	findInterval(TimeIntervalOptions options) Returns the first interval in the collection that matches the specified parameters.
TimeInterval	findIntervalContainingDate(JulianDate date) The date to search for.
static TimeIntervalCollection	fromIso8601(FromIso8601Options options) Creates a new instance from an ISO 8601 time interval (start/end/duration).
static TimeIntervalCollection	fromIso8601(FromIso8601Options options, TimeIntervalCollection result) Creates a new instance from an ISO 8601 time interval (start/end/duration).
static TimeIntervalCollection	fromIso8601DateArray(FromIso8601DateArrayOptions options) Creates a new instance from a ISO 8601 date array.
static TimeIntervalCollection	fromIso8601DateArray(FromIso8601DateArrayOptions options, TimeIntervalCollection result) Creates a new instance from a ISO 8601 date array.
static TimeIntervalCollection	fromIso8601DurationArray(FromIso8601DurationArrayOptions options) Creates a new instance from a ISO 8601 duration array.
static TimeIntervalCollection	fromIso8601DurationArray(FromIso8601DurationArrayOptions options, TimeIntervalCollection result) Creates a new instance from a ISO 8601 duration array.
static TimeIntervalCollection	fromJulianDateArray(FromJulianDateArrayOptions options) Creates a new instance from a JulianDate array.
static TimeIntervalCollection	fromJulianDateArray(FromJulianDateArrayOptions options, TimeIntervalCollection result) Creates a new instance from a JulianDate array.
TimeInterval	get(int index) Gets the interval at the specified index.
int	indexOf(JulianDate date) Finds and returns the index of the interval in the collection that contains the specified date.
TimeIntervalCollection	intersect(TimeIntervalCollection other) Creates a new instance that is the intersection of this collection and the provided collection.
TimeIntervalCollection	intersect(TimeIntervalCollection other, TimeInterval.DataComparer dataComparer) Creates a new instance that is the intersection of this collection and the provided collection.
TimeIntervalCollection	intersect(TimeIntervalCollection other, TimeInterval.DataComparer dataComparer, TimeInterval.MergeCallback mergeCallback) Creates a new instance that is the intersection of this collection and the provided collection.
boolean	isEmpty() Gets whether or not the collection is empty.
boolean	isStartIncluded() Gets whether or not the start time is included in the collection.
boolean	isStopIncluded() Gets whether or not the stop time is included in the collection.
int	length() Gets the number of intervals in the collection.
void	removeAll() Removes all intervals from the collection.
void	removeInterval(TimeInterval interval) Removes the specified interval from this interval collection, creating a hole over the specified interval.
JulianDate	start() Gets the start time of the collection.
JulianDate	stop() Gets the stop time of the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeIntervalCollection

@JsConstructor
public TimeIntervalCollection()

A non-overlapping collection of TimeInterval instances sorted by start time.

TimeIntervalCollection

@JsConstructor
public TimeIntervalCollection(TimeInterval[] intervals)

A non-overlapping collection of TimeInterval instances sorted by start time.

Parameters:

intervals - An array of intervals to add to the collection.

Method Detail

changedEvent

@JsProperty(name="changedEvent")
public Event changedEvent()

Gets an event that is raised whenever the collection of intervals change.

isEmpty

@JsProperty(name="isEmpty")
public boolean isEmpty()

Gets whether or not the collection is empty.

isStartIncluded

@JsProperty(name="isStartIncluded")
public boolean isStartIncluded()

Gets whether or not the start time is included in the collection.

isStopIncluded

@JsProperty(name="isStopIncluded")
public boolean isStopIncluded()

Gets whether or not the stop time is included in the collection.

length

@JsProperty(name="length")
public int length()

Gets the number of intervals in the collection.

start

@JsProperty(name="start")
public JulianDate start()

Gets the start time of the collection.

stop

@JsProperty(name="stop")
public JulianDate stop()

Gets the stop time of the collection.

fromIso8601

@JsMethod
public static TimeIntervalCollection fromIso8601(FromIso8601Options options)

Creates a new instance from an ISO 8601 time interval (start/end/duration).

Parameters:

options - FromIso8601Options

Returns:

The modified result parameter or a new instance if none was provided.

fromIso8601

@JsMethod
public static TimeIntervalCollection fromIso8601(FromIso8601Options options,
                                                           TimeIntervalCollection result)

Creates a new instance from an ISO 8601 time interval (start/end/duration).

Parameters:

options - FromIso8601Options

result - An existing instance to use for the result.

Returns:

The modified result parameter or a new instance if none was provided.

fromIso8601DateArray

@JsMethod
public static TimeIntervalCollection fromIso8601DateArray(FromIso8601DateArrayOptions options)

Creates a new instance from a ISO 8601 date array.

Parameters:

options - FromIso8601DateArrayOptions

Returns:

The modified result parameter or a new instance if none was provided.

fromIso8601DateArray

@JsMethod
public static TimeIntervalCollection fromIso8601DateArray(FromIso8601DateArrayOptions options,
                                                                    TimeIntervalCollection result)

Creates a new instance from a ISO 8601 date array.

Parameters:

options - FromIso8601DateArrayOptions

result - An existing instance to use for the result.

Returns:

The modified result parameter or a new instance if none was provided.

fromIso8601DurationArray

@JsMethod
public static TimeIntervalCollection fromIso8601DurationArray(FromIso8601DurationArrayOptions options)

Creates a new instance from a ISO 8601 duration array.

Parameters:

options - FromIso8601DurationArrayOptions

Returns:

The modified result parameter or a new instance if none was provided.

fromIso8601DurationArray

@JsMethod
public static TimeIntervalCollection fromIso8601DurationArray(FromIso8601DurationArrayOptions options,
                                                                        TimeIntervalCollection result)

Creates a new instance from a ISO 8601 duration array.

Parameters:

options - FromIso8601DurationArrayOptions

result - An existing instance to use for the result.

Returns:

The modified result parameter or a new instance if none was provided.

fromJulianDateArray

@JsMethod
public static TimeIntervalCollection fromJulianDateArray(FromJulianDateArrayOptions options)

Creates a new instance from a JulianDate array.

Parameters:

options - FromJulianDateArrayOptions.

Returns:

The modified result parameter or a new instance if none was provided.

fromJulianDateArray

@JsMethod
public static TimeIntervalCollection fromJulianDateArray(FromJulianDateArrayOptions options,
                                                                   TimeIntervalCollection result)

Creates a new instance from a JulianDate array.

Parameters:

options - FromJulianDateArrayOptions.

result - An existing instance to use for the result.

Returns:

The modified result parameter or a new instance if none was provided.

addInterval

@JsMethod
public void addInterval(TimeInterval interval)

Adds an interval to the collection, merging intervals that contain the same data and splitting intervals of different data as needed in order to maintain a non-overlapping collection. The data in the new interval takes precedence over any existing intervals in the collection.

Parameters:

interval - The interval to add.

addInterval

@JsMethod
public void addInterval(TimeInterval interval,
                                  TimeInterval.DataComparer dataComparer)

Adds an interval to the collection, merging intervals that contain the same data and splitting intervals of different data as needed in order to maintain a non-overlapping collection. The data in the new interval takes precedence over any existing intervals in the collection.

Parameters:

interval - The interval to add.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

contains

@JsMethod
public boolean contains(JulianDate julianDate)

Checks if the specified date is inside this collection.

Parameters:

julianDate - The date to check.

Returns:

true if the collection contains the specified date, false otherwise.

equals

@JsMethod
public boolean equals(TimeIntervalCollection right)

Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.

Parameters:

right - The right hand side collection.

Returns:

true if they are equal, false otherwise.

equals

public boolean equals(TimeIntervalCollection right,
                      TimeInterval.DataComparer dataComparer)

Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.

Parameters:

right - The right hand side collection.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

Returns:

true if they are equal, false otherwise.

findDataForIntervalContainingDate

@JsMethod
public Object findDataForIntervalContainingDate(JulianDate date)

Finds and returns the data for the interval that contains the specified date.

Parameters:

date - The date to search for.

Returns:

The data for the interval containing the specified date, or undefined if no such interval exists.

findInterval

@JsMethod
public TimeInterval findInterval()

Returns the first interval in the collection that matches the specified parameters. All parameters are optional and undefined parameters are treated as a don't care condition.

Returns:

The first interval in the collection that matches the specified parameters.

findInterval

@JsMethod
public TimeInterval findInterval(TimeIntervalOptions options)

Returns the first interval in the collection that matches the specified parameters. All parameters are optional and undefined parameters are treated as a don't care condition.

Parameters:

options - TimeIntervalOptions

Returns:

The first interval in the collection that matches the specified parameters.

findIntervalContainingDate

@JsMethod
public TimeInterval findIntervalContainingDate(JulianDate date)

The date to search for.

Parameters:

date - The date to search for.

Returns:

The interval containing the specified date, undefined if no such interval exists.

get

@JsMethod
public TimeInterval get(int index)

Gets the interval at the specified index.

Parameters:

index - The index of the interval to retrieve.

Returns:

The interval at the specified index, or undefined if no interval exists as that index.

indexOf

@JsMethod
public int indexOf(JulianDate date)

Finds and returns the index of the interval in the collection that contains the specified date.

Parameters:

date - The date to search for.

Returns:

The index of the interval that contains the specified date, if no such interval exists, it returns a negative number which is the bitwise complement of the index of the next interval that starts after the date, or if no interval starts after the specified date, the bitwise complement of the length of the collection.

intersect

@JsMethod
public TimeIntervalCollection intersect(TimeIntervalCollection other)

Creates a new instance that is the intersection of this collection and the provided collection.

Parameters:

other - The collection to intersect with.

Returns:

A new TimeIntervalCollection which is the intersection of this collection and the provided collection.

intersect

@JsMethod
public TimeIntervalCollection intersect(TimeIntervalCollection other,
                                                  TimeInterval.DataComparer dataComparer)

Creates a new instance that is the intersection of this collection and the provided collection.

Parameters:

other - The collection to intersect with.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

Returns:

A new TimeIntervalCollection which is the intersection of this collection and the provided collection.

intersect

@JsMethod
public TimeIntervalCollection intersect(TimeIntervalCollection other,
                                                  TimeInterval.DataComparer dataComparer,
                                                  TimeInterval.MergeCallback mergeCallback)

Creates a new instance that is the intersection of this collection and the provided collection.

Parameters:

other - The collection to intersect with.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

mergeCallback - A function which merges the data of the two intervals. If omitted, the data from the left interval will be used.

Returns:

A new TimeIntervalCollection which is the intersection of this collection and the provided collection.

removeAll

@JsMethod
public void removeAll()

Removes all intervals from the collection.

removeInterval

@JsMethod
public void removeInterval(TimeInterval interval)

Removes the specified interval from this interval collection, creating a hole over the specified interval. The data property of the input interval is ignored.

Parameters:

interval - true if the interval was removed, false if no part of the interval was in the collection.