de.cismet.cismap.commons.featureservice.factory

Class ShapeFeatureFactory

java.lang.Object

de.cismet.cismap.commons.featureservice.factory.AbstractFeatureFactory<FT,QT>

de.cismet.cismap.commons.featureservice.factory.DegreeFeatureFactory<ShapeFeature,String>

de.cismet.cismap.commons.featureservice.factory.ShapeFeatureFactory

All Implemented Interfaces:

CachingFeatureFactory<ShapeFeature,String>, FeatureFactory<ShapeFeature,String>, Cloneable

public class ShapeFeatureFactory
extends DegreeFeatureFactory<ShapeFeature,String>
implements CachingFeatureFactory<ShapeFeature,String>

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

pascal

Nested Class Summary

Nested classes/interfaces inherited from class de.cismet.cismap.commons.featureservice.factory.DegreeFeatureFactory

DegreeFeatureFactory.ParsingProgressListener

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

FeatureFactory.TooManyFeaturesException

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	documentURI
protected Vector<FeatureServiceAttribute>	featureServiceAttributes
protected boolean	initialised
protected int	maxCachedFeatureCount
protected org.deegree.io.shpapi.ShapeFile	shapeFile

Fields inherited from class de.cismet.cismap.commons.featureservice.factory.DegreeFeatureFactory

featureSrid, geometryIndex

Fields inherited from class de.cismet.cismap.commons.featureservice.factory.AbstractFeatureFactory

DEBUG, groovyShell, ID, lastCreatedfeatureVector, lastGeom, lastQuery, layerName, layerProperties, logger, maxFeatureCount, styles

Constructor Summary

Constructors

Modifier	Constructor and Description
	ShapeFeatureFactory(LayerProperties layerProperties, URI documentURL, int maxCachedFeatureCount, SwingWorker workerThread, Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>> styles) Creates a new ShapeFeatureFactory object.
	ShapeFeatureFactory(LayerProperties layerProperties, URI documentURL, int maxCachedFeatureCount, SwingWorker workerThread, Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>> styles, String shapeCrs) Creates a new ShapeFeatureFactory object.
protected	ShapeFeatureFactory(ShapeFeatureFactory shpff) Creates a new ShapeFeatureFactory object.

Method Summary

Modifier and Type	Method and Description
protected void	cleanup() DOCUMENT ME!
ShapeFeatureFactory	clone() DOCUMENT ME!
Vector<FeatureServiceAttribute>	createAttributes(SwingWorker workerThread) Method that does not create FeatureServiceAttributes.
protected ShapeFeature	createFeatureInstance(org.deegree.model.feature.Feature degreeFeature, int index) Creates an instance of the custom FeatureServiceFeature types and may perform a custom initialisation with properties of the degree feature.
protected ShapeFeature	createFeatureInstance(org.deegree.model.feature.Feature degreeFeature, ShapeInfo shapeInfo, int index) DOCUMENT ME!
List<ShapeFeature>	createFeatures(String 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<ShapeFeature>	createFeatures(String 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().
void	flush() Flushes the internal cache and causes a re-allocate of the features upon the next createFeatures() request.
URI	getDocumentURI() Get the value of documentURL.
com.vividsolutions.jts.geom.Geometry	getEnvelope() DOCUMENT ME!
int	getFeatureCount(String query, BoundingBox bb) DOCUMENT ME!
String	getGeometryType() DOCUMENT ME!
int	getMaxCachedFeatureCount() is not used and not usable.
String	getShapeCrs() DOCUMENT ME!
org.deegree.io.shpapi.ShapeFile	getShapeFile() DOCUMENT ME!
String	getSldDefinition() DOCUMENT ME!
protected void	initialiseFeature(ShapeFeature featureServiceFeature, org.deegree.model.feature.Feature degreeFeature, boolean evaluateExpressions, int index) Perform standard initialisation of a newly created feature. In gereal, this operation is invokded by the processFeatureCollection operation.
boolean	isErrorInGeometryFound() DOCUMENT ME!
protected boolean	isGenerateIds() Determines if the service automatically generates unique IDs for all queryable features.
boolean	isLazy() Denotes if the features are allocated and cached during initialisation or during the first invocation of the createFeatures() operation.
boolean	isNoGeometryRecognised() DOCUMENT ME!
protected void	parseShapeFile(SwingWorker workerThread) DOCUMENT ME!
void	refreshData() DOCUMENT ME!
void	setCrs(Crs crs) DOCUMENT ME!
void	setDocumentURI(URI documentURI) Set the value of documentURL.
void	setMaxCachedFeatureCount(int maxCachedFeatureCount) Sets the maximum number of features that can be allocated and cached by this feature factory.
void	setShapeCrs(String shapeCrs) DOCUMENT ME!

Methods inherited from class de.cismet.cismap.commons.featureservice.factory.DegreeFeatureFactory

processFeatureCollection

Methods inherited from class de.cismet.cismap.commons.featureservice.factory.AbstractFeatureFactory

checkCancelled, createFeaturesFromMemory, evaluateBeanShellExpression, evaluateExpressions, evaluateGroovyExpressions, featuresAlreadyInMemory, getLastCreatedFeatures, getLayerProperties, getMaxFeatureCount, getStyle, getStyle, reEvaluteExpressions, setInterruptedAllowed, setInterruptedNotAllowed, setLayerName, setLayerProperties, setMaxFeatureCount, setSLDStyle, sortFeatureList, updateLastCreatedFeatures, waitUntilInterruptedIsAllowed

Methods inherited from class java.lang.Object

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

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

getLastCreatedFeatures, getLayerProperties, getMaxFeatureCount, setLayerName, setLayerProperties, setMaxFeatureCount, setSLDStyle

Field Detail

maxCachedFeatureCount

protected int maxCachedFeatureCount

documentURI

protected URI documentURI

shapeFile

protected org.deegree.io.shpapi.ShapeFile shapeFile

initialised

protected boolean initialised

featureServiceAttributes

protected Vector<FeatureServiceAttribute> featureServiceAttributes

Constructor Detail

ShapeFeatureFactory

public ShapeFeatureFactory(LayerProperties layerProperties,
                           URI documentURL,
                           int maxCachedFeatureCount,
                           SwingWorker workerThread,
                           Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>> styles)
                    throws Exception

Creates a new ShapeFeatureFactory object.

Parameters:

layerProperties - DOCUMENT ME!

documentURL - DOCUMENT ME!

maxCachedFeatureCount - DOCUMENT ME!

workerThread - DOCUMENT ME!

styles - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

ShapeFeatureFactory

public ShapeFeatureFactory(LayerProperties layerProperties,
                           URI documentURL,
                           int maxCachedFeatureCount,
                           SwingWorker workerThread,
                           Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>> styles,
                           String shapeCrs)
                    throws Exception

Creates a new ShapeFeatureFactory object.

Parameters:

layerProperties - DOCUMENT ME!

documentURL - DOCUMENT ME!

maxCachedFeatureCount - DOCUMENT ME!

workerThread - DOCUMENT ME!

styles - DOCUMENT ME!

shapeCrs - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

ShapeFeatureFactory

protected ShapeFeatureFactory(ShapeFeatureFactory shpff)

Creates a new ShapeFeatureFactory object.

Parameters:

shpff - DOCUMENT ME!

Method Detail

createFeatureInstance

protected ShapeFeature createFeatureInstance(org.deegree.model.feature.Feature degreeFeature,
                                             int index)
                                      throws Exception

Description copied from class: DegreeFeatureFactory

Creates an instance of the custom FeatureServiceFeature types and may perform a custom initialisation with properties of the degree feature.

Specified by:

createFeatureInstance in class DegreeFeatureFactory<ShapeFeature,String>

Parameters:

degreeFeature - the degree feature that may be used for custom initialisation

index - index of the current processing step, can be used for id generation

Returns:

the newly creates FeatureServiceFeature

Throws:

Exception - DOCUMENT ME!

See Also:

#processFeatureCollection(javax.swing.SwingWorker, org.deegree2.model.feature.Feature[], boolean)

createFeatureInstance

protected ShapeFeature createFeatureInstance(org.deegree.model.feature.Feature degreeFeature,
                                             ShapeInfo shapeInfo,
                                             int index)
                                      throws Exception

DOCUMENT ME!

Parameters:

degreeFeature - DOCUMENT ME!

shapeInfo - DOCUMENT ME!

index - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

initialiseFeature

protected void initialiseFeature(ShapeFeature featureServiceFeature,
                                 org.deegree.model.feature.Feature degreeFeature,
                                 boolean evaluateExpressions,
                                 int index)
                          throws Exception

Description copied from class: DegreeFeatureFactory

Perform standard initialisation of a newly created feature.
In gereal, this operation is invokded by the processFeatureCollection operation.

Overrides:

initialiseFeature in class DegreeFeatureFactory<ShapeFeature,String>

Parameters:

featureServiceFeature - DOCUMENT ME!

degreeFeature - feature to be initialised

evaluateExpressions - DOCUMENT ME!

index - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

See Also:

#processFeatureCollection(javax.swing.SwingWorker, org.deegree2.model.feature.Feature[], boolean)

cleanup

protected void cleanup()

DOCUMENT ME!

isLazy

public boolean isLazy()

Description copied from interface: CachingFeatureFactory

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.

Specified by:

isLazy in interface CachingFeatureFactory<ShapeFeature,String>

Returns:

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

getSldDefinition

public String getSldDefinition()

DOCUMENT ME!

Returns:

DOCUMENT ME!

parseShapeFile

protected void parseShapeFile(SwingWorker workerThread)
                       throws Exception

DOCUMENT ME!

Parameters:

workerThread - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

ShapeFileImportAborted - DOCUMENT ME!

getShapeFile

public org.deegree.io.shpapi.ShapeFile getShapeFile()
                                             throws IOException

DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!

refreshData

public void refreshData()

DOCUMENT ME!

flush

public void flush()

Description copied from interface: CachingFeatureFactory

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

Specified by:

flush in interface CachingFeatureFactory<ShapeFeature,String>

getMaxCachedFeatureCount

public int getMaxCachedFeatureCount()

is not used and not usable.

Specified by:

getMaxCachedFeatureCount in interface CachingFeatureFactory<ShapeFeature,String>

Returns:

DOCUMENT ME!

setMaxCachedFeatureCount

public void setMaxCachedFeatureCount(int maxCachedFeatureCount)

Description copied from interface: CachingFeatureFactory

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.

Specified by:

setMaxCachedFeatureCount in interface CachingFeatureFactory<ShapeFeature,String>

Parameters:

maxCachedFeatureCount - maximum number of features that can be cached

See Also:

FeatureFactory.setMaxFeatureCount(int)

getDocumentURI

public URI getDocumentURI()

Get the value of documentURL.

Returns:

the value of documentURL

setDocumentURI

public void setDocumentURI(URI documentURI)

Set the value of documentURL.

Parameters:

documentURI - new value of documentURL

createFeatures

public List<ShapeFeature> createFeatures(String query,
                                         BoundingBox boundingBox,
                                         SwingWorker workerThread)
                                  throws FeatureFactory.TooManyFeaturesException,
                                         Exception

Description copied from interface: FeatureFactory

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.

Specified by:

createFeatures in interface FeatureFactory<ShapeFeature,String>

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

createAttributes

public Vector<FeatureServiceAttribute> createAttributes(SwingWorker workerThread)
                                                 throws FeatureFactory.TooManyFeaturesException,
                                                        Exception

Description copied from interface: FeatureFactory

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

Specified by:

createAttributes in interface FeatureFactory<ShapeFeature,String>

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

isGenerateIds

protected boolean isGenerateIds()

Description copied from class: AbstractFeatureFactory

Determines if the service automatically generates unique IDs for all queryable features. Note that if this operation returns true, the id expression is not evaluated.

Specified by:

isGenerateIds in class AbstractFeatureFactory<ShapeFeature,String>

Returns:

true if the service generates id}

clone

public ShapeFeatureFactory clone()

Description copied from interface: FeatureFactory

DOCUMENT ME!

Specified by:

clone in interface FeatureFactory<ShapeFeature,String>

Specified by:

clone in class AbstractFeatureFactory<ShapeFeature,String>

Returns:

DOCUMENT ME!

isNoGeometryRecognised

public boolean isNoGeometryRecognised()

DOCUMENT ME!

Returns:

the noGeometryRecognised

isErrorInGeometryFound

public boolean isErrorInGeometryFound()

DOCUMENT ME!

Returns:

the errorInGeometryFound

setCrs

public void setCrs(Crs crs)

DOCUMENT ME!

Parameters:

crs - DOCUMENT ME!

getEnvelope

public com.vividsolutions.jts.geom.Geometry getEnvelope()

DOCUMENT ME!

Returns:

the envelope of the currently loaded shape file

getFeatureCount

public int getFeatureCount(String query,
                           BoundingBox bb)

Description copied from interface: FeatureFactory

DOCUMENT ME!

Specified by:

getFeatureCount in interface FeatureFactory<ShapeFeature,String>

Parameters:

query - DOCUMENT ME!

bb - DOCUMENT ME!

Returns:

DOCUMENT ME!

createFeatures

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

Description copied from interface: FeatureFactory

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.

Specified by:

createFeatures in interface FeatureFactory<ShapeFeature,String>

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

createNewFeature

public FeatureServiceFeature createNewFeature()

Description copied from interface: FeatureFactory

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

Specified by:

createNewFeature in interface FeatureFactory<ShapeFeature,String>

Overrides:

createNewFeature in class AbstractFeatureFactory<ShapeFeature,String>

Returns:

a new object with a valid id

getGeometryType

public String getGeometryType()

DOCUMENT ME!

Returns:

the geometryType

getShapeCrs

public String getShapeCrs()

DOCUMENT ME!

Returns:

the shapeCrs

setShapeCrs

public void setShapeCrs(String shapeCrs)

DOCUMENT ME!

Parameters:

shapeCrs - the shapeCrs to set