ides.api.model.supeventset
Interface SupervisoryEventSet

All Superinterfaces:

Annotable, java.util.Collection<DESEvent>, DESEventSet, DESModel, DESModelPublisher, java.lang.Iterable<DESEvent>, java.util.Set<DESEvent>, SupEventSetPublisher

public interface SupervisoryEventSet
extends DESEventSet, DESModel, SupEventSetPublisher

Interface for models of SupervisoryEvent sets.

Author:

Valerie Sugarman

Method Summary

SupervisoryEvent	assembleCopyOf(DESEvent event) Assembles a new event with the same name and properties as the given event, which can then be added to the model.
SupervisoryEvent	assembleEvent(java.lang.String symbol) Assembles a new event which can be added to the model.
SupervisoryEventSet	copy() Produce a (deep) copy of this event set.
SupervisoryEvent	getEvent(long id) Get the event with the given event id.
SupervisoryEventSet	intersect(DESEventSet set) Produce an event set which contains the intersection of this event set and the given event set.
java.util.Iterator<SupervisoryEvent>	iteratorControllable() Get an iterator for all the controllable SupervisoryEvents in the set.
java.util.Iterator<SupervisoryEvent>	iteratorObservable() Get an iterator for all the observable SupervisoryEvents in the set.
java.util.Iterator<SupervisoryEvent>	iteratorSupervisory() Get an iterator for all the SupervisoryEvents in the set.
java.util.Iterator<SupervisoryEvent>	iteratorUncontrollable() Get an iterator for all the uncontrollable SupervisoryEvents in the set.
java.util.Iterator<SupervisoryEvent>	iteratorUnobservable() Get an iterator for all the unobservable SupervisoryEvents in the set.
SupervisoryEventSet	subtract(DESEventSet set) Produce an event set which contains the events in this event minus the events in the given event set.
SupervisoryEventSet	union(DESEventSet set) Produce an event set which contains the union of this event set and the given event set.

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface ides.api.plugin.model.DESModel

getEventSet, getModelType, getName, getParentModel, metadataChanged, modelSaved, needsSave, setName, setParentModel

Methods inherited from interface ides.api.core.Annotable

getAnnotation, hasAnnotation, removeAnnotation, setAnnotation

Methods inherited from interface ides.api.plugin.model.DESModelPublisher

addSubscriber, getDESModelSubscribers, removeSubscriber

Methods inherited from interface ides.api.model.supeventset.SupEventSetPublisher

addSubscriber, fireSupEventSetChanged, getSupEventSetSubscribers, removeSubscriber

Method Detail

assembleEvent

SupervisoryEvent assembleEvent(java.lang.String symbol)

Assembles a new event which can be added to the model. The event is not automatically added to the model.

Parameters:

symbol - the name of the event

Returns:

a new event with the given name.

assembleCopyOf

SupervisoryEvent assembleCopyOf(DESEvent event)

Assembles a new event with the same name and properties as the given event, which can then be added to the model. The event is not automatically added to the model.

Parameters:

event - the event whose properties are to be copied.

Returns:

As new SupervisoryEvent with the same name as the given event. If the given event is a SupervisoryEvent, the new event will have the same controllable and observable properties as the given event.

iteratorSupervisory

java.util.Iterator<SupervisoryEvent> iteratorSupervisory()

Get an iterator for all the SupervisoryEvents in the set.

Returns:

an iterator for the events.

iteratorControllable

java.util.Iterator<SupervisoryEvent> iteratorControllable()

Get an iterator for all the controllable SupervisoryEvents in the set.

Returns:

an iterator for the events.

iteratorUncontrollable

java.util.Iterator<SupervisoryEvent> iteratorUncontrollable()

Get an iterator for all the uncontrollable SupervisoryEvents in the set.

Returns:

an iterator for the events.

iteratorObservable

java.util.Iterator<SupervisoryEvent> iteratorObservable()

Get an iterator for all the observable SupervisoryEvents in the set.

Returns:

an iterator for the events.

iteratorUnobservable

java.util.Iterator<SupervisoryEvent> iteratorUnobservable()

Get an iterator for all the unobservable SupervisoryEvents in the set.

Returns:

an iterator for the events.

copy

SupervisoryEventSet copy()

Produce a (deep) copy of this event set.

The events in the result will be copies of the original events.

Specified by:

copy in interface DESEventSet

Returns:

a (deep) copy of this event set

intersect

SupervisoryEventSet intersect(DESEventSet set)

Produce an event set which contains the intersection of this event set and the given event set.

The events in the intersection will be copies of the events in this event set. Thus, the method may be non-commutative in certain cases.

Specified by:

intersect in interface DESEventSet

Parameters:

set - the event set whose content will be used for the intersection

Returns:

the intersection of this event set and the given event set

union

SupervisoryEventSet union(DESEventSet set)

Produce an event set which contains the union of this event set and the given event set.

The events in the intersection will be copies of the events in this event set and copies of all the events in the given set which are not in this set. Thus, the method may be non-commutative in certain cases.

Specified by:

union in interface DESEventSet

Parameters:

set - the event set whose content will be used for the union

Returns:

the union of this event set and the given event set

subtract

SupervisoryEventSet subtract(DESEventSet set)

Produce an event set which contains the events in this event minus the events in the given event set.

The events in the result will be copies of the original events.

Specified by:

subtract in interface DESEventSet

Parameters:

set - the event set whose content will be subtracted from this event set

Returns:

a set with the events from this set minus the events in the given set

getEvent

SupervisoryEvent getEvent(long id)

Get the event with the given event id.

Parameters:

id - the id of the event

Returns:

the event, null if it doesn't exist