org.gvsig.fmap.dal.feature.spi

Class AbstractFeatureSetProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.feature.spi.AbstractFeatureSetProvider

All Implemented Interfaces:

FeatureSetProvider, Disposable

Direct Known Subclasses:

DBFSetProvider, GPESetProvider, JDBCSetProvider, MemoryFeatureSet, OGRFetureSetProvider

public abstract class AbstractFeatureSetProvider
extends AbstractDisposable
implements FeatureSetProvider

Base implementation for FeatureSetProviders, adding some utility methods.

Constructor Summary

Constructors

Constructor and Description
AbstractFeatureSetProvider(AbstractFeatureStoreProvider store, FeatureQuery query, FeatureType featureType) Creates a new FeatureSetProvider.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract AbstractFeatureProviderIterator	createFastIterator(long index) Creates a new fast Iterator, begginning at the specified data index.
protected abstract AbstractFeatureProviderIterator	createIterator(long index) Creates a new Iterator, begginning at the specified data index.
DisposableIterator	fastIterator() Returns an iterator over the elements in this set, in the order (if any) defined when the collection was obtained.
DisposableIterator	fastIterator(long index) Returns an iterator over the elements in this set, in the order (if any) defined when the collection was obtained.
protected FeatureType	getFeatureType() Returns the type of features to load.
protected FeatureQuery	getQuery() Returns the FeatureQuery used to create this set.
protected AbstractFeatureStoreProvider	getStore() Return the AbstractFeatureStoreProvider.
DisposableIterator	iterator() Returns an iterator over the elements in this set, in the order (if any) defined when the collection was obtained.
DisposableIterator	iterator(long index) Returns an iterator over the elements in this set, in the order (if any) defined when the collection was obtained.

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

dispose, dispose, doDispose

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.spi.FeatureSetProvider

canFilter, canIterateFromIndex, canOrder, getSize, isEmpty

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

dispose

Constructor Detail

AbstractFeatureSetProvider

public AbstractFeatureSetProvider(AbstractFeatureStoreProvider store,
                          FeatureQuery query,
                          FeatureType featureType)

Creates a new FeatureSetProvider.

Parameters:

store - the underlying FeatureStoreProvider to get the data from

query - used to create the FeatureSetProvider

featureType - the type of feature to get

Method Detail

getStore

protected AbstractFeatureStoreProvider getStore()

Return the AbstractFeatureStoreProvider.

Returns:

the store

getQuery

protected FeatureQuery getQuery()

Returns the FeatureQuery used to create this set.

Returns:

the query

getFeatureType

protected FeatureType getFeatureType()

Returns the type of features to load.

Returns:

the featureType

fastIterator

public final DisposableIterator fastIterator()
                                      throws DataException

Description copied from interface: FeatureSetProvider

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

Specified by:

fastIterator in interface FeatureSetProvider

Returns:

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

Throws:

DataException - if there is an error getting the iterator

See Also:

FeatureSetProvider.fastIterator(), FeatureSetProvider.fastIterator(long)

fastIterator

public final DisposableIterator fastIterator(long index)
                                      throws DataException

Description copied from interface: FeatureSetProvider

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

Specified by:

fastIterator in interface FeatureSetProvider

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

Throws:

DataException - if there is an error getting the iterator

See Also:

FeatureSetProvider.fastIterator(), FeatureSetProvider.fastIterator(long)

iterator

public final DisposableIterator iterator()
                                  throws DataException

Description copied from interface: FeatureSetProvider

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

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 FeatureProvider of the iterator, use the FeatureProvider.getCopy() to create a clone of the object.

Specified by:

iterator in interface FeatureSetProvider

Returns:

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

Throws:

DataException - if there is an error getting the iterator

iterator

public final DisposableIterator iterator(long index)
                                  throws DataException

Description copied from interface: FeatureSetProvider

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

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 FeatureProvider of the iterator, use the FeatureProvider.getCopy() to create a clone of the object.

Specified by:

iterator in interface FeatureSetProvider

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

Throws:

DataException - if there is an error getting the iterator

createIterator

protected abstract AbstractFeatureProviderIterator createIterator(long index)
                                                           throws DataException

Creates a new Iterator, begginning at the specified data index.

Parameters:

index - the first element position to be returned by the Iterator

Returns:

a new Iterator

Throws:

DataException - if there is an error creating the Iterator

createFastIterator

protected abstract AbstractFeatureProviderIterator createFastIterator(long index)
                                                               throws DataException

Creates a new fast Iterator, begginning at the specified data index. By fast this means the object instances of data ( FeatureProvider) may be reused between the Iterator.next() method invocations.

Parameters:

index - the first element position to be returned by the Iterator

Returns:

a new Iterator

Throws:

DataException - if there is an error creating the Iterator