EventDayIndex
internal

This utility class is used by event stores to index events by their day (a "YYYY-MM-DD" value, also known as a "date key"). This key is produced by a DayTime instance. If two DayTime instances have a common startShift, they can share an index.

No results

Properties

Properties are getters/setters or publicly accessible variables on this class

dayTime : DayTime

READONLY

The DayTime definition for this index. This is set to the initial DayTime instance but can be used for any other registeredDayTime instances since they all posses the same value for startShift.

This defaults to MIDNIGHT.
store : EventStore

private

READONLY

The owning store instance of this index.
users : DayTime[]

private

The DayTime instances registered with this index instance. As instances are unregistered they are removed from this array. Once this array is empty, this index can be discarded.

Functions

Functions are methods available for calling on the class

add( indexName, date, eventRecord )

private

Adds an event record to the specified index (either "startDate" or "date") for a given date.
addEvent( eventRecord )

private

Adds an event record to all indexes for all dates which the event overlaps.
clear( )

Clear this index.
get( indexName, date, returnKey )
: Object/EventModel[]

Returns an object that has properties named by the dateKey method, or the array of event records if a date is specified, or the event record array and the date key in a 2-element array if returnKey is true.
initialize( )

private

Called when this index is first used. Once called, further store changes will be used to maintain this index.
matches( dayTime )
: Boolean

Returns true if the given dayTime matches this index.
register( dayTime )

This method registers a dayTime instance with this index in the users array.
remove( indexName, date, eventRecord )

private

Removes an event record from the specified index (either "startDate" or "date") for a given date.
removeEvent( eventRecord, startDate, endDate )

private

Removes an event record from all indexes for all dates which the event overlaps.
unregister( dayTime )
: Boolean

This method unregisters a dayTime instance, removing it from the users array. This method returns true if this was the last registered instance and this index is no longer needed.

Source path

Scheduler/data/util/EventDayIndex.js

Inheritance tree1

EventDayIndex

EventDayIndex internal

Properties

Functions

Source path

Inheritance tree1

Contents

EventDayIndex
internal