AbstractFeatureService (cismap Commons [9.2-SNAPSHOT] 9.2-SNAPSHOT API)

java.lang.Object
- de.cismet.cismap.commons.retrieval.AbstractRetrievalService
- - de.cismet.cismap.commons.featureservice.AbstractFeatureService<FT,QT>

All Implemented Interfaces:

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

Direct Known Subclasses:

DocumentFeatureService, JDBCFeatureService, SimplePostgisFeatureService, WebFeatureService
```
public abstract class AbstractFeatureService<FT extends FeatureServiceFeature,QT>
extends AbstractRetrievalService
implements MapService, ServiceLayer, RetrievalServiceLayer, FeatureMapService, ConvertableToXML, Cloneable, SLDStyledLayer
```
DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

Pascal Dihé

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractFeatureService.FeatureRetrievalWorker` Feature Retrieval Thread started by the `retrieve()` operation.
`protected class`	`AbstractFeatureService.LayerInitWorker` Initialisiert den Layer.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BoundingBox`	`bb`
`static String`	`DEFAULT_TYPE`
`protected boolean`	`enabled`
`protected String`	`encoding`
`protected FeatureFactory`	`featureFactory`
`protected AbstractFeatureService.FeatureRetrievalWorker`	`featureRetrievalWorker`
`protected Map<String,FeatureServiceAttribute>`	`featureServiceAttributes`
`protected Boolean`	`initialized`
`protected boolean`	`initializedFromElement`
`protected AbstractFeatureService.LayerInitWorker`	`layerInitWorker`
`protected int`	`layerPosition`
`protected LayerProperties`	`layerProperties`
`protected int`	`maxFeatureCount`
`protected String`	`name`
`static String`	`NONE`
`protected List<String>`	`orderedFeatureServiceAttributes`
`protected edu.umd.cs.piccolo.PNode`	`pNode`
`protected List<DefaultQueryButtonAction>`	`queryButtons`
`static List<DefaultQueryButtonAction>`	`SQL_QUERY_BUTTONS`
`protected float`	`translucency`
`static String`	`UNKNOWN`
`protected boolean`	`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
	`AbstractFeatureService()` Creates a new uninitilaised instance of a feature service with layer properties set.
`protected`	`AbstractFeatureService(AbstractFeatureService afs)` Protected Constructor that clones (shallow) the delivered AbstractFeatureService.
	`AbstractFeatureService(org.jdom.Element e)` Creates a new AbstractFeatureService from a XML-element.
	`AbstractFeatureService(String name, List<FeatureServiceAttribute> attributes)` Create a new uninitialised AbstractFeatureService except for the name and featureServiceAttributes.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBeDisabled()` This method checks either a layer can be disabled or not.
