org.gvsig.fmap.dal.feature.paging
Interface FeaturePagingHelper

All Superinterfaces:

DynObjectPagingHelper, PagingCalculator

public interface FeaturePagingHelper
extends DynObjectPagingHelper

Helper interface to access the values of a FeatureCollection by position.

Author:

gvSIG team

Nested Class Summary

Nested classes/interfaces inherited from interface org.gvsig.tools.paging.PagingCalculator

PagingCalculator.Sizeable

Field Summary

Fields inherited from interface org.gvsig.tools.paging.PagingCalculator

DEFAULT_PAGE_SIZE

Method Summary

void	delete(Feature feature) Deletes a Feature from current FeatureSet.
Feature[]	getCurrentPageFeatures() Returns all the values of the current loaded page.
Feature	getFeatureAt(long index) Returns the Feature located at the index position.
FeatureQuery	getFeatureQuery() Returns the query used to load the Features.
FeatureSet	getFeatureSet() Returns the FeatureSet used to fetch the data.
FeatureStore	getFeatureStore() Returns the FeatureStore used to fetch the data.
FeatureType	getFeatureType() Returns the FeatureType used of the data.
void	insert(EditableFeature feature) Inserts a new feature in this FeatureSet.
void	setSelectionUp(boolean selectionUp) Sets that the selected Features get returned first.
void	update(EditableFeature feature) Updates a Feature with the given EditableFeature in the current FeatureSet.

Methods inherited from interface org.gvsig.tools.dynobject.DynObjectPagingHelper

getCurrentPageDynObjects, getDynObjectAt, getDynObjectSet, reload, reloadCurrentPage

Methods inherited from interface org.gvsig.tools.paging.PagingCalculator

getCurrentPage, getCurrentPageSize, getInitialIndex, getMaxPageSize, getNumPages, getTotalSize, setCurrentPage, setMaxPageSize

Method Detail

getFeatureAt

Feature getFeatureAt(long index)
                     throws BaseException

Returns the Feature located at the index position.

Parameters:

index - to locate the Feature in the Collection

Returns:

the Feature located at the index position

Throws:

BaseException - if there is an error getting the Feature

getCurrentPageFeatures

Feature[] getCurrentPageFeatures()

Returns all the values of the current loaded page.

Returns:

all the values of the current loaded page

getFeatureSet

FeatureSet getFeatureSet()

Returns the FeatureSet used to fetch the data.

Returns:

the FeatureSet

getFeatureStore

FeatureStore getFeatureStore()

Returns the FeatureStore used to fetch the data.

Returns:

the FeatureStore

getFeatureQuery

FeatureQuery getFeatureQuery()

Returns the query used to load the Features.

Returns:

the query used to load the Features

getFeatureType

FeatureType getFeatureType()

Returns the FeatureType used of the data.

Returns:

the FeatureType of the data

update

void update(EditableFeature feature)
            throws BaseException

Updates a Feature with the given EditableFeature in the current FeatureSet.

Parameters:

feature - an instance of EditableFeature with which to update the associated Feature.

Throws:

BaseException

See Also:

FeatureSet#update(EditableFeature)} {@link FeaturePagingHelper#getFeatureSet()}

delete

void delete(Feature feature)
            throws BaseException

Deletes a Feature from current FeatureSet.

Parameters:

feature - the Feature to delete.

Throws:

BaseException

See Also:

FeatureSet#delete(Feature)} {@link FeaturePagingHelper#getFeatureSet()}

insert

void insert(EditableFeature feature)
            throws BaseException

Inserts a new feature in this FeatureSet. It needs to be an instance of EditableFeature as it has not been stored yet.
Any Iterator from this store that was still in use can will not reflect this change.

Parameters:

feature - the EditableFeature to insert.

Throws:

BaseException

See Also:

FeatureSet#insert(EditableFeature)} {@link FeaturePagingHelper#getFeatureSet()}

setSelectionUp

void setSelectionUp(boolean selectionUp)

Sets that the selected Features get returned first.