org.gvsig.fmap.dal.feature.impl

Class DefaultFeatureSelection

java.lang.Object

org.gvsig.tools.visitor.impl.AbstractVisitable

org.gvsig.tools.visitor.impl.AbstractIndexedVisitable

org.gvsig.fmap.dal.feature.impl.featureset.AbstractFeatureSet

org.gvsig.fmap.dal.feature.impl.DefaultFeatureSelection

All Implemented Interfaces:

Cloneable, DataSelection, DataSet, FeatureReferenceSelection, FeatureSelection, FeatureSet, Disposable, ComplexObservable, Observable, Observer, WeakReferencingObservable, Persistent, IndexedVisitable, Visitable

public class DefaultFeatureSelection
extends AbstractFeatureSet
implements FeatureSelection

Default implementation of the FeatureSelection interface. Internally, only FeatureReference values are stored. This implementation performs better if used with the selection related methods: select, deselect and isSelected ones.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultFeatureSelection.RemoveFromFeatureSelectionException

Field Summary

Fields inherited from class org.gvsig.fmap.dal.feature.impl.featureset.AbstractFeatureSet

LOG

Constructor Summary

Constructors

Constructor and Description
DefaultFeatureSelection() Constructor used by the persistence manager.
DefaultFeatureSelection(DefaultFeatureStore featureStore) Creates a DefaultFeatureSelection, with a FeatureStore.
DefaultFeatureSelection(FeatureStore featureStore, FeatureSelectionHelper helper) Creates a new Selection with the total size of Features from which the selection will be performed.

Method Summary

Modifier and Type	Method and Description
void	addObserver(Observer obsrvr)
void	beginComplexNotification() Sets the Observable in complex notification mode.
protected void	clearFeatureReferences()
Object	clone() Creates a copy of the object.
void	delete(Feature feature) Deletes a Feature from this FeatureSet.
void	deleteObserver(Observer obsrvr)
void	deleteObservers()
boolean	deselect(Feature feature) Removes a feature from the selection.
boolean	deselect(Feature feature, boolean undoable)
boolean	deselect(FeatureReference reference) Removes a feature from the selection.
boolean	deselect(FeatureReference reference, boolean undoable)
boolean	deselect(FeatureSet features) Removes a DataSet of features from the selection.
boolean	deselect(FeatureSet features, boolean undoable)
void	deselectAll() Deselects all values.
void	deselectAll(boolean undoable)
void	disableNotifications() Disable the notification of events to registered Observers.
void	dispose() Disposes the current object, to allow it to close and dispose any used resources.
protected void	doAccept(Visitor visitor, long firstValueIndex, long elements)
protected void	doDispose()
void	enableNotifications() Enable (default) the notification of events to registered Observers.
void	endComplexNotification() Ends the complex notification mode.
DisposableIterator	fastIterator(long index) Returns the list of selected values, or the deselected ones if the selection has been reversed.
DisposableIterator	fastIterator(long index, long elements)
FeatureCommandsStack	getCommands()
DefaultFeatureReferenceSelection.SelectionData	getData()
FeatureType	getDefaultFeatureType() Returns the default FeatureType of this FeatureSet.
FeatureStore	getFeatureStore()
List	getFeatureTypes() Returns a list of the FeatureType(s) in this FeatureSet.
long	getSelectedCount() Returns the number of selected values.
long	getSize() Returns the number of Feature(s) contained in this FeatureSet.
void	insert(EditableFeature feature) Inserts a new feature in this set.
boolean	isReversed()
boolean	isSelected(Feature feature) Returns if a feature is selected.
boolean	isSelected(FeatureReference reference) Returns if a feature is selected.
DisposableIterator	iterator(long index) Returns the list of selected values, or the deselected ones if the selection has been reversed.
DisposableIterator	iterator(long index, long elements)
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
Iterator	referenceIterator() Returns an unmodifiable Iterator of selected feature references.
static void	registerPersistent()
void	reverse() Reverses the selection.
void	saveToState(PersistentState ps) Saves the internal state of the object on the provided PersistentState object.
boolean	select(Feature feature) Adds a feature to the selection.
boolean	select(Feature feature, boolean undoable)
boolean	select(FeatureReference reference) Adds a feature to the selection.
boolean	select(FeatureReference reference, boolean undoable)
boolean	select(FeatureSet features) Adds a DataSet of features to the selection.
boolean	select(FeatureSet features, boolean undoable)
void	selectAll() Selects all values.
void	update(EditableFeature feature) Updates a Feature with the given EditableFeature.
void	update(Observable o, Object o1) Called whenever a Observable object is changed and this Observer has registered on it to receive notifications.