`protected boolean`	`cancel(SwingWorker workerThread)` Cancels the retrievel or the initialisation threads.
`protected abstract FeatureFactory`	`createFeatureFactory()` Creates an instance of a service specific FeatureFactory implementation.
`protected abstract LayerProperties`	`createLayerProperties()` Creates an instance of a service specific LayerProperties implementation.
`boolean`	`decorateLater()` Determines, if the attribute decoration should be hidden from the user.
`String`	`decoratePropertyName(String name)` DOCUMENT ME!
`String`	`decoratePropertyValue(String columnName, String value)` DOCUMENT ME!
`String`	`decorateQuery(String query)` Decorates the given query.
`BoundingBox`	`getBoundingBox()` This Method is used to set the bounding box to determine which features should be retrieved.
`String[]`	`getCalculatedAttributes()` DOCUMENT ME!
`String`	`getEncoding()` DOCUMENT ME!
`int`	`getFeatureCount(BoundingBox boundingBox)` DOCUMENT ME!
`int`	`getFeatureCount(QT query, BoundingBox boundingBox)` DOCUMENT ME!
`FeatureFactory`	`getFeatureFactory()` Get the value of featureFactory.
`protected abstract String`	`getFeatureLayerType()` DOCUMENT ME!
`Map<String,FeatureServiceAttribute>`	`getFeatureServiceAttributes()` Returns a list of all featureServiceAttributes of this featureservice.
`String`	`getGeometryType()` Determines the geometry type of the features of this service.
`String`	`getId()` DOCUMENT ME!
`org.jdom.Element`	`getInitElement()` DOCUMENT ME!
`boolean`	`getInitialisationError()` DOCUMENT ME!
`abstract Icon`	`getLayerIcon(int type)` DOCUMENT ME!
`int`	`getLayerPosition()` This method delivers the postion of the layer in the layer hierachy.
`LayerProperties`	`getLayerProperties()` DOCUMENT ME!
`void`	`getLegend(int width, int height, Graphics2D g2d)` DOCUMENT ME!
`void`	`getLegend(int nr, int width, int height, Graphics2D g2d)` DOCUMENT ME!
`void`	`getLegends(List<org.deegree.commons.utils.Pair<Integer,Integer>> sizes, Graphics2D[] g2d)` DOCUMENT ME!
`org.deegree.commons.utils.Pair<Integer,Integer>`	`getLegendSize()` DOCUMENT ME!
`org.deegree.commons.utils.Pair<Integer,Integer>`	`getLegendSize(int nr)` DOCUMENT ME!
`List<org.deegree.commons.utils.Pair<Integer,Integer>>`	`getLegendSizes()` DOCUMENT ME!
`int`	`getMaxFeatureCount()` DOCUMENT ME!
`int`	`getMaxFeaturesPerPage()` The number of features that should be shown on one page.
`String`	`getName()` This method delivers the name of the layer.
`List<String>`	`getOrderedFeatureServiceAttributes()` Returns a list of all featureServiceAttributes of this featureservice.
`edu.umd.cs.piccolo.PNode`	`getPNode()` DOCUMENT ME!
`abstract QT`	`getQuery()` Get the value of query.
`List<DefaultQueryButtonAction>`	`getQueryButtons()` The query buttons, which should be used by the query search.
`Reader`	`getSLDDefiniton()` DOCUMENT ME!
`float`	`getTranslucency()` Deliveres the transparency value of the Featues.
`protected void`	`init()` Initialises the FeatureService instance.
`void`	`initAndWait()` Initialises the feature service and blocks until the initialisation of the service is completed.
`protected abstract void`	`initConcreteInstance()` This operation is invoked after the default initialisation.
`void`	`initFromElement(org.jdom.Element element)` DOCUMENT ME!
`boolean`	`isEditable()` DOCUMENT ME!
`boolean`	`isEnabled()` Returns if the layer is enabled or disabled.
`boolean`	`isInitialized()` Packs the properties of the AbstractFeatureService as JDom-element.
`boolean`	`isSelectable()` DOCUMENT ME!
`boolean`	`isVisible()` DOCUMENT ME!
`boolean`	`isVisibleInBoundingBox(XBoundingBox box)` Determines if this service has any restriction that forbids the retrieval of features for the given bounding box.
`protected Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>>`	`parseSLD(Reader input)` DOCUMENT ME!
`void`	`refresh()` Sets the new layer properties of the service and.
`void`	`refreshFeatures()` DOCUMENT ME!
`void`	`retrieve(boolean forced)` Creates a new LayerInitWorker or FeatureRetrievalWorker and launches the initialisation or retrieval-process depending wheter the layer has already been initialised or the forced parameter is set to true.
`protected List<FT>`	`retrieveFeatures(AbstractFeatureService.FeatureRetrievalWorker worker)` This operation class the `createFeatures()` operation of the current FeatureFactory.
`List`	`retrieveFeatures(BoundingBox boundingBox, int offset, int limit, String orderBy)` DOCUMENT ME!
`void`	`setBoundingBox(BoundingBox bb)` DOCUMENT ME!
`void`	`setEnabled(boolean enabled)` Enables or disables the Layer.
`void`	`setEncoding(String encoding)` DOCUMENT ME!
`protected void`	`setFeatureServiceAttributes(List<FeatureServiceAttribute> featureServiceAttributesVector)` Setter for the featureServiceAttributes of the featureservice.
`void`	`setFeatureServiceAttributes(Map<String,FeatureServiceAttribute> featureServiceAttributes)` Setter for the featureServiceAttributes of the featureservice.
`void`	`setInitElement(org.jdom.Element initElement)` DOCUMENT ME!
`void`	`setInitialisationError(boolean initialisationError)` DOCUMENT ME!
`protected void`	`setInitialized(boolean isInitialized)` DOCUMENT ME!
`void`	`setLayerPosition(int layerPosition)` Sets the layer postion.
`void`	`setLayerProperties(LayerProperties layerProperties)` DOCUMENT ME!
`void`	`setLayerProperties(LayerProperties layerProperties, boolean refreshFeatures)` Sets the new layer properties of the service and.
`void`	`setMaxFeatureCount(int maxFeatureCount)` DOCUMENT ME!
`void`	`setName(String name)` Setter for the name of the AbstractFeatureService.
`void`	`setOrderedFeatureServiceAttributes(List<String> orderedFeatureServiceAttributes)` Setter for the featureServiceAttributes of the featureservice.
`void`	`setPNode(edu.umd.cs.piccolo.PNode pNode)` DOCUMENT ME!
`abstract void`	`setQuery(QT query)` Set the value of query.
`void`	`setSelectable(boolean selectable)` DOCUMENT ME!
`void`	`setSize(int height, int width)` DOCUMENT ME!
`void`	`setSLDInputStream(String inputStream)` DOCUMENT ME!
`void`	`setTranslucency(float t)` Setter for the transparency value.
`void`	`setVisible(boolean visible)` DOCUMENT ME!
`org.jdom.Element`	`toElement()` DOCUMENT ME!
`String`	`toString()` DOCUMENT ME!

