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

Class DefaultFeatureSet

java.lang.Object

org.gvsig.tools.visitor.impl.AbstractVisitable

org.gvsig.tools.visitor.impl.AbstractIndexedVisitable

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

All Implemented Interfaces:

DataSet, FeatureSet, Disposable, Observer, IndexedVisitable, Visitable

public class DefaultFeatureSet
extends AbstractIndexedVisitable
implements FeatureSet, Observer

Constructor Summary

Constructors

Constructor and Description
DefaultFeatureSet(DefaultFeatureStore store, FeatureQuery query)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkSourceStoreModified()
void	delete(Feature feature) Deletes a Feature from this FeatureSet.
void	dispose() Disposes the current object, to allow it to close and dispose any used resources.
protected void	doAccept(Visitor visitor, long firstValueIndex) Provides each value of this container to the provided Visitor.
DisposableIterator	fastIterator() Returns a fast iterator over this set.
DisposableIterator	fastIterator(long index) Returns a fast iterator over this set, starting from the given index.
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.
FeatureStore	getFeatureStore()
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	isFromStore(DataStore store) Indicates whether this DataSet belongs to a specific store
DisposableIterator	iterator() Returns an iterator over the elements in this collection, in the order (if any) defined when the collection was obtained.
DisposableIterator	iterator(long index) Returns an iterator over the elements in this collection, in the order (if any) defined when the collection was obtained.
void	update(EditableFeature feature) Updates a Feature with the given EditableFeature.
void	update(Observable obsevable, 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.visitor.impl.AbstractIndexedVisitable

accept, doAccept

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

accept

Methods inherited from class java.lang.Object

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

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

accept

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

accept

Constructor Detail

DefaultFeatureSet

public DefaultFeatureSet(DefaultFeatureStore store,
                 FeatureQuery query)
                  throws DataException

Throws:

DataException

Method Detail

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

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

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.

update

public void update(Observable obsevable,
          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:

obsevable - the observable object.

notification - the notification data.

doAccept

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

Description copied from class: AbstractIndexedVisitable

Provides each value of this container to the provided Visitor. The VisitCanceledException will be managed by the parent AbstractIndexedVisitable class, so simply throw it.

Specified by:

doAccept in class AbstractIndexedVisitable

Throws:

VisitCanceledException

BaseException

checkSourceStoreModified

protected void checkSourceStoreModified()

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

fastIterator

public DisposableIterator fastIterator()
                                throws DataException

Description copied from interface: FeatureSet

Returns a fast iterator over this set.

Fast in this case means that each of the elements returned may be a reused or pooled object instance, so don't use it to be stored in any way.

If you need to store one of the Feature of the iterator, use the Feature.getCopy() to create a clone of the object.

NOTE: if you use this method to get the iterator, you must get sure the iterator is disposed (@see Disposable.dispose()) in any case, even if an error occurs while getting the data. It is recommended to use the accept methods instead, which handle everything for you. Take into account the accept methods may use a fast iterator to get the features.

Specified by:

fastIterator in interface FeatureSet

Returns:

an iterator over this set.

Throws:

DataException

See Also:

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

fastIterator

public DisposableIterator fastIterator(long index)
                                throws DataException

Description copied from interface: FeatureSet

Returns a fast iterator over this set, starting from the given index.

Fast in this case means that each of the elements returned may be a reused or pooled object instance, so don't use it to be stored in any way.

If you need to store one of the Feature of the iterator, use the Feature.getCopy() to create a clone of the object.

NOTE: if you use this method to get the iterator, you must get sure the iterator is disposed (@see Disposable.dispose()) in any case, even if an error occurs while getting the data. It is recommended to use the accept methods instead, which handle everything for you. Take into account the accept methods may use a fast iterator to get the features.

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

Throws:

DataException

See Also:

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

iterator

public DisposableIterator iterator()

Description copied from interface: FeatureSet

Returns an iterator over the elements in this collection, in the order (if any) defined when the collection was obtained.

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)
                            throws DataException

Description copied from interface: FeatureSet

Returns an iterator over the elements in this collection, in the order (if any) defined when the collection was obtained. The iterator starts at the specified position in this collection. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

NOTE: if you use this method to get the iterator, you must get sure the iterator is disposed (@see Disposable.dispose()) in any case, even if an error occurs while getting the data. It is recommended to use the accept methods instead, which handle everything for you. Take into account the accept methods may use a fast iterator to get the features.

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.

Throws:

DataException - if the index is out of range (index < 0 || index > size()).

See Also:

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

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

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

getFeatureStore

public FeatureStore getFeatureStore()