de.cismet.cismap.commons.featureservice.factory

Interface FeatureFactory<FT extends FeatureServiceFeature,QT>

Type Parameters:

FT - The Type of the Feature created by this Factory

QT - The Type of the query used to select the features to be created

All Superinterfaces:

Cloneable

All Known Subinterfaces:

CachingFeatureFactory<FT,QT>

All Known Implementing Classes:

AbstractFeatureFactory, DegreeFeatureFactory, GMLFeatureFactory, H2FeatureServiceFactory, JDBCFeatureFactory, PostgisFeatureFactory, ShapeFeatureFactory, WFSFeatureFactory

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

Factory class that creates a collection of features from arbitrary data sources (e.g. from a WFS, da database connection, a file, etc.) and assigns (if applicable) a shared LayerProperties object to each feature.
Implementation classes have to assure that the FeatureFactory is properly initialised, e.g. a database connection is established, a WFS url is set, etc. by providing respective constructors or initialisation methods that must be invoked before the first call to createFeatures() can happen.

Version:

$Revision$, $Date$

Author:

Pascal Dihé

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FeatureFactory.TooManyFeaturesException Exception that is thrown when the features to be process by a feature factory exceeds the maximum number of features supported.

Method Summary

Modifier and Type	Method and Description
FeatureFactory	clone() DOCUMENT ME!
List<FeatureServiceAttribute>	createAttributes(SwingWorker workerThread) Method that does not create FeatureServiceAttributes.
List<FT>	createFeatures(QT query, BoundingBox boundingBox, SwingWorker workerThread) Returns instances of features FT that match the optional query and that fall into the optional BoundingBox. Applies layerProperties (if set) on all Features (if the type of the feature implements the interface InheritsLayerProperties).
List<FT>	createFeatures(QT query, BoundingBox boundingBox, SwingWorker workerThread, int offset, int limit, FeatureServiceAttribute[] orderBy) Returns instances of features FT that match the optional query and that fall into the optional BoundingBox. Applies layerProperties (if set) on all Features (if the type of the feature implements the interface InheritsLayerProperties).
FeatureServiceFeature	createNewFeature() This method must be implemented, if AbstractFeatureService.isEditable().
int	getFeatureCount(QT query, BoundingBox bb) DOCUMENT ME!
List<FT>	getLastCreatedFeatures() This operation can be used to retrieve the last created features without the need to invoke the createFeatures() operation.
LayerProperties	getLayerProperties() Returns the layerProperties that are applied to all features constructed.
int	getMaxFeatureCount() Returns the maximum number of features that can be returned by this feature factory.
void	setLayerName(String layerName) DOCUMENT ME!
void	setLayerProperties(LayerProperties layerProperties) Sets the layerProperties that are applied to all features constructed.
void	setMaxFeatureCount(int maxFeatureCount) Sets the maximum number of features that can be returned by this feature factory and that fall into the specified BoundinfBox respectively.
void	setSLDStyle(Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>> styles) DOCUMENT ME!

Method Detail

createFeatures

List<FT> createFeatures(QT query,
                        BoundingBox boundingBox,
                        SwingWorker workerThread)
                 throws FeatureFactory.TooManyFeaturesException,
                        Exception

Returns instances of features FT that match the optional query and that fall into the optional BoundingBox.
Applies layerProperties (if set) on all Features (if the type of the feature implements the interface InheritsLayerProperties). The SwingWorker instance can be used to set the progress of the operation and to check the worker thread was canceled. The state of the features list after a the operation was canceled is undefined.

Parameters:

query - optional query of type QT to select the features to be returned

boundingBox - optional BoundingBox to restrict the features to be returned

workerThread - an optional worker thread that is observed

Returns:

a list of matching features of type FT

Throws:

FeatureFactory.TooManyFeaturesException - if the maximum number of features is reached during processing

Exception - if something went wrong during parsing

createFeatures

List<FT> createFeatures(QT query,
                        BoundingBox boundingBox,
                        SwingWorker workerThread,
                        int offset,
                        int limit,
                        FeatureServiceAttribute[] orderBy)
                 throws FeatureFactory.TooManyFeaturesException,
                        Exception

Returns instances of features FT that match the optional query and that fall into the optional BoundingBox.
Applies layerProperties (if set) on all Features (if the type of the feature implements the interface InheritsLayerProperties). The SwingWorker instance can be used to set the progress of the operation and to check the worker thread was canceled. The state of the features list after a the operation was canceled is undefined.

Parameters:

query - optional query of type QT to select the features to be returned

boundingBox - optional BoundingBox to restrict the features to be returned

workerThread - an optional worker thread that is observed

offset - the start index

limit - a limit

orderBy - the attributes, the features should be ordered by

Returns:

a list of matching features of type FT

Throws:

FeatureFactory.TooManyFeaturesException - if the maximum number of features is reached during processing

Exception - if something went wrong during parsing

getLastCreatedFeatures

List<FT> getLastCreatedFeatures()

This operation can be used to retrieve the last created features without the need to invoke the createFeatures() operation. It returns a copy of the internal features vector of the factory to provent concurrent modification exceptions.

Returns:

the features created during the last call to createFeatures()

createAttributes

List<FeatureServiceAttribute> createAttributes(SwingWorker workerThread)
                                        throws FeatureFactory.TooManyFeaturesException,
                                               UnsupportedOperationException,
                                               Exception

Method that does not create FeatureServiceAttributes. In general, FeatureServiceAttributes need only to be created when the layer is initialized.

Parameters:

workerThread - DOCUMENT ME!

Returns:

a list of FeatureServiceAttributes.

Throws:

FeatureFactory.TooManyFeaturesException - if the maximum number of features is reached during processing

UnsupportedOperationException - if the factory does not support the creation attributes

Exception - if something went wrong during parsing

setLayerProperties

void setLayerProperties(LayerProperties layerProperties)

Sets the layerProperties that are applied to all features constructed. If the list of the last created features is not empty and any of the expressions of the layer properties changed, the new expressions are applied to the last created features and will be automatically applied to all newly created features.

Parameters:

layerProperties - new LayerProperties

getLayerProperties

LayerProperties getLayerProperties()

Returns the layerProperties that are applied to all features constructed.

Returns:

the LayerProperties or null if not set

createNewFeature

FeatureServiceFeature createNewFeature()

This method must be implemented, if AbstractFeatureService.isEditable().

Returns:

a new object with a valid id

getMaxFeatureCount

int getMaxFeatureCount()

Returns the maximum number of features that can be returned by this feature factory. Since the number of features returned is resticted by the specified BoundingBox a FeatureFactory implementation may be able to allocate more features as specified by maxFeatureCount.

Returns:

the maximum number of features or -1 if not set.

See Also:

CachingFeatureFactory

setMaxFeatureCount

void setMaxFeatureCount(int maxFeatureCount)

Sets the maximum number of features that can be returned by this feature factory and that fall into the specified BoundinfBox respectively. If during processing of the BoundinfBox the maximum number is reached the factory throws a TooManyFeaturesException.

Parameters:

maxFeatureCount - the maximum number of features

clone

FeatureFactory clone()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getFeatureCount

int getFeatureCount(QT query,
                    BoundingBox bb)

DOCUMENT ME!

Parameters:

query - DOCUMENT ME!

bb - DOCUMENT ME!

Returns:

DOCUMENT ME!

setSLDStyle

void setSLDStyle(Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>> styles)

DOCUMENT ME!

Parameters:

styles - DOCUMENT ME!

setLayerName

void setLayerName(String layerName)

DOCUMENT ME!

Parameters:

layerName - DOCUMENT ME!