Methods inherited from class de.cismet.cismap.commons.retrieval.AbstractRetrievalService
addPropertyChangeListener, addRetrievalListener, clone, 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
  - UNKNOWN
```
public static String UNKNOWN
```
  - NONE
```
public static String NONE
```
  - DEFAULT_TYPE
```
public static final String DEFAULT_TYPE
```
    See Also:
    
    Constant Field Values
  - SQL_QUERY_BUTTONS
```
public static final List<DefaultQueryButtonAction> SQL_QUERY_BUTTONS
```
  - enabled
```
protected boolean enabled
```
  - bb
```
protected BoundingBox bb
```
  - layerPosition
```
protected int layerPosition
```
  - name
```
protected String name
```
  - translucency
```
protected float translucency
```
  - encoding
```
protected String encoding
```
  - maxFeatureCount
```
protected int maxFeatureCount
```
  - featureServiceAttributes
```
protected Map<String,FeatureServiceAttribute> featureServiceAttributes
```
  - pNode
```
protected edu.umd.cs.piccolo.PNode pNode
```
  - visible
```
protected boolean visible
```
  - featureRetrievalWorker
```
protected AbstractFeatureService.FeatureRetrievalWorker featureRetrievalWorker
```
  - initialized
```
protected Boolean initialized
```
  - layerInitWorker
```
protected AbstractFeatureService.LayerInitWorker layerInitWorker
```
  - layerProperties
```
protected LayerProperties layerProperties
```
  - featureFactory
```
protected FeatureFactory featureFactory
```
  - orderedFeatureServiceAttributes
```
protected List<String> orderedFeatureServiceAttributes
```
  - queryButtons
```
protected List<DefaultQueryButtonAction> queryButtons
```
  - initializedFromElement
```
protected boolean initializedFromElement
```
- Constructor Detail
  - AbstractFeatureService