Methods inherited from class org.gvsig.fmap.dal.feature.impl.featureset.AbstractFeatureSet

accept, doAccept, fastIterator, first, getDynObjectSet, getDynObjectSet, isEmpty, isFromStore, iterator

Methods inherited from class org.gvsig.tools.visitor.impl.AbstractIndexedVisitable

accept, doAccept

Methods inherited from class org.gvsig.tools.visitor.impl.AbstractVisitable

accept

Methods inherited from class java.lang.Object

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

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

accept, isFromStore

Methods inherited from interface org.gvsig.fmap.dal.feature.FeatureSet

accept, accept, fastIterator, first, getDynObjectSet, getDynObjectSet, isEmpty, iterator

Constructor Detail

DefaultFeatureSelection

public DefaultFeatureSelection(DefaultFeatureStore featureStore)
                        throws DataException

Creates a DefaultFeatureSelection, with a FeatureStore.

Parameters:

featureStore - the FeatureStore to load Features from

Throws:

DataException - if there is an error while getting the total number of Features of the Store.

See Also:

AbstractSetBasedDataSelection#DefaultSelection(int)

DefaultFeatureSelection

public DefaultFeatureSelection(FeatureStore featureStore,
                               FeatureSelectionHelper helper)
                        throws DataException

Creates a new Selection with the total size of Features from which the selection will be performed.

Parameters:

featureStore - the FeatureStore of the selected FeatureReferences

helper - to get some information of the Store

Throws:

DataException - if there is an error while getting the total number of Features of the Store.

DefaultFeatureSelection

public DefaultFeatureSelection()

Constructor used by the persistence manager. Don't use directly. After to invoke this method, the persistence manager calls the the method loadFromState(PersistentState) to set the values of the internal attributes that this class needs to work.

Method Detail

getFeatureStore

public FeatureStore getFeatureStore()

Specified by:

getFeatureStore in class AbstractFeatureSet

getCommands

public FeatureCommandsStack getCommands()

enableNotifications

public void enableNotifications()

Description copied from interface: ComplexObservable

Enable (default) the notification of events to registered Observers.

Specified by:

enableNotifications in interface ComplexObservable

disableNotifications

public void disableNotifications()

Description copied from interface: ComplexObservable

Disable the notification of events to registered Observers.

Specified by:

disableNotifications in interface ComplexObservable

isReversed

public boolean isReversed()

getSelectedCount

public long getSelectedCount()

Description copied from interface: FeatureReferenceSelection

Returns the number of selected values.

Specified by:

getSelectedCount in interface FeatureReferenceSelection

Returns:

the number of selected values

getData

public DefaultFeatureReferenceSelection.SelectionData getData()

select

public boolean select(FeatureReference reference)

Description copied from interface: FeatureReferenceSelection

Adds a feature to the selection.

Specified by:

select in interface FeatureReferenceSelection

Parameters:

reference - the selected feature reference

Returns:

true if the feature was not selected before selecting it

select

public boolean select(FeatureReference reference,
                      boolean undoable)

deselect

public boolean deselect(FeatureReference reference)

Description copied from interface: FeatureReferenceSelection

Removes a feature from the selection.

Specified by:

deselect in interface FeatureReferenceSelection

Parameters:

reference - the deselected feature reference

Returns:

true if the feature was selected before deselecting it

deselect

public boolean deselect(FeatureReference reference,
                        boolean undoable)

referenceIterator

public Iterator referenceIterator()

Description copied from interface: FeatureReferenceSelection

Returns an unmodifiable Iterator of selected feature references.

Specified by:

referenceIterator in interface FeatureReferenceSelection

Returns:

the iterator of selected feature references

selectAll

public void selectAll()
               throws DataException

Description copied from interface: FeatureReferenceSelection

Selects all values.

Specified by:

selectAll in interface FeatureReferenceSelection

Throws:

DataException - if there is an error selecting all values

deselectAll

public void deselectAll()
                 throws DataException

Description copied from interface: FeatureReferenceSelection

Deselects all values.

Specified by:

deselectAll in interface FeatureReferenceSelection

Throws:

DataException - if there is an error deselecting all values

deselectAll

public void deselectAll(boolean undoable)
                 throws DataException

Throws:

DataException

isSelected

public boolean isSelected(FeatureReference reference)

Description copied from interface: FeatureReferenceSelection

Returns if a feature is selected.

Specified by:

isSelected in interface FeatureReferenceSelection

Parameters:

reference - to check

Returns:

if it is selected

reverse

public void reverse()

Description copied from interface: FeatureReferenceSelection

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

Specified by:

reverse in interface FeatureReferenceSelection

dispose

public void dispose()

Description copied from interface: Disposable

Disposes the current object, to allow it to close and dispose any used resources.

NOTE:After calling this method, the object may not be usable anymore.

Specified by:

dispose in interface Disposable

update

public void update(Observable o,
                   Object o1)

Description copied from interface: Observer

Called whenever a Observable object is changed and this Observer has registered on it to receive notifications.

Implementations of this method will be called for each simple notification or, if a complex notification is created, for each of the child notifications.

In the latter case, don't assume any ordering in the notification between this Observer and other Observers listening to the same Observable.

In a complex notification scenario, if you want to receive only the complex notification and not each of the child notifications, just implement the ComplexObserver and prepare this method implementation to handle receiving DefaultComplexNotification instances as well as direct notification objects.

Specified by:

update in interface Observer

Parameters:

o - the observable object.

o1 - the notification data.

addObserver

public void addObserver(Observer obsrvr)

Specified by:

addObserver in interface Observable

deleteObserver

public void deleteObserver(Observer obsrvr)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable

beginComplexNotification

public void beginComplexNotification()

Description copied from interface: ComplexObservable

Sets the Observable in complex notification mode. All notifications must be stored, until the mode ends, and then notify all Observers with all the notifications.

Specified by:

beginComplexNotification in interface ComplexObservable

endComplexNotification

public void endComplexNotification()

Description copied from interface: ComplexObservable

Ends the complex notification mode. All notifications stored while in complex notification mode, will be notified to the registered Observers.

If a observer is a ComplexObserver, it will be notified with a single DefaultComplexNotification instead of each of the notifications.

Some important notes to take into account when calling this method.

• Observers must not rely in the order used to perform the notifications. The notifications order is maintained, but the notification to all the observers might be performed for each notification to all observers, or for each observer all notifications.
• The notification process works as an atomic action, so if while an Observer is processing a notification another Observer is registered to the source Observable, it won't get any of the notifications currently being notified, but future ones.

Specified by:

endComplexNotification in interface ComplexObservable

saveToState

public void saveToState(PersistentState ps)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Throws:

PersistenceException

select

public boolean select(Feature feature)

Description copied from interface: FeatureSelection

Adds a feature to the selection.

Specified by:

select in interface FeatureSelection

Parameters:

feature - the selected feature

Returns:

true if the feature was not selected before selecting it

select

public boolean select(Feature feature,
                      boolean undoable)

Parameters:

feature -

undoable - if the action must be undoable

Returns:

See Also:

select(Feature)

select

public boolean select(FeatureSet features)
               throws DataException

Description copied from interface: FeatureSelection

Adds a DataSet of features to the selection.

Specified by:

select in interface FeatureSelection

Parameters:

features - the selected features

Returns:

true if any of the feature was not selected before selecting it

Throws:

DataException - if there is an error reading the FeatureSet values

select

public boolean select(FeatureSet features,
                      boolean undoable)
               throws DataException

Parameters:

features -

undoable - if the action must be undoable

Returns:

Throws:

DataException

See Also:

select(FeatureSet)

deselect

public boolean deselect(Feature feature)

Description copied from interface: FeatureSelection

Removes a feature from the selection.

Specified by:

deselect in interface FeatureSelection

Parameters:

feature - the deselected feature

Returns:

true if the feature was selected before deselecting it

deselect

public boolean deselect(Feature feature,
                        boolean undoable)

Parameters:

feature -

undoable - if the action must be undoable

Returns:

See Also:

deselect(Feature)

deselect

public boolean deselect(FeatureSet features)
                 throws DataException

Description copied from interface: FeatureSelection

Removes a DataSet of features from the selection.

Specified by:

deselect in interface FeatureSelection

Parameters:

features - the deselected features

Returns:

true if any of the features was selected before deselecting it

Throws:

DataException - if there is an error reading the FeatureSet values

deselect

public boolean deselect(FeatureSet features,
                        boolean undoable)
                 throws DataException

Parameters:

features -

undoable - if the action must be undoable

Returns:

Throws:

DataException

See Also:

deselect(FeatureSet)

isSelected

public boolean isSelected(Feature feature)

Description copied from interface: FeatureSelection

Returns if a feature is selected.

Specified by:

isSelected in interface FeatureSelection

Parameters:

feature - to check

Returns:

if it is selected

getDefaultFeatureType

public FeatureType getDefaultFeatureType()

Description copied from interface: FeatureSet

Returns the default FeatureType of this FeatureSet.

Specified by:

getDefaultFeatureType in interface FeatureSet

Returns:

default FeatureType in this FeatureSet.

getFeatureTypes

public List getFeatureTypes()

Description copied from interface: FeatureSet

Returns a list of the FeatureType(s) in this FeatureSet.

Specified by:

getFeatureTypes in interface FeatureSet

Returns:

list of the FeatureType(s) in this FeatureSet.

getSize

public long getSize()
             throws DataException

Description copied from interface: FeatureSet

Returns the number of Feature(s) contained in this FeatureSet. The value returned by this method won't be accurate when the FeatureStore is being edited and this set's features are modified, added or deleted.

Specified by:

getSize in interface FeatureSet

Returns:

number of Feature(s) contained in this FeatureSet.

Throws:

DataException

iterator

public DisposableIterator iterator(long index)

Returns the list of selected values, or the deselected ones if the selection has been reversed. WARN: not very good performance implementation.

Specified by:

iterator in interface FeatureSet

Parameters:

index - index of first element to be returned from the iterator (by a call to the next method).

Returns:

an iterator of the elements in this collection (in proper sequence), starting at the specified position in the collection.

See Also:

DataSet.accept(org.gvsig.tools.visitor.Visitor), FeatureSet.accept(org.gvsig.tools.visitor.Visitor, long), FeatureSet.fastIterator(), FeatureSet.fastIterator(long)

iterator

public DisposableIterator iterator(long index,
                                   long elements)

Specified by:

iterator in interface FeatureSet

fastIterator

public DisposableIterator fastIterator(long index)

Returns the list of selected values, or the deselected ones if the selection has been reversed. WARN: not really a fast implementation.

Specified by:

fastIterator in interface FeatureSet

Parameters:

index - position in which the iterator is initially located.

Returns:

an iterator initially located at the position indicated by the given index

See Also:

DataSet.accept(org.gvsig.tools.visitor.Visitor), FeatureSet.accept(org.gvsig.tools.visitor.Visitor, long)

fastIterator

public DisposableIterator fastIterator(long index,
                                       long elements)

Specified by:

fastIterator in interface FeatureSet

clearFeatureReferences

protected void clearFeatureReferences()

delete

public void delete(Feature feature)
            throws DataException

Description copied from interface: FeatureSet

Deletes a Feature from this FeatureSet.
Any DisposableIterator from this store that was still in use will be unsafe. Use Iterator.remove() instead.

Specified by:

delete in interface FeatureSet

Parameters:

feature - the Feature to delete.

Throws:

DataException

insert

public void insert(EditableFeature feature)
            throws DataException

Description copied from interface: FeatureSet

Inserts a new feature in this set. It needs to be an instance of EditableFeature as it has not been stored yet.
Any DisposableIterator from this store that was still in use can will not reflect this change.

Specified by:

insert in interface FeatureSet

Parameters:

feature - the EditableFeature to insert.

Throws:

DataException

update

public void update(EditableFeature feature)
            throws DataException

Description copied from interface: FeatureSet

Updates a Feature with the given EditableFeature.
Any DisposableIterator from this store that was still in use can will not reflect this change.

Specified by:

update in interface FeatureSet

Parameters:

feature - an instance of EditableFeature with which to update the associated Feature.

Throws:

DataException

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Throws:

PersistenceException

doDispose

protected void doDispose()
                  throws BaseException

Throws:

BaseException

registerPersistent

public static void registerPersistent()

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class Object

Returns:

a copy of the object

Throws:

CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

doAccept

protected void doAccept(Visitor visitor,
                        long firstValueIndex,
                        long elements)
                 throws BaseException

Overrides:

doAccept in class AbstractFeatureSet

Throws:

BaseException