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

Class AbstractFeatureSet

java.lang.Object

org.gvsig.tools.visitor.impl.AbstractVisitable

org.gvsig.tools.visitor.impl.AbstractIndexedVisitable

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

All Implemented Interfaces:

DataSet, FeatureSet, Disposable, IndexedVisitable, Visitable

Direct Known Subclasses:

DefaultFeatureSelection, DefaultFeatureSet, IndexFeatureSet

public abstract class AbstractFeatureSet
extends AbstractIndexedVisitable
implements FeatureSet

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Constructor Summary

Constructors

Constructor and Description
AbstractFeatureSet()

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor visitor, long firstValueIndex, long elements)
protected void	doAccept(Visitor visitor, long firstValueIndex) Provides each value of this container to the provided Visitor.
protected void	doAccept(Visitor visitor, long firstValueIndex, long elements)
DisposableIterator	fastIterator() Returns a fast iterator over this set.
Feature	first() Return the first feature of the set.
DynObjectSet	getDynObjectSet() Returns a DynObjectSet of the contents of this set.
DynObjectSet	getDynObjectSet(boolean fast) Returns a DynObjectSet of the contents of this set.
abstract FeatureStore	getFeatureStore()
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.

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, delete, fastIterator, fastIterator, getDefaultFeatureType, getFeatureTypes, getSize, insert, iterator, iterator, update

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

accept

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

dispose

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

AbstractFeatureSet

public AbstractFeatureSet()

Method Detail

getFeatureStore

public abstract FeatureStore getFeatureStore()

accept

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

Specified by:

accept in interface FeatureSet

Throws:

BaseException

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

doAccept

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

Throws:

VisitCanceledException

BaseException

first

public Feature first()

Description copied from interface: FeatureSet

Return the first feature of the set. If the set is empty return null. This not is a good method to determine if the set is empty. Use isEmpty instead. This is a utility method that call iterator and retrieve the first feature of the iterator.

Specified by:

first in interface FeatureSet

Returns:

the first fearure of the set or null.

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)

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)

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

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.