```
public AbstractFeatureService()
```
    Creates a new uninitilaised instance of a feature service with layer properties set. The Service is fully initialised upon the first call to the retrieve() operation.
  - AbstractFeatureService
```
public AbstractFeatureService(org.jdom.Element e)
                       throws Exception
```
    Creates a new AbstractFeatureService from a XML-element. Sets all properties of the XML Element but does not initialise. Since the initialisation may take some time, it is perfomed upon the first call to the retrieve() operation which is rum from separate thread.
    
    Parameters:
    
    e - XML-element with FeatureService-configuration
    
    Throws:
    
    Exception - java.lang.Exception if something went wrong
    
    ClassNotFoundException - DOCUMENT ME!
    
    See Also:
    
    isInitialised()
  - AbstractFeatureService
```
public AbstractFeatureService(String name,
                              List<FeatureServiceAttribute> attributes)
```
    Create a new uninitialised AbstractFeatureService except for the name and featureServiceAttributes.
    
    Parameters:
    
    name - the name of this FeatureService
    
    attributes - featureServiceAttributes vector with all FeatureServiceAttributes of the FeatureService
  - AbstractFeatureService
```
protected AbstractFeatureService(AbstractFeatureService afs)
```
    Protected Constructor that clones (shallow) the delivered AbstractFeatureService. Attributes, layer properties and feature factories are not cloned deeply. The FeatureService to be cloned should be initilaised.
    
    Parameters:
    
    afs - FeatureService that should be cloned
- Method Detail
  - init
```
protected void init()
             throws Exception
```
    Initialises the FeatureService instance. If the service has already been initialised, the operation clears the layerProperties, the featureFactory and the featureServiceAttributes and forces a complete re-initialisation.
    
    Throws:
    
    Exception - java.lang.Exception if somethin went wrong
  - initAndWait
```
public void initAndWait()
                 throws Exception
```
    Initialises the feature service and blocks until the initialisation of the service is completed. If the initialisation of the service is already in progress, this method wait until the initialisation is complete, if this thread is not running in edt.
    
    Throws:
    
    Exception - DOCUMENT ME!
  - createLayerProperties
```
protected abstract LayerProperties createLayerProperties()
```
    Creates an instance of a service specific LayerProperties implementation.
    
    Returns:
    
    layer properties to be used
  - createFeatureFactory
```
protected abstract FeatureFactory createFeatureFactory()
                                                throws Exception
```
    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.
    
    Returns:
    
    the constructed FeatureFactory
    
    Throws:
    
    Exception - id the costruction failed
  - getFeatureFactory
```
public FeatureFactory getFeatureFactory()
```
    Get the value of featureFactory.
    
    Returns:
    
    the value of featureFactory
  - getQuery
```
public abstract QT getQuery()
```
    Get the value of query.
    
    Returns:
    
    the value of query
  - setQuery
```
public abstract void setQuery(QT query)
```
    Set the value of query.
    
    Parameters:
    
    query - new value of query
  - cancel
```
protected boolean cancel(SwingWorker workerThread)
```
    Cancels the retrievel or the initialisation threads.
    
    Parameters:
    
    workerThread - DOCUMENT ME!
    
    Returns:
    
    true if a running thread was found and canceled
  - retrieve
```
public void retrieve(boolean forced)
```
    Creates a new LayerInitWorker or FeatureRetrievalWorker and launches the initialisation or retrieval-process depending wheter the layer has already been initialised or the forced parameter is set to true. A re-initialisation clears the attribute and layer properties cache and thus resets any saved properties to default values.
    
    Specified by:
    
    retrieve in interface RetrievalService
    
    Specified by:
    
    retrieve in class AbstractRetrievalService
    
    Parameters:
    
    forced - forces a re-initialisation of the layer
  - initConcreteInstance
```
protected abstract void initConcreteInstance()
                                      throws Exception
```
    This operation is invoked after the default initialisation. Implementation classes may implement this method to perform addditional initialisations.
    
    Throws:
    
    Exception - if the initialisation fails
  - getFeatureLayerType
