org.gvsig.fmap.dal.feature.paging.impl

Class FeaturePagingHelperImpl

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.tools.dynobject.impl.DefaultDynObjectPagingHelper

org.gvsig.fmap.dal.feature.paging.impl.FeaturePagingHelperImpl

All Implemented Interfaces:

FeaturePagingHelper, Disposable, DynObjectPagingHelper, PagingCalculator

public class FeaturePagingHelperImpl
extends DefaultDynObjectPagingHelper
implements FeaturePagingHelper

Helper class to access the values of a FeatureCollection by position. Handles pagination automatically to avoid filling the memory in case of big collections. TODO: evaluate if its more convenient to read values in the background when the returned value is near the end of the page, instead of loading a page on demand.

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

Constructor Summary

Constructors

Constructor and Description
FeaturePagingHelperImpl(FeatureStore featureStore) Constructs a FeaturePagingHelperImpl from data of a FeatureStore.
FeaturePagingHelperImpl(FeatureStore featureStore, FeatureQuery featureQuery) Constructs a FeaturePagingHelperImpl from data of a FeatureStore.
FeaturePagingHelperImpl(FeatureStore featureStore, FeatureQuery featureQuery, int pageSize) Constructs a FeaturePagingHelperImpl from data of a FeatureStore.
FeaturePagingHelperImpl(FeatureStore featureStore, int pageSize) Constructs a FeaturePagingHelperImpl from data of a FeatureStore.

Method Summary

Methods

Modifier and Type	Method and Description
List	asList() Return a List of Fearures with the contents of this PagingHelper
List	asListOfDynObjects() Return a List of DynObjects with the contents of this PagingHelper
void	delete(Feature feature) Deletes a Feature from current FeatureSet.
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
DynObject[]	getCurrentPageDynObjects() Returns all the values of the current loaded page.
Feature[]	getCurrentPageFeatures() Returns all the values of the current loaded page.
DynObject	getDynObjectAt(long index) Returns the DynObject located at the index position.
DynObjectSet	getDynObjectSet() Returns the DynObjectSet used to fetch the data.
Feature	getFeatureAt(long index) Returns the Feature located at the index position.
FeatureQuery	getFeatureQuery() Returns the query used to load the Features.
FeatureStore	getFeatureStore() Returns the FeatureStore used to fetch the data.
FeatureType	getFeatureType() Returns the FeatureType used of the data.
FeatureSelection	getSelection()
void	insert(EditableFeature feature) Inserts a new feature in this FeatureSet.
boolean	isSelectionUp()
protected void	loadCurrentPageData() Loads all the Features of the current page.
void	reload() Reloads everything.
void	reloadCurrentPage() Reloads the current page of data from the set.
void	setSelection(FeatureSelection selection)
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 class org.gvsig.tools.dynobject.impl.DefaultDynObjectPagingHelper

getCalculator, getCurrentPage, getCurrentPageSize, getInitialIndex, getMaxPageSize, getNumPages, getTotalSize, setCalculator, setCurrentPage, setDefaultCalculator, setDynObjectSet, setMaxPageSize

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

dispose, dispose

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

FeaturePagingHelperImpl

public FeaturePagingHelperImpl(FeatureStore featureStore)
                        throws BaseException

Constructs a FeaturePagingHelperImpl from data of a FeatureStore.

Parameters:

featureStore - to extract data from

Throws:

DataException - if there is an error initializing the helper

BaseException

FeaturePagingHelperImpl

public FeaturePagingHelperImpl(FeatureStore featureStore,
                       int pageSize)
                        throws BaseException

Constructs a FeaturePagingHelperImpl from data of a FeatureStore.

Parameters:

featureStore - to extract data from

pageSize - the number of elements per page data

Throws:

DataException - if there is an error initializing the helper

BaseException

FeaturePagingHelperImpl

public FeaturePagingHelperImpl(FeatureStore featureStore,
                       FeatureQuery featureQuery)
                        throws BaseException

Constructs a FeaturePagingHelperImpl from data of a FeatureStore.

Parameters:

featureStore - to extract data from

Throws:

DataException - if there is an error initializing the helper

BaseException

FeaturePagingHelperImpl

public FeaturePagingHelperImpl(FeatureStore featureStore,
                       FeatureQuery featureQuery,
                       int pageSize)
                        throws BaseException

Constructs a FeaturePagingHelperImpl from data of a FeatureStore.

Parameters:

featureSet - to extract data from

pageSize - the number of elements per page data

Throws:

DataException - if there is an error initializing the helper

BaseException

Method Detail

isSelectionUp

public boolean isSelectionUp()

Specified by:

isSelectionUp in interface FeaturePagingHelper

Returns:

the selectionUp status

getSelection

public FeatureSelection getSelection()

Specified by:

getSelection in interface FeaturePagingHelper

setSelection

public void setSelection(FeatureSelection selection)

Specified by:

setSelection in interface FeaturePagingHelper

