org.gvsig.fmap.dal.feature.impl

Class DefaultFeatureSelection

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

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

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 DefaultFeatureReferenceSelection
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/interfaces inherited from class org.gvsig.fmap.dal.feature.impl.DefaultFeatureReferenceSelection

DefaultFeatureReferenceSelection.SelectionData

Field Summary

Fields inherited from class org.gvsig.fmap.dal.feature.impl.DefaultFeatureReferenceSelection

DYNCLASS_PERSISTENT_NAME, selectionData

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

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Provides each value of this Store to the provided Visitor.
void	accept(Visitor visitor, long firstValueIndex) Provides each value of this Store to the provided Visitor, beginning from the provided index position.
protected void	clearFeatureReferences() Removes all the stored FeatureRefence objects.
Object	clone() Creates a copy of the object.
void	delete(Feature feature) Deletes a Feature from this FeatureSet.
boolean	deselect(Feature feature) Removes a feature from the selection.
boolean	deselect(Feature feature, boolean undoable)
boolean	deselect(FeatureSet features) Removes a DataSet of features from the selection.
boolean	deselect(FeatureSet features, boolean undoable)
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
DisposableIterator	fastIterator() Returns the list of selected values, or the deselected ones if the selection has been reversed.
DisposableIterator	fastIterator(long index) Returns the list of selected values, or the deselected ones if the selection has been reversed.
FeatureType	getDefaultFeatureType() Returns the default FeatureType of this FeatureSet.
DynObjectSet	getDynObjectSet() Returns a DynObjectSet of the contents of this set.
DynObjectSet	getDynObjectSet(boolean fast) Returns a DynObjectSet of the contents of this set.
List	getFeatureTypes() Returns a list of the FeatureType(s) in this FeatureSet.
long	getSize() Returns the number of Feature(s) contained in this FeatureSet.
void	insert(EditableFeature feature) Inserts a new feature in this set.
boolean	isEmpty() Indicates whether this FeatureSet contains zero features.
boolean	isSelected(Feature feature) Returns if a feature is selected.
DisposableIterator	iterator() Returns the list of selected values, or the deselected ones if the selection has been reversed.
DisposableIterator	iterator(long index) Returns the list of selected values, or the deselected ones if the selection has been reversed.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	registerPersistent()
boolean	select(Feature feature) Adds a feature to the selection.
boolean	select(Feature feature, boolean undoable)
boolean	select(FeatureSet features) Adds a DataSet of features to the selection.
boolean	select(FeatureSet features, boolean undoable)
void	update(EditableFeature feature) Updates a Feature with the given EditableFeature.

Methods inherited from class org.gvsig.fmap.dal.feature.impl.DefaultFeatureReferenceSelection

addObserver, addObserver, addObservers, beginComplexNotification, countObservers, deleteObserver, deleteObserver, deleteObservers, deselect, deselect, deselectAll, deselectAll, disableNotifications, enableNotifications, endComplexNotification, getCommands, getData, getFeatureStore, getSelectedCount, inComplex, isEnabledNotifications, isFromStore, isReversed, isSelected, notifyObservers, notifyObservers, referenceIterator, reverse, reverse, saveToState, select, select, selectAll, selectAll, setData, toString, update

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.fmap.dal.feature.FeatureReferenceSelection

deselect, deselectAll, getSelectedCount, isSelected, referenceIterator, reverse, select, selectAll

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

isFromStore

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

saveToState

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

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:

undoable - if the action must be undoable

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:

undoable - if the action must be undoable

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:

undoable - if the action must be undoable

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:

undoable - if the action must be undoable

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

isEmpty

public boolean isEmpty()
                throws DataException

Description copied from interface: FeatureSet

Indicates whether this FeatureSet contains zero features. 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:

isEmpty in interface FeatureSet

Returns:

true if this FeatureSet is empty, false otherwise.

Throws:

DataException

iterator

public DisposableIterator iterator()

Returns the list of selected values, or the deselected ones if the selection has been reversed.

Specified by:

iterator in interface FeatureSet

Returns:

an iterator of the elements in this collection (in proper sequence).

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)

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)

fastIterator

public DisposableIterator fastIterator()

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

Returns:

an iterator over this set.

See Also:

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

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)

clearFeatureReferences

protected void clearFeatureReferences()

Description copied from class: DefaultFeatureReferenceSelection

Removes all the stored FeatureRefence objects.

Overrides:

clearFeatureReferences in class DefaultFeatureReferenceSelection

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

Overrides:

loadFromState in class DefaultFeatureReferenceSelection

Throws:

PersistenceException

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

Overrides:

accept in class DefaultFeatureReferenceSelection

Parameters:

visitor - the visitor to apply to each value.

Throws:

BaseException - if there is an error while performing the visit

accept

public final void accept(Visitor visitor,
          long firstValueIndex)
                  throws BaseException

Description copied from interface: FeatureSet

Provides each value of this Store to the provided Visitor, beginning from the provided index position. 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 FeatureSet

Specified by:

accept in interface IndexedVisitable

Parameters:

visitor - the visitor to apply to each value.

firstValueIndex - index of first element to be visited by the Visitor

Throws:

BaseException - if there is an error while performing the visit

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

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

Overrides:

doDispose in class DefaultFeatureReferenceSelection

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

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 DefaultFeatureReferenceSelection

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()}.

getDynObjectSet

public DynObjectSet getDynObjectSet()

Description copied from interface: FeatureSet

Returns a DynObjectSet of the contents of this set. Defaults to fast iteration.

Specified by:

getDynObjectSet in interface FeatureSet

Returns:

a DynObjectSet

getDynObjectSet

public DynObjectSet getDynObjectSet(boolean fast)

Description copied from interface: FeatureSet

Returns a DynObjectSet of the contents of this set.

Specified by:

getDynObjectSet in interface FeatureSet

Parameters:

fast - if the set will be able to be iterated in a fast way, by reusing the DynObject instance for each Feature instance.

Returns:

a DynObjectSet