de.cismet.cismap.commons.featureservice.factory

Interface CachingFeatureFactory<FT extends FeatureServiceFeature,QT>

All Superinterfaces:

Cloneable, FeatureFactory<FT,QT>

All Known Implementing Classes:

GMLFeatureFactory, ShapeFeatureFactory

public interface CachingFeatureFactory<FT extends FeatureServiceFeature,QT>
extends FeatureFactory<FT,QT>

The CachingFeatureFactory stores retrieved features in a spatial index structure and thus allows fast bounding box requests. This is especially useful for StaticFeature Services which may require a FeatureFactory to pre-allocate all available Features (e.g. from a SHAPE or GML File). In contrast to a ordinary FeatureFactory which caches only the features of the last createFeatures request the CachingFeatureFactory may cache features upon initialisation and/or upon each request to the createFeatures operation. If the factory is able to cache all features upon initialisation (e.g. when loading small GML or SHP files), the createFeatures request is always executed on the cache.

Version:

$Revision$, $Date$

Author:

Pascal Dihé

Nested Class Summary

Nested classes/interfaces inherited from interface de.cismet.cismap.commons.featureservice.factory.FeatureFactory

FeatureFactory.TooManyFeaturesException

Method Summary

Modifier and Type	Method and Description
void	flush() Flushes the internal cache and causes a re-allocate of the features upon the next createFeatures() request.
int	getMaxCachedFeatureCount() Returns the maximum number of features that can be allocated and cached by this feature factory.
boolean	isLazy() Denotes if the features are allocated and cached during initialisation or during the first invocation of the createFeatures() operation.
void	setMaxCachedFeatureCount(int maxCachedFeatureCount) Sets the maximum number of features that can be allocated and cached by this feature factory.

Methods inherited from interface de.cismet.cismap.commons.featureservice.factory.FeatureFactory

clone, createAttributes, createFeatures, createFeatures, createNewFeature, getFeatureCount, getLastCreatedFeatures, getLayerProperties, getMaxFeatureCount, setLayerName, setLayerProperties, setMaxFeatureCount, setSLDStyle

Method Detail

isLazy

boolean isLazy()

Denotes if the features are allocated and cached during initialisation or during the first invocation of the createFeatures() operation. If this operation returns false it is stronly advised to instantiate this factory in a separate thread.

Returns:

true if the cached features a allocated upon the first request to createFeatures()

flush

void flush()

Flushes the internal cache and causes a re-allocate of the features upon the next createFeatures() request.

getMaxCachedFeatureCount

int getMaxCachedFeatureCount()

Returns the maximum number of features that can be allocated and cached by this feature factory.

Returns:

maximum number of features that can be cached

setMaxCachedFeatureCount

void setMaxCachedFeatureCount(int maxCachedFeatureCount)

Sets the maximum number of features that can be allocated and cached by this feature factory. In general, this value must be higher than maxFeatureCount and is applied to all available features regardless if they may fall into the specified BoundingBox or not.

If during allocation the maximum number is reached the factory throws a TooManyFeaturesException.

Parameters:

maxCachedFeatureCount - maximum number of features that can be cached

See Also:

FeatureFactory.setMaxFeatureCount(int)