setSelectionUp

public void setSelectionUp(boolean selectionUp)

Description copied from interface: FeaturePagingHelper

Sets that the selected Features get returned first.

Specified by:

setSelectionUp in interface FeaturePagingHelper

getFeatureAt

public Feature getFeatureAt(long index)
                     throws BaseException

Description copied from interface: FeaturePagingHelper

Returns the Feature located at the index position.

Specified by:

getFeatureAt in interface FeaturePagingHelper

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

public Feature[] getCurrentPageFeatures()

Description copied from interface: FeaturePagingHelper

Returns all the values of the current loaded page.

Specified by:

getCurrentPageFeatures in interface FeaturePagingHelper

Returns:

all the values of the current loaded page

getDynObjectSet

public DynObjectSet getDynObjectSet()

Description copied from interface: DynObjectPagingHelper

Returns the DynObjectSet used to fetch the data.

Specified by:

getDynObjectSet in interface DynObjectPagingHelper

Overrides:

getDynObjectSet in class DefaultDynObjectPagingHelper

Returns:

the DynObjectSet

reloadCurrentPage

public void reloadCurrentPage()
                       throws BaseException

Description copied from interface: DynObjectPagingHelper

Reloads the current page of data from the set.

Specified by:

reloadCurrentPage in interface DynObjectPagingHelper

Overrides:

reloadCurrentPage in class DefaultDynObjectPagingHelper

Throws:

BaseException - if there is an error reloading the current page

reload

public void reload()
            throws BaseException

Description copied from interface: DynObjectPagingHelper

Reloads everything.

Specified by:

reload in interface DynObjectPagingHelper

Overrides:

reload in class DefaultDynObjectPagingHelper

Throws:

BaseException

getFeatureStore

public FeatureStore getFeatureStore()

Description copied from interface: FeaturePagingHelper

Returns the FeatureStore used to fetch the data.

Specified by:

getFeatureStore in interface FeaturePagingHelper

Returns:

the FeatureStore

getFeatureQuery

public FeatureQuery getFeatureQuery()

Description copied from interface: FeaturePagingHelper

Returns the query used to load the Features.

Specified by:

getFeatureQuery in interface FeaturePagingHelper

Returns:

the query used to load the Features

loadCurrentPageData

protected void loadCurrentPageData()
                            throws BaseException

Loads all the Features of the current page.

Overrides:

loadCurrentPageData in class DefaultDynObjectPagingHelper

Throws:

BaseException

delete

public void delete(Feature feature)
            throws BaseException

Description copied from interface: FeaturePagingHelper

Deletes a Feature from current FeatureSet.

Specified by:

delete in interface FeaturePagingHelper

Parameters:

feature - the Feature to delete.

Throws:

BaseException

See Also:

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

insert

public void insert(EditableFeature feature)
            throws BaseException

Description copied from interface: FeaturePagingHelper

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.

Specified by:

insert in interface FeaturePagingHelper

Parameters:

feature - the EditableFeature to insert.

Throws:

BaseException

See Also:

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

update

public void update(EditableFeature feature)
            throws BaseException

Description copied from interface: FeaturePagingHelper

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

Specified by:

update in interface FeaturePagingHelper

Parameters:

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

Throws:

BaseException

See Also:

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

getFeatureType

public FeatureType getFeatureType()

Description copied from interface: FeaturePagingHelper

Returns the FeatureType used of the data.

Specified by:

getFeatureType in interface FeaturePagingHelper

Returns:

the FeatureType of the data

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Overrides:

doDispose in class DefaultDynObjectPagingHelper

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

getCurrentPageDynObjects

public DynObject[] getCurrentPageDynObjects()

Description copied from interface: DynObjectPagingHelper

Returns all the values of the current loaded page.

Specified by:

getCurrentPageDynObjects in interface DynObjectPagingHelper

Overrides:

getCurrentPageDynObjects in class DefaultDynObjectPagingHelper

Returns:

all the values of the current loaded page

getDynObjectAt

public DynObject getDynObjectAt(long index)
                         throws BaseException

Description copied from interface: DynObjectPagingHelper

Returns the DynObject located at the index position.

Specified by:

getDynObjectAt in interface DynObjectPagingHelper

Overrides:

getDynObjectAt in class DefaultDynObjectPagingHelper

Parameters:

index - to locate the DynObject in the set

Returns:

the DynObject located at the index position

Throws:

BaseException - if there is an error getting the DynObject

asList

public List asList()

Description copied from interface: FeaturePagingHelper

Return a List of Fearures with the contents of this PagingHelper

Specified by:

asList in interface FeaturePagingHelper

Returns:

List of Features

asListOfDynObjects

public List asListOfDynObjects()

Description copied from interface: FeaturePagingHelper

Return a List of DynObjects with the contents of this PagingHelper

Specified by:

asListOfDynObjects in interface FeaturePagingHelper

Returns:

List of DynObjects