```
protected abstract String getFeatureLayerType()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getLayerIcon
```
public abstract Icon getLayerIcon(int type)
```
    DOCUMENT ME!
    
    Parameters:
    
    type - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - isInitialized
```
public boolean isInitialized()
```
    Packs the properties of the AbstractFeatureService as JDom-element.
    
    Returns:
    
    JDom-element that outlines this AbstractFeatureService
  - setInitialized
```
protected void setInitialized(boolean isInitialized)
```
    DOCUMENT ME!
    
    Parameters:
    
    isInitialized - DOCUMENT ME!
  - getFeatureServiceAttributes
```
public Map<String,FeatureServiceAttribute> getFeatureServiceAttributes()
```
    Returns a list of all featureServiceAttributes of this featureservice.
    
    Returns:
    
    DOCUMENT ME!
  - setFeatureServiceAttributes
```
public void setFeatureServiceAttributes(Map<String,FeatureServiceAttribute> featureServiceAttributes)
```
    Setter for the featureServiceAttributes of the featureservice.
    
    Parameters:
    
    featureServiceAttributes - featureServiceAttributes to set
  - getOrderedFeatureServiceAttributes
```
public List<String> getOrderedFeatureServiceAttributes()
```
    Returns a list of all featureServiceAttributes of this featureservice.
    
    Returns:
    
    DOCUMENT ME!
  - setOrderedFeatureServiceAttributes
```
public void setOrderedFeatureServiceAttributes(List<String> orderedFeatureServiceAttributes)
```
    Setter for the featureServiceAttributes of the featureservice.
    
    Parameters:
    
    orderedFeatureServiceAttributes - featureServiceAttributes to set
  - setFeatureServiceAttributes
```
protected void setFeatureServiceAttributes(List<FeatureServiceAttribute> featureServiceAttributesVector)
```
    Setter for the featureServiceAttributes of the featureservice.
    
    Parameters:
    
    featureServiceAttributesVector - featureServiceAttributes to set
  - getBoundingBox
```
public BoundingBox getBoundingBox()
```
    This Method is used to set the bounding box to determine which features should be retrieved.
    
    Returns:
    
    DOCUMENT ME!
  - setBoundingBox
```
public void setBoundingBox(BoundingBox bb)
```
    DOCUMENT ME!
    
    Specified by:
    
    setBoundingBox in interface MapService
    
    Parameters:
    
    bb - DOCUMENT ME!
  - getEncoding
```
public String getEncoding()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - setEncoding
```
public void setEncoding(String encoding)
```
    DOCUMENT ME!
    
    Parameters:
    
    encoding - DOCUMENT ME!
  - getMaxFeatureCount
```
public int getMaxFeatureCount()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - setMaxFeatureCount
```
public void setMaxFeatureCount(int maxFeatureCount)
```
    DOCUMENT ME!
    
    Parameters:
    
    maxFeatureCount - DOCUMENT ME!
  - getLayerProperties
```
public LayerProperties getLayerProperties()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - setLayerProperties
```
public void setLayerProperties(LayerProperties layerProperties)
```
    DOCUMENT ME!
    
    Parameters:
    
    layerProperties - DOCUMENT ME!
  - setLayerProperties
```
public void setLayerProperties(LayerProperties layerProperties,
                               boolean refreshFeatures)
```
    Sets the new layer properties of the service and.
    
    Parameters:
    
    layerProperties - DOCUMENT ME!
    
    refreshFeatures - DOCUMENT ME!
  - refresh
```
public void refresh()
```
    Sets the new layer properties of the service and.
  - getTranslucency
```
public float getTranslucency()
```
    Deliveres the transparency value of the Featues.
    
    Specified by:
    
    getTranslucency in interface MapService
    
    Specified by:
    
    getTranslucency in interface ServiceLayer
    
    Returns:
    
    the translucency value
  - setTranslucency
```
public void setTranslucency(float t)
```
    Setter for the transparency value.
    
    Specified by:
    
    setTranslucency in interface ServiceLayer
    
    Parameters:
    
    t - the new transparency value
  - setName
```
public void setName(String name)
```
    Setter for the name of the AbstractFeatureService.
    
    Specified by:
    
    setName in interface ServiceLayer
    
    Parameters:
    
    name - the new name that will be set
  - getName
```
public String getName()
```
    This method delivers the name of the layer.
    
    Specified by:
    
    getName in interface ServiceLayer
    
    Returns:
    
    the name of the layer
  - getLayerPosition
```
public int getLayerPosition()
```
    This method delivers the postion of the layer in the layer hierachy.
    
    Specified by:
    
    getLayerPosition in interface ServiceLayer
    
    Returns:
    
    the postion of the layer in the layer hierarchy
  - setLayerPosition
```
public void setLayerPosition(int layerPosition)
```
    Sets the layer postion. Dependet on this value the layer will be positioned at top of other layers or behind other layers
    
    Specified by:
    
    setLayerPosition in interface ServiceLayer
    
    Parameters:
    
    layerPosition - The integer value which determines the postion in the layer hierarchy
  - isEnabled
```
public boolean isEnabled()
```
    Returns if the layer is enabled or disabled.
    
    Specified by:
    
    isEnabled in interface ServiceLayer
    
    Returns:
    
    either true if the layer is enabled or false if its not
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Enables or disables the Layer.
    
    Specified by:
    
    setEnabled in interface ServiceLayer
    
    Parameters:
    
    enabled - true enables the layer, false disables it
  - canBeDisabled
```
public boolean canBeDisabled()
```
    This method checks either a layer can be disabled or not.
    
    Specified by:
    
    canBeDisabled in interface ServiceLayer
    
    Returns:
    
    true if the layer can be disabled or false if not
  - isVisible
```
public boolean isVisible()
```
    DOCUMENT ME!
    
    Specified by:
    
    isVisible in interface MapService
    
    Returns:
    
    DOCUMENT ME!
  - setVisible
```
public void setVisible(boolean visible)
```
    DOCUMENT ME!
    
    Parameters:
    
    visible - DOCUMENT ME!
  - setSize
```
public void setSize(int height,
                    int width)
```
    DOCUMENT ME!
    
    Specified by:
    
    setSize in interface MapService
    
    Parameters:
    
    height - DOCUMENT ME!
    
    width - DOCUMENT ME!
  - getPNode
```
public edu.umd.cs.piccolo.PNode getPNode()
```
    DOCUMENT ME!
    
    Specified by:
    
    getPNode in interface PNodeProvider
    
    Returns:
    
    DOCUMENT ME!
  - setPNode
```
public void setPNode(edu.umd.cs.piccolo.PNode pNode)
```
    DOCUMENT ME!
    
    Specified by:
    
    setPNode in interface PNodeProvider
    
    Parameters:
    
    pNode - DOCUMENT ME!
  - toString
```
public String toString()
```
    DOCUMENT ME!
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    DOCUMENT ME!
  - getId
```
public String getId()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - toElement
```
public org.jdom.Element toElement()
```
    DOCUMENT ME!
    
    Specified by:
    
    toElement in interface ConvertableToXML
    
    Returns:
    
    DOCUMENT ME!
  - initFromElement
```
public void initFromElement(org.jdom.Element element)
                     throws Exception
```
    DOCUMENT ME!
    
    Specified by:
    
    initFromElement in interface ConvertableToXML
    
    Parameters:
    
    element - DOCUMENT ME!
    
    Throws:
    
    Exception - DOCUMENT ME!
  - setInitialisationError
```
public void setInitialisationError(boolean initialisationError)
```
    DOCUMENT ME!
    
    Parameters:
    
    initialisationError - DOCUMENT ME!
  - getInitialisationError
```
public boolean getInitialisationError()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getQueryButtons
```
public List<DefaultQueryButtonAction> getQueryButtons()
```
    The query buttons, which should be used by the query search.
    
    Returns:
    
    DOCUMENT ME!
  - decoratePropertyName
```
public String decoratePropertyName(String name)
```
    DOCUMENT ME!
    
    Parameters:
    
    name - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - decorateLater
```
public boolean decorateLater()
```
    Determines, if the attribute decoration should be hidden from the user. See decoratePropertyName(String name)
    
    Returns:
    
    True, iff the attribute decoration of the search query should be hidden from the user
  - decorateQuery
```
public String decorateQuery(String query)
```
    Decorates the given query. So that it con be used with the services. This method is typically used, if decorateLater() returns true. This method adds all attribute decorations, which should be hidden from the user.
    
    Parameters:
    
    query - the query to decorate
    
    Returns:
    
    the decorated query
  - decoratePropertyValue
```
public String decoratePropertyValue(String columnName,
                                    String value)
```
    DOCUMENT ME!
    
    Parameters:
    
    columnName - DOCUMENT ME!
    
    value - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - retrieveFeatures
```
public List retrieveFeatures(BoundingBox boundingBox,
                             int offset,
                             int limit,
                             String orderBy)
                      throws Exception
```
    DOCUMENT ME!
    
    Parameters:
    
    boundingBox - DOCUMENT ME!
    
    offset - DOCUMENT ME!
    
    limit - DOCUMENT ME!
    
    orderBy - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
    
    Throws:
    
    Exception - DOCUMENT ME!
  - getFeatureCount
```
public int getFeatureCount(QT query,
                           BoundingBox boundingBox)
```
    DOCUMENT ME!
    
    Parameters:
    
    query - DOCUMENT ME!
    
    boundingBox - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getFeatureCount
```
public int getFeatureCount(BoundingBox boundingBox)
```
    DOCUMENT ME!
    
    Parameters:
    
    boundingBox - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - retrieveFeatures
```
protected List<FT> retrieveFeatures(AbstractFeatureService.FeatureRetrievalWorker worker)
                             throws Exception
```
    This operation class the createFeatures() operation of the current FeatureFactory. Implementation classes may override this method to pass additional parameters to the createFeatures() operation of the specific FeatureFactory implementation.
    
    Parameters:
    
    worker - the current worker thred that is observed
    
    Returns:
    
    the FeatureServiceFeatures created by the current Factory
    
    Throws:
    
    Exception - DOCUMENT ME!
  - getInitElement
```
public org.jdom.Element getInitElement()
```
    DOCUMENT ME!
    
    Returns:
    
    the initElement
  - setInitElement
```
public void setInitElement(org.jdom.Element initElement)
```
    DOCUMENT ME!
    
    Parameters:
    
    initElement - the initElement to set
  - setSelectable
```
public void setSelectable(boolean selectable)
```
    DOCUMENT ME!
    
    Parameters:
    
    selectable - DOCUMENT ME!
  - isSelectable
```
public boolean isSelectable()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - isEditable
```
public boolean isEditable()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getSLDDefiniton
```
public Reader getSLDDefiniton()
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    getSLDDefiniton in interface SLDStyledLayer
    
    Returns:
    
    DOCUMENT ME!
  - setSLDInputStream
```
public void setSLDInputStream(String inputStream)
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    setSLDInputStream in interface SLDStyledLayer
    
    Parameters:
    
    inputStream - DOCUMENT ME!
  - parseSLD
```
protected Map<String,LinkedList<org.deegree.style.se.unevaluated.Style>> parseSLD(Reader input)
```
    DOCUMENT ME!
    
    Parameters:
    
    input - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getLegendSize
```
public org.deegree.commons.utils.Pair<Integer,Integer> getLegendSize(int nr)
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    getLegendSize in interface SLDStyledLayer
    
    Parameters:
    
    nr - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getLegendSize
```
public org.deegree.commons.utils.Pair<Integer,Integer> getLegendSize()
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    getLegendSize in interface SLDStyledLayer
    
    Returns:
    
    DOCUMENT ME!
  - getLegendSizes
```
public List<org.deegree.commons.utils.Pair<Integer,Integer>> getLegendSizes()
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    getLegendSizes in interface SLDStyledLayer
    
    Returns:
    
    DOCUMENT ME!
  - getLegend
```
public void getLegend(int width,
                      int height,
                      Graphics2D g2d)
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    getLegend in interface SLDStyledLayer
    
    Parameters:
    
    width - DOCUMENT ME!
    
    height - DOCUMENT ME!
    
    g2d - DOCUMENT ME!
  - getLegend
```
public void getLegend(int nr,
                      int width,
                      int height,
                      Graphics2D g2d)
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    getLegend in interface SLDStyledLayer
    
    Parameters:
    
    nr - DOCUMENT ME!
    
    width - DOCUMENT ME!
    
    height - DOCUMENT ME!
    
    g2d - DOCUMENT ME!
  - getLegends
```
public void getLegends(List<org.deegree.commons.utils.Pair<Integer,Integer>> sizes,
                       Graphics2D[] g2d)
```
    Description copied from interface: SLDStyledLayer
    
    DOCUMENT ME!
    
    Specified by:
    
    getLegends in interface SLDStyledLayer
    
    Parameters:
    
    sizes - DOCUMENT ME!
    
    g2d - DOCUMENT ME!
  - refreshFeatures
```
public void refreshFeatures()
```
    DOCUMENT ME!
  - getGeometryType
```
public String getGeometryType()
```
    Determines the geometry type of the features of this service.
    
    Returns:
    
    the name of the geometrys most specific com.vividsolutions.jts.geom interface or UNKNOWN, if the features can have different geometries
  - getMaxFeaturesPerPage
```
public int getMaxFeaturesPerPage()
```
    The number of features that should be shown on one page. (is used in the attribute table)
    
    Returns:
    
    the numbe rof eatures per page. Less than 1 shows all features on one page
  - getCalculatedAttributes
```
public String[] getCalculatedAttributes()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - isVisibleInBoundingBox
```
public boolean isVisibleInBoundingBox(XBoundingBox box)
```
    Determines if this service has any restriction that forbids the retrieval of features for the given bounding box.
    
    Parameters:
    
    box - DOCUMENT ME!
    
    Returns:
    
    false, iff any restriction (e.g. the scale) prevents the retrieval of features for the given bounding box

Class AbstractFeatureService<FT extends FeatureServiceFeature,QT>

Nested Class Summary

Field Summary

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Field Detail

UNKNOWN

NONE

DEFAULT_TYPE

SQL_QUERY_BUTTONS

enabled

bb

layerPosition

name

translucency

encoding

maxFeatureCount

featureServiceAttributes

pNode

visible

featureRetrievalWorker

initialized

layerInitWorker

layerProperties

featureFactory

orderedFeatureServiceAttributes

queryButtons

initializedFromElement

Constructor Detail

AbstractFeatureService

AbstractFeatureService

AbstractFeatureService

AbstractFeatureService

Method Detail

init

initAndWait

createLayerProperties

createFeatureFactory

getFeatureFactory

getQuery

setQuery

cancel

retrieve

initConcreteInstance

getFeatureLayerType

getLayerIcon

isInitialized

setInitialized

getFeatureServiceAttributes

setFeatureServiceAttributes

getOrderedFeatureServiceAttributes

setOrderedFeatureServiceAttributes

setFeatureServiceAttributes

getBoundingBox

setBoundingBox

getEncoding

setEncoding

getMaxFeatureCount

setMaxFeatureCount

getLayerProperties

setLayerProperties

setLayerProperties

refresh

getTranslucency

setTranslucency

setName

getName

getLayerPosition

setLayerPosition

isEnabled

setEnabled

canBeDisabled

isVisible