org.gvsig.fmap.dal.feature.impl

Class IndexFeatureSet

java.lang.Object

org.gvsig.tools.visitor.impl.AbstractVisitable

org.gvsig.tools.visitor.impl.AbstractIndexedVisitable

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

org.gvsig.fmap.dal.feature.impl.IndexFeatureSet

All Implemented Interfaces:

Iterable<Feature>, DataSet, FeatureSet, FeatureSetProvider, Disposable, IndexedVisitable, Visitable

public class IndexFeatureSet
extends AbstractFeatureSet
implements FeatureSet, FeatureSetProvider, Iterable<Feature>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IndexFeatureSet.FastIndexIterator
class	IndexFeatureSet.IndexIterator

Field Summary

Fields inherited from class org.gvsig.fmap.dal.feature.impl.featureset.AbstractFeatureSet

LOG

Constructor Summary

Constructors

Constructor and Description
IndexFeatureSet(FeatureIndexProviderServices index, LongList featureReferences)

Method Summary

Modifier and Type	Method and Description
boolean	canFilter()
boolean	canIterateFromIndex()
boolean	canOrder()
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.
DisposableIterator	fastIterator(long index) Returns a fast iterator over this set, starting from the given index.
DisposableIterator	fastIterator(long index, long elements) Returns an iterator over the elements in this set, in the order (if any) defined when the collection was obtained.
FeatureType	getDefaultFeatureType() Returns the default FeatureType of this FeatureSet.
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.
DisposableIterator	iterator(long index) Returns an iterator over the elements in this collection, in the order (if any) defined when the collection was obtained.
DisposableIterator	iterator(long index, long elements) Returns an iterator over the elements in this set, in the order (if any) defined when the collection was obtained.
void	update(EditableFeature feature) Updates a Feature with the given EditableFeature.

Methods inherited from class org.gvsig.fmap.dal.feature.impl.featureset.AbstractFeatureSet

accept, doAccept, doAccept, fastIterator, first, getDynObjectSet, getDynObjectSet, isFromStore, iterator

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, accept, fastIterator, first, getDynObjectSet, getDynObjectSet, iterator

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

accept, isFromStore

Methods inherited from interface org.gvsig.fmap.dal.feature.spi.FeatureSetProvider

fastIterator, iterator

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

IndexFeatureSet

public IndexFeatureSet(FeatureIndexProviderServices index,
                       LongList featureReferences)

Method Detail

canFilter

public boolean canFilter()

Specified by:

canFilter in interface FeatureSetProvider

canIterateFromIndex

public boolean canIterateFromIndex()

Specified by:

canIterateFromIndex in interface FeatureSetProvider

canOrder

public boolean canOrder()

Specified by:

canOrder in interface FeatureSetProvider

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)

fastIterator

public DisposableIterator fastIterator(long index,
                                       long elements)
                                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 FeatureSet

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(), #fastIterator(long)

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

Specified by:

getSize in interface FeatureSetProvider

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

Specified by:

isEmpty in interface FeatureSetProvider

Overrides:

isEmpty in class AbstractFeatureSet

Returns:

true if this FeatureSet is empty, false otherwise.

Throws:

DataException

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)

iterator

public DisposableIterator iterator(long index,
                                   long elements)
                            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 FeatureSet

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

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

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.

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

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

getFeatureStore

public FeatureStore getFeatureStore()

Specified by:

getFeatureStore in class AbstractFeatureSet