de.cismet.cismap.commons.featureservice

Class WebFeatureService

java.lang.Object

de.cismet.cismap.commons.retrieval.AbstractRetrievalService

de.cismet.cismap.commons.featureservice.AbstractFeatureService<WFSFeature,String>

de.cismet.cismap.commons.featureservice.WebFeatureService

All Implemented Interfaces:

ConvertableToXML, SLDStyledLayer, LayerInfoProvider, PNodeProvider, FeatureMapService, MapService, RetrievalService, RetrievalServiceLayer, ServiceLayer, Cloneable

public final class WebFeatureService
extends AbstractFeatureService<WFSFeature,String>
implements LayerInfoProvider

This class provides access to a Web Feature service. Requests will be send to a WFS instance. The response will be parsed and transformed to an internal features representation. These internal features will be send to all registered listeners

Version:

$Revision$, $Date$

Author:

Sebastian Puhl

Nested Class Summary

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

AbstractFeatureService.FeatureRetrievalWorker, AbstractFeatureService.LayerInitWorker

Field Summary

Fields

Modifier and Type	Field and Description
static HashMap<Integer,Icon>	layerIcons
static String	WFS_FEATURELAYER_TYPE

Fields inherited from class de.cismet.cismap.commons.featureservice.AbstractFeatureService

bb, DEFAULT_TYPE, enabled, encoding, featureFactory, featureRetrievalWorker, featureServiceAttributes, initialized, initializedFromElement, layerInitWorker, layerPosition, layerProperties, maxFeatureCount, name, NONE, orderedFeatureServiceAttributes, pNode, queryButtons, SQL_QUERY_BUTTONS, translucency, UNKNOWN, visible

Fields inherited from class de.cismet.cismap.commons.retrieval.AbstractRetrievalService

DEBUG, errorObject, listeners, progress, PROGRESS_PROPERTY, PROGRESS_REFRESH, propertyChangeSupport, refreshNeeded

Fields inherited from interface de.cismet.cismap.commons.ServiceLayer

LAYER_DISABLED_INVISIBLE, LAYER_DISABLED_VISIBLE, LAYER_ENABLED_INVISIBLE, LAYER_ENABLED_VISIBLE

Fields inherited from interface de.cismet.cismap.commons.ConvertableToXML

TYPE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
	WebFeatureService(org.jdom.Element e) Creates a new WebFeatureService object.
	WebFeatureService(String name, String host, org.jdom.Element query, List<FeatureServiceAttribute> attributes, FeatureType feature) Create a new uninitialised AbstractFeatureService except for the attributes provided.
	WebFeatureService(String name, String host, org.jdom.Element query, List<FeatureServiceAttribute> attributes, FeatureType feature, boolean reverseAxisOrder) Create a new uninitialised AbstractFeatureService except for the attributes provided.
protected	WebFeatureService(WebFeatureService wfs) Protected Constructor that clones (shallow) the delivered WebFeatureService.

Method Summary

Modifier and Type	Method and Description
Object	clone() This method creates an one-to-one hard copy of the SimpleWebFeatureService.
protected FeatureFactory	createFeatureFactory() Creates an instance of a service specific FeatureFactory implementation.
protected LayerProperties	createLayerProperties() Creates an instance of a service specific LayerProperties implementation.
String	decoratePropertyName(String name) DOCUMENT ME!
String	decoratePropertyValue(String column, String value) DOCUMENT ME!
Crs	getCrs() DOCUMENT ME!
FeatureType	getFeature() DOCUMENT ME!
protected String	getFeatureLayerType() DOCUMENT ME!
String	getHostname() Delivers the host-string of the FeatureService.
Icon	getLayerIcon(int type) DOCUMENT ME!
de.cismet.commons.wms.capabilities.Layer	getLayerInformation() DOCUMENT ME!
String	getLayerURI() DOCUMENT ME!
String	getQuery() Get the value of query.
org.jdom.Element	getQueryElement() DOCUMENT ME!
String	getServerURI() DOCUMENT ME!
String	getVersion() DOCUMENT ME!
protected void	initConcreteInstance() This operation is invoked after the default initialisation.
void	initFromElement(org.jdom.Element element) DOCUMENT ME!
void	initFromElement(org.jdom.Element element, boolean loadCapDoc) DOCUMENT ME!
boolean	isLayerQuerySelected() DOCUMENT ME!
boolean	isQueryable() DOCUMENT ME!
void	removeAllListeners() DOCUMENT ME!
void	setCrs(Crs crs) DOCUMENT ME!
void	setFeature(FeatureType feature) DOCUMENT ME!
protected void	setHostname(String hostname) Setter for the host-string of the FeatureService.
void	setLayerPropertiesWithoutUpdate(LayerProperties layerProperties) Sets the Layer properties but does not refresh the cached features.
void	setLayerQuerySelected(boolean selected) DOCUMENT ME!
void	setMaxFeatureCount(int maxFeatureCount) DOCUMENT ME!
void	setQuery(String wfsQueryString) Set the value of query.
void	setQueryElement(org.jdom.Element wfsQuery) Sets a new wfsQuery Element and overwites the string query.
org.jdom.Element	toElement() DOCUMENT ME!

Methods inherited from class de.cismet.cismap.commons.featureservice.AbstractFeatureService

canBeDisabled, cancel, decorateLater, decorateQuery, getBoundingBox, getCalculatedAttributes, getEncoding, getFeatureCount, getFeatureCount, getFeatureFactory, getFeatureServiceAttributes, getGeometryType, getId, getInitElement, getInitialisationError, getLayerPosition, getLayerProperties, getLegend, getLegend, getLegends, getLegendSize, getLegendSize, getLegendSizes, getMaxFeatureCount, getMaxFeaturesPerPage, getName, getOrderedFeatureServiceAttributes, getPNode, getQueryButtons, getSLDDefiniton, getTranslucency, init, initAndWait, isEditable, isEnabled, isInitialized, isSelectable, isVisible, isVisibleInBoundingBox, parseSLD, refresh, refreshFeatures, retrieve, retrieveFeatures, retrieveFeatures, setBoundingBox, setEnabled, setEncoding, setFeatureServiceAttributes, setFeatureServiceAttributes, setInitElement, setInitialisationError, setInitialized, setLayerPosition, setLayerProperties, setLayerProperties, setName, setOrderedFeatureServiceAttributes, setPNode, setSelectable, setSize, setSLDInputStream, setTranslucency, setVisible, toString

Methods inherited from class de.cismet.cismap.commons.retrieval.AbstractRetrievalService

addPropertyChangeListener, addRetrievalListener, cloneWithoutRetrievalListeners, fireRetrievalAborted, fireRetrievalComplete, fireRetrievalError, fireRetrievalProgress, fireRetrievalStarted, getErrorObject, getListeners, getProgress, hasErrors, isRefreshNeeded, removePropertyChangeListener, removeRetrievalListener, setErrorObject, setProgress, setRefreshNeeded

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cismet.cismap.commons.RetrievalServiceLayer

getErrorObject, hasErrors, setErrorObject

Methods inherited from interface de.cismet.cismap.commons.retrieval.RetrievalService

addPropertyChangeListener, addRetrievalListener, getProgress, isRefreshNeeded, removePropertyChangeListener, removeRetrievalListener, setProgress, setRefreshNeeded

Field Detail

WFS_FEATURELAYER_TYPE

public static final String WFS_FEATURELAYER_TYPE

See Also:

Constant Field Values

layerIcons

public static final HashMap<Integer,Icon> layerIcons

Constructor Detail

WebFeatureService

public WebFeatureService(org.jdom.Element e)
                  throws Exception

Creates a new WebFeatureService object.

Parameters:

e - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

WebFeatureService

public WebFeatureService(String name,
                         String host,
                         org.jdom.Element query,
                         List<FeatureServiceAttribute> attributes,
                         FeatureType feature)
                  throws Exception

Create a new uninitialised AbstractFeatureService except for the attributes provided.

Parameters:

name - the name of this FeatureService

host - hostname of the WFS server

query - the request which will be send to the WFS

attributes - featureServiceAttributes vector with all FeatureServiceAttributes of the FeatureService

feature - version DOCUMENT ME!

Throws:

Exception - if something went wrong

WebFeatureService

public WebFeatureService(String name,
                         String host,
                         org.jdom.Element query,
                         List<FeatureServiceAttribute> attributes,
                         FeatureType feature,
                         boolean reverseAxisOrder)
                  throws Exception

Create a new uninitialised AbstractFeatureService except for the attributes provided.

Parameters:

name - the name of this FeatureService

host - hostname of the WFS server

query - the request which will be send to the WFS

attributes - featureServiceAttributes vector with all FeatureServiceAttributes of the FeatureService

feature - version DOCUMENT ME!

reverseAxisOrder - if true, the axis order of the crs will be changed

Throws:

Exception - if something went wrong

WebFeatureService

protected WebFeatureService(WebFeatureService wfs)

Protected Constructor that clones (shallow) the delivered WebFeatureService. Attributes, layer properties and feature factories are not cloned deeply. The WebFeatureService to be cloned should be initilaised.

Parameters:

wfs - FeatureService that should be cloned

Method Detail

initConcreteInstance

protected void initConcreteInstance()
                             throws Exception

Description copied from class: AbstractFeatureService

This operation is invoked after the default initialisation. Implementation classes may implement this method to perform addditional initialisations.

Specified by:

initConcreteInstance in class AbstractFeatureService<WFSFeature,String>

Throws:

Exception - if the initialisation fails

setMaxFeatureCount

public void setMaxFeatureCount(int maxFeatureCount)

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Overrides:

setMaxFeatureCount in class AbstractFeatureService<WFSFeature,String>

Parameters:

maxFeatureCount - DOCUMENT ME!

toElement

public org.jdom.Element toElement()

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Specified by:

toElement in interface ConvertableToXML

Overrides:

toElement in class AbstractFeatureService<WFSFeature,String>

Returns:

DOCUMENT ME!

initFromElement

public void initFromElement(org.jdom.Element element)
                     throws Exception

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Specified by:

initFromElement in interface ConvertableToXML

Overrides:

initFromElement in class AbstractFeatureService<WFSFeature,String>

Parameters:

element - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

initFromElement

public void initFromElement(org.jdom.Element element,
                            boolean loadCapDoc)
                     throws Exception

DOCUMENT ME!

Parameters:

element - DOCUMENT ME!

loadCapDoc - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

clone

public Object clone()

This method creates an one-to-one hard copy of the SimpleWebFeatureService.

Specified by:

clone in class AbstractRetrievalService

Returns:

the copy of the SimpleWebFeatureService

removeAllListeners

public void removeAllListeners()

DOCUMENT ME!

getHostname

public String getHostname()

Delivers the host-string of the FeatureService.

Returns:

hostname as string

setHostname

protected void setHostname(String hostname)

Setter for the host-string of the FeatureService.

Parameters:

hostname - hostname to set

getQuery

public String getQuery()

Description copied from class: AbstractFeatureService

Get the value of query.

Specified by:

getQuery in class AbstractFeatureService<WFSFeature,String>

Returns:

the value of query

setQuery

public void setQuery(String wfsQueryString)

Description copied from class: AbstractFeatureService

Set the value of query.

Specified by:

setQuery in class AbstractFeatureService<WFSFeature,String>

Parameters:

wfsQueryString - new value of query

getQueryElement

public org.jdom.Element getQueryElement()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setQueryElement

public void setQueryElement(org.jdom.Element wfsQuery)

Sets a new wfsQuery Element and overwites the string query.

Parameters:

wfsQuery - DOCUMENT ME!

getFeatureLayerType

protected String getFeatureLayerType()

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Specified by:

getFeatureLayerType in class AbstractFeatureService<WFSFeature,String>

Returns:

DOCUMENT ME!

getLayerIcon

public Icon getLayerIcon(int type)

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Specified by:

getLayerIcon in class AbstractFeatureService<WFSFeature,String>

Parameters:

type - DOCUMENT ME!

Returns:

DOCUMENT ME!

createLayerProperties

protected LayerProperties createLayerProperties()

Description copied from class: AbstractFeatureService

Creates an instance of a service specific LayerProperties implementation.

Specified by:

createLayerProperties in class AbstractFeatureService<WFSFeature,String>

Returns:

layer properties to be used

createFeatureFactory

protected FeatureFactory createFeatureFactory()
                                       throws Exception

Description copied from class: AbstractFeatureService

Creates an instance of a service specific FeatureFactory implementation. All variables required by the concrete FeatureFactory, e.g. the Layer Properties must have been initialised before this operation is invoked.

Specified by:

createFeatureFactory in class AbstractFeatureService<WFSFeature,String>

Returns:

the constructed FeatureFactory

Throws:

Exception - id the costruction failed

setLayerPropertiesWithoutUpdate

public void setLayerPropertiesWithoutUpdate(LayerProperties layerProperties)

Sets the Layer properties but does not refresh the cached features.

Parameters:

layerProperties - DOCUMENT ME!

getVersion

public String getVersion()

DOCUMENT ME!

Returns:

the version of the referenced wfs

getLayerURI

public String getLayerURI()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

getLayerURI in interface LayerInfoProvider

Returns:

DOCUMENT ME!

getServerURI

public String getServerURI()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

getServerURI in interface LayerInfoProvider

Returns:

DOCUMENT ME!

isLayerQuerySelected

public boolean isLayerQuerySelected()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

isLayerQuerySelected in interface LayerInfoProvider

Returns:

DOCUMENT ME!

setLayerQuerySelected

public void setLayerQuerySelected(boolean selected)

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

setLayerQuerySelected in interface LayerInfoProvider

Parameters:

selected - DOCUMENT ME!

isQueryable

public boolean isQueryable()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

isQueryable in interface LayerInfoProvider

Returns:

DOCUMENT ME!

getLayerInformation

public de.cismet.commons.wms.capabilities.Layer getLayerInformation()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

getLayerInformation in interface LayerInfoProvider

Returns:

DOCUMENT ME!

getFeature

public FeatureType getFeature()

DOCUMENT ME!

Returns:

the feature

setFeature

public void setFeature(FeatureType feature)

DOCUMENT ME!

Parameters:

feature - the feature to set

getCrs

public Crs getCrs()

DOCUMENT ME!

Returns:

the crs

setCrs

public void setCrs(Crs crs)

DOCUMENT ME!

Parameters:

crs - the crs to set

decoratePropertyName

public String decoratePropertyName(String name)

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Overrides:

decoratePropertyName in class AbstractFeatureService<WFSFeature,String>

Parameters:

name - DOCUMENT ME!

Returns:

DOCUMENT ME!

decoratePropertyValue

public String decoratePropertyValue(String column,
                                    String value)

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Overrides:

decoratePropertyValue in class AbstractFeatureService<WFSFeature,String>

Parameters:

column - DOCUMENT ME!

value - DOCUMENT ME!

Returns:

DOCUMENT ME!