org.gvsig.fmap.dal.feature.impl

Class DefaultFeatureReferenceSelection

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.feature.impl.DefaultFeatureReferenceSelection

All Implemented Interfaces:

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

public class DefaultFeatureReferenceSelection
extends AbstractDisposable
implements FeatureReferenceSelection

Default implementation of a FeatureReferenceSelection, based on the usage of a java.util.Set to store individual selected or not selected FeatureReferences, depending on the usage of the reverse() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultFeatureReferenceSelection.SelectionData

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DYNCLASS_PERSISTENT_NAME
protected static Logger	LOGGER
protected DefaultFeatureReferenceSelection.SelectionData	selectionData

Constructor Summary

Constructors

Constructor and Description
DefaultFeatureReferenceSelection() Constructor used by the persistence manager.
DefaultFeatureReferenceSelection(DefaultFeatureStore featureStore) Creates a new Selection with the total size of Features from which the selection will be performed.
DefaultFeatureReferenceSelection(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	accept(Visitor visitor) Provides each value of this Store to the provided Visitor.
void	addObserver(Observer observer)
void	beginComplexNotification() Sets the Observable in complex notification mode.
protected void	clearFeatureReferences() Removes all the stored FeatureRefence objects.
java.lang.Object	clone()
void	deleteObserver(Observer observer)
void	deleteObservers()
boolean	deselect(FeatureReference reference) Removes a feature from the selection.
boolean	deselect(FeatureReference reference, boolean undoable)
void	deselectAll() Deselects all values.
void	deselectAll(boolean undoable)
void	disableNotifications() Disable the notification of events to registered Observers.
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
void	enableNotifications() Enable (default) the notification of events to registered Observers.
void	endComplexNotification() Ends the complex notification mode.
protected FeatureCommandsStack	getCommands() Returns the reference to the commands record.
DefaultFeatureReferenceSelection.SelectionData	getData()
FeatureStore	getFeatureStore() Returns the FeatureStore of the selected FeatureReferences.
long	getSelectedCount() Returns the number of selected values.
boolean	inComplex()
boolean	isAvailable()
boolean	isEmpty()
boolean	isEnabledNotifications()
boolean	isFromStore(DataStore store) Indicates whether this DataSet belongs to a specific store
protected boolean	isReversed()
boolean	isSelected(FeatureReference reference) Returns if a feature is selected.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	notifyObservers()
void	notifyObservers(java.lang.Object arg)
java.lang.Iterable<FeatureReference>	referenceIterable()
FeatureReferenceIterator	referenceIterator() Returns an unmodifiable Iterator of selected feature references.
static void	registerPersistent()
void	reverse() Reverses the selection.
void	reverse(boolean undoable)
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
boolean	select(FeatureReference reference) Adds a feature to the selection.
boolean	select(FeatureReference reference, boolean undoable)
void	selectAll() Selects all values.
void	selectAll(boolean undoable)
void	setData(DefaultFeatureReferenceSelection.SelectionData selectionData)
java.lang.String	toString()
void	update(Observable observable, java.lang.Object notification) Called whenever a Observable object is changed and this Observer has registered on it to receive notifications.

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

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

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

accept

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

dispose

Field Detail

LOGGER

protected static final Logger LOGGER

DYNCLASS_PERSISTENT_NAME

public static final java.lang.String DYNCLASS_PERSISTENT_NAME

See Also:

Constant Field Values

selectionData

protected DefaultFeatureReferenceSelection.SelectionData selectionData

Constructor Detail

DefaultFeatureReferenceSelection

public DefaultFeatureReferenceSelection(DefaultFeatureStore featureStore)
                                 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

Throws:

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

DefaultFeatureReferenceSelection

public DefaultFeatureReferenceSelection(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.

DefaultFeatureReferenceSelection

public DefaultFeatureReferenceSelection()

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

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)

Parameters:

reference -

undoable - if the action must be undoable

Returns:

See Also:

select(FeatureReference)

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)

Parameters:

reference -

undoable - if the action must be undoable

Returns:

See Also:

deselect(FeatureReference)

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

selectAll

public void selectAll(boolean undoable)
               throws DataException

Parameters:

undoable - if the action must be undoable

Throws:

DataException

See Also:

selectAll()

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

Parameters:

undoable - if the action must be undoable

Throws:

DataException

See Also:

deselectAll()

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

reverse

public void reverse(boolean undoable)

Parameters:

undoable - if the action must be undoable

See Also:

reverse()

isEmpty

public boolean isEmpty()

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

referenceIterator

public FeatureReferenceIterator 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

referenceIterable

public java.lang.Iterable<FeatureReference> referenceIterable()

Specified by:

referenceIterable in interface FeatureReferenceSelection

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Specified by:

doDispose in class AbstractDisposable

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

isFromStore

public boolean isFromStore(DataStore store)

Description copied from interface: DataSet

Indicates whether this DataSet belongs to a specific store

Specified by:

isFromStore in interface DataSet

Parameters:

store - a DataStore

Returns:

true if this belongs to the given DataStore, false if not.

accept

public void accept(Visitor visitor)
            throws BaseException

Description copied from interface: DataSet

Provides each value of this Store to the provided Visitor. The values received through the Visitor.visit(Object) method may be transient, reused or externally modifiable, so they can't be used to be stored in any external form out of the visit method. If you need to store any of the values out of the Visitor.visit(Object) method execution, create a copy or clone the received value in order to be stored.

Specified by:

accept in interface DataSet

Specified by:

accept in interface Visitable

Parameters:

visitor - the visitor to apply to each value.

Throws:

BaseException - if there is an error while performing the visit

update

public void update(Observable observable,
                   java.lang.Object notification)

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:

observable - the observable object.

notification - the notification data.

getData

public DefaultFeatureReferenceSelection.SelectionData getData()

setData

public void setData(DefaultFeatureReferenceSelection.SelectionData selectionData)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isReversed

protected boolean isReversed()

clearFeatureReferences

protected void clearFeatureReferences()

Removes all the stored FeatureRefence objects.

getFeatureStore

public FeatureStore getFeatureStore()

Returns the FeatureStore of the selected FeatureReferences.

Returns:

the featureStore

getCommands

protected FeatureCommandsStack getCommands()

Returns the reference to the commands record.

Returns:

the reference to the commands record

saveToState

public void saveToState(PersistentState state)
                 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

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

registerPersistent

public static void registerPersistent()

addObserver

public void addObserver(Observer observer)

Specified by:

addObserver 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

deleteObserver

public void deleteObserver(Observer observer)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable

disableNotifications

public void disableNotifications()

Description copied from interface: ComplexObservable

Disable the notification of events to registered Observers.

Specified by:

disableNotifications in interface ComplexObservable

enableNotifications

public void enableNotifications()

Description copied from interface: ComplexObservable

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

Specified by:

enableNotifications 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

inComplex

public boolean inComplex()

isEnabledNotifications

public boolean isEnabledNotifications()

notifyObservers

public void notifyObservers()

notifyObservers

public void notifyObservers(java.lang.Object arg)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface FeatureReferenceSelection