org.gvsig.fmap.dal.feature

Interface FeatureReferenceSelection

All Superinterfaces:

ComplexObservable, DataSelection, DataSet, Disposable, Observable, Observer, Persistent, Visitable, WeakReferencingObservable

All Known Subinterfaces:

FeatureSelection

All Known Implementing Classes:

DefaultFeatureReferenceSelection, DefaultFeatureSelection, LargeFeatureReferenceSelection, LargeFeatureSelection

public interface FeatureReferenceSelection
extends DataSelection, Observer, WeakReferencingObservable, ComplexObservable, Persistent

Interface to manage selection of objects from an undetermined set. Allows to add and remove values from the selection, as well as reversing the selection.

Method Summary

Modifier and Type	Method and Description
boolean	deselect(FeatureReference reference) Removes a feature from the selection.
void	deselectAll() Deselects all values.
long	getSelectedCount() Returns the number of selected values.
boolean	isAvailable()
boolean	isSelected(FeatureReference reference) Returns if a feature is selected.
java.lang.Iterable<FeatureReference>	referenceIterable()
java.util.Iterator<FeatureReference>	referenceIterator() Returns an unmodifiable Iterator of selected feature references.
void	reverse() Reverses the selection.
boolean	select(FeatureReference reference) Adds a feature to the selection.
void	selectAll() Selects all values.

Methods inherited from interface org.gvsig.fmap.dal.DataSet

accept, isFromStore

Methods inherited from interface org.gvsig.tools.visitor.Visitable

accept

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Methods inherited from interface org.gvsig.tools.observer.Observer

update

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Methods inherited from interface org.gvsig.tools.observer.ComplexObservable

beginComplexNotification, disableNotifications, enableNotifications, endComplexNotification

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Method Detail

select

boolean select(FeatureReference reference)

Adds a feature to the selection.

Parameters:

reference - the selected feature reference

Returns:

true if the feature was not selected before selecting it

deselect

boolean deselect(FeatureReference reference)

Removes a feature from the selection.

Parameters:

reference - the deselected feature reference

Returns:

true if the feature was selected before deselecting it

selectAll

void selectAll()
        throws DataException

Selects all values.

Throws:

DataException - if there is an error selecting all values

deselectAll

void deselectAll()
          throws DataException

Deselects all values.

Throws:

DataException - if there is an error deselecting all values

isSelected

boolean isSelected(FeatureReference reference)

Returns if a feature is selected.

Parameters:

reference - to check

Returns:

if it is selected

reverse

void reverse()

Reverses the selection. Currently selected objects will become the not selected ones, so any other object will be a selected one.

getSelectedCount

long getSelectedCount()

Returns the number of selected values.

Returns:

the number of selected values

referenceIterator

java.util.Iterator<FeatureReference> referenceIterator()

Returns an unmodifiable Iterator of selected feature references.

Returns:

the iterator of selected feature references

referenceIterable

java.lang.Iterable<FeatureReference> referenceIterable()

isAvailable

boolean isAvailable()