de.cismet.cismap.commons.featureservice

Class H2FeatureService

java.lang.Object

de.cismet.cismap.commons.retrieval.AbstractRetrievalService

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

de.cismet.cismap.commons.featureservice.JDBCFeatureService<JDBCFeature>

de.cismet.cismap.commons.featureservice.H2FeatureService

All Implemented Interfaces:

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

public class H2FeatureService
extends JDBCFeatureService<JDBCFeature>

A service, that uses the internal db as data source.

Version:

$Revision$, $Date$

Author:

therter

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 String	H2_FEATURELAYER_TYPE
static Map<String,Icon>	layerIcons

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

databasePath, query, tableName

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
	H2FeatureService(org.jdom.Element e) Creates a new H2FeatureService object.
protected	H2FeatureService(H2FeatureService hfs) Creates a new ShapeFileFeatureService object.
	H2FeatureService(String name, String databasePath, String tableName, List<FeatureServiceAttribute> attributes) Creates a new H2FeatureService object.
	H2FeatureService(String name, String databasePath, String tableName, List<FeatureServiceAttribute> attributes, File shapeFile) Creates a new H2FeatureService object.
	H2FeatureService(String name, String databasePath, String tableName, List<FeatureServiceAttribute> attributes, File shapeFile, List<FeatureServiceFeature> features) Creates a new H2FeatureService object.
	H2FeatureService(String name, String databasePath, String tableName, List<FeatureServiceAttribute> attributes, File shapeFile, List<FeatureServiceFeature> features, List<String> orderedAttributeNames) Creates a new H2FeatureService object.
	H2FeatureService(String name, String databasePath, String tableName, List<FeatureServiceAttribute> attributes, File shapeFile, List<FeatureServiceFeature> features, List<String> orderedAttributeNames, String format) Creates a new H2FeatureService object.
	H2FeatureService(String name, String databasePath, String tableName, List<FeatureServiceAttribute> attributes, List<FeatureServiceFeature> features) Creates a new H2FeatureService object.

Method Summary

Modifier and Type	Method and Description
static void	clearLocks() Clear all locks.
Object	clone()
protected FeatureFactory	createFeatureFactory() Creates an instance of a service specific FeatureFactory implementation.
void	createFromShapeFile(URI shapeFileUri) Import the given shape file to the database and assign it to this layer.
protected LayerProperties	createLayerProperties() Creates an instance of a service specific LayerProperties implementation.
H2FeatureService	createLinearReferencingLayer(String fromField, String tillField, String routeField, String routeJoinField, AbstractFeatureService routeService, String layerName, String domain, String newTableName) Adds the geometries for linear referenced values to the service.
H2FeatureService	createPointGeometryInformation(String xField, String yField, String newTableName) Adds point geometries to the service.
String	decoratePropertyName(String name) DOCUMENT ME!
boolean	equals(Object obj)
protected String	getFeatureLayerType() DOCUMENT ME!
String	getGeometryType() Determines the geometry type of the features of this service.
Icon	getLayerIcon(int type) DOCUMENT ME!
static Icon	getLayerIcon(int type, String tableName, String dbName) DOCUMENT ME!
static String	getTableFormat(String tableName, String dbName) Checks, if the given table exists in the db.
static String	getTableNameStemFromTableName(String tableName) DOCUMENT ME!
int	hashCode()
protected void	initConcreteInstance() This operation is invoked after the default initialisation.
boolean	isInitialised() DOCUMENT ME!
boolean	isTableNotFound() Checks, if the table of the layer does exist.
static void	lockFeature(Integer id, String tableName) Lock the given features.
static boolean	removeTableIfExists(String tableName) Checks, if the given table exists in the db.
static void	removeUnusedSequences() remove all unused sequences.
void	setSLDInputStream(String inputStream) DOCUMENT ME!
void	setTableNotFound(boolean tableNotFound) DOCUMENT ME!
static boolean	tableAlreadyExists(String tableName) Checks, if the given table exists in the db.
static void	unlockFeature(Integer id, String tableName) Unlock the features, which are described by the given values.

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

getDatabasePath, getQuery, getTableName, initFromElement, isEditable, setCrs, setDatabasePath, setQuery, setTableName, toElement

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

canBeDisabled, cancel, decorateLater, decoratePropertyValue, decorateQuery, getBoundingBox, getCalculatedAttributes, getEncoding, getFeatureCount, getFeatureCount, getFeatureFactory, getFeatureServiceAttributes, getId, getInitElement, getInitialisationError, getLayerPosition, getLayerProperties, getLegend, getLegend, getLegends, getLegendSize, getLegendSize, getLegendSizes, getMaxFeatureCount, getMaxFeaturesPerPage, getName, getOrderedFeatureServiceAttributes, getPNode, getQueryButtons, getSLDDefiniton, getTranslucency, init, initAndWait, isEnabled, isInitialized, isSelectable, isVisible, isVisibleInBoundingBox, parseSLD, refresh, refreshFeatures, retrieve, retrieveFeatures, retrieveFeatures, setBoundingBox, setEnabled, setEncoding, setFeatureServiceAttributes, setFeatureServiceAttributes, setInitElement, setInitialisationError, setInitialized, setLayerPosition, setLayerProperties, setLayerProperties, setMaxFeatureCount, setName, setOrderedFeatureServiceAttributes, setPNode, setSelectable, setSize, 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

finalize, getClass, 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

layerIcons

public static final Map<String,Icon> layerIcons

H2_FEATURELAYER_TYPE

public static final String H2_FEATURELAYER_TYPE

See Also:

Constant Field Values

Constructor Detail

H2FeatureService

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

Creates a new H2FeatureService object.

Parameters:

e - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

H2FeatureService

public H2FeatureService(String name,
                        String databasePath,
                        String tableName,
                        List<FeatureServiceAttribute> attributes)
                 throws Exception

Creates a new H2FeatureService object.

Parameters:

name - DOCUMENT ME!

databasePath - DOCUMENT ME!

tableName - DOCUMENT ME!

attributes - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

H2FeatureService

public H2FeatureService(String name,
                        String databasePath,
                        String tableName,
                        List<FeatureServiceAttribute> attributes,
                        File shapeFile)
                 throws Exception

Creates a new H2FeatureService object.

Parameters:

name - DOCUMENT ME!

databasePath - DOCUMENT ME!

tableName - DOCUMENT ME!

attributes - DOCUMENT ME!

shapeFile - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

H2FeatureService

public H2FeatureService(String name,
                        String databasePath,
                        String tableName,
                        List<FeatureServiceAttribute> attributes,
                        List<FeatureServiceFeature> features)
                 throws Exception

Creates a new H2FeatureService object.

Parameters:

name - DOCUMENT ME!

databasePath - DOCUMENT ME!

tableName - DOCUMENT ME!

attributes - DOCUMENT ME!

features - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

H2FeatureService

public H2FeatureService(String name,
                        String databasePath,
                        String tableName,
                        List<FeatureServiceAttribute> attributes,
                        File shapeFile,
                        List<FeatureServiceFeature> features)
                 throws Exception

Creates a new H2FeatureService object.

Parameters:

name - The name of the service

databasePath - the database path of the service

tableName - the name of the service table

attributes - the feature service attributes of the service

shapeFile - the shape file to import

features - the features to import

Throws:

Exception - DOCUMENT ME!

H2FeatureService

public H2FeatureService(String name,
                        String databasePath,
                        String tableName,
                        List<FeatureServiceAttribute> attributes,
                        File shapeFile,
                        List<FeatureServiceFeature> features,
                        List<String> orderedAttributeNames)
                 throws Exception

Creates a new H2FeatureService object.

Parameters:

name - The name of the service

databasePath - the database path of the service

tableName - the name of the service table

attributes - the feature service attributes of the service

shapeFile - the shape file to import

features - the features to import

orderedAttributeNames - the order of the service attributes. Can be null for an arbitrary attribute order.

Throws:

Exception - DOCUMENT ME!

H2FeatureService

public H2FeatureService(String name,
                        String databasePath,
                        String tableName,
                        List<FeatureServiceAttribute> attributes,
                        File shapeFile,
                        List<FeatureServiceFeature> features,
                        List<String> orderedAttributeNames,
                        String format)
                 throws Exception

Creates a new H2FeatureService object.

Parameters:

name - The name of the service

databasePath - the database path of the service

tableName - the name of the service table

attributes - the feature service attributes of the service

shapeFile - the shape file to import

features - the features to import

orderedAttributeNames - the order of the service attributes. Can be null for an arbitrary attribute order.

format - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

H2FeatureService

protected H2FeatureService(H2FeatureService hfs)

Creates a new ShapeFileFeatureService object.

Parameters:

hfs - DOCUMENT ME!

Method Detail

createFromShapeFile

public void createFromShapeFile(URI shapeFileUri)

Import the given shape file to the database and assign it to this layer.

Parameters:

shapeFileUri - the uri to the shape file

setSLDInputStream

public void setSLDInputStream(String inputStream)

Description copied from interface: SLDStyledLayer

DOCUMENT ME!

Specified by:

setSLDInputStream in interface SLDStyledLayer

Overrides:

setSLDInputStream in class AbstractFeatureService<JDBCFeature,String>

Parameters:

inputStream - DOCUMENT ME!

getTableNameStemFromTableName

public static String getTableNameStemFromTableName(String tableName)

DOCUMENT ME!

Parameters:

tableName - DOCUMENT ME!

Returns:

DOCUMENT ME!

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<JDBCFeature,String>

Returns:

the constructed FeatureFactory

Throws:

Exception - id the costruction failed

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<JDBCFeature,String>

Throws:

Exception - if the initialisation fails

getFeatureLayerType

protected String getFeatureLayerType()

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Specified by:

getFeatureLayerType in class AbstractFeatureService<JDBCFeature,String>

Returns:

DOCUMENT ME!

createLayerProperties

protected LayerProperties createLayerProperties()

Description copied from class: AbstractFeatureService

Creates an instance of a service specific LayerProperties implementation.

Overrides:

createLayerProperties in class JDBCFeatureService<JDBCFeature>

Returns:

layer properties to be used

getLayerIcon

public Icon getLayerIcon(int type)

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Specified by:

getLayerIcon in class AbstractFeatureService<JDBCFeature,String>

Parameters:

type - DOCUMENT ME!

Returns:

DOCUMENT ME!

getLayerIcon

public static Icon getLayerIcon(int type,
                                String tableName,
                                String dbName)

DOCUMENT ME!

Parameters:

type - DOCUMENT ME!

tableName - DOCUMENT ME!

dbName - DOCUMENT ME!

Returns:

DOCUMENT ME!

clone

public Object clone()

Specified by:

clone in class AbstractRetrievalService

getGeometryType

public String getGeometryType()

Description copied from class: AbstractFeatureService

Determines the geometry type of the features of this service.

Overrides:

getGeometryType in class AbstractFeatureService<JDBCFeature,String>

Returns:

the name of the geometrys most specific com.vividsolutions.jts.geom interface or AbstractFeatureService.UNKNOWN, if the features can have different geometries

isInitialised

public boolean isInitialised()

DOCUMENT ME!

Returns:

the initialised

createLinearReferencingLayer

public H2FeatureService createLinearReferencingLayer(String fromField,
                                                     String tillField,
                                                     String routeField,
                                                     String routeJoinField,
                                                     AbstractFeatureService routeService,
                                                     String layerName,
                                                     String domain,
                                                     String newTableName)
                                              throws Exception

Adds the geometries for linear referenced values to the service.

Parameters:

fromField - The field with the from station

tillField - The field with the till station

routeField - The field with the route name

routeJoinField - the field of the route service, that is used for the join with this service

routeService - The service that conains the routes

layerName - The name of the route layer

domain - the domain of the route layer

newTableName - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

createPointGeometryInformation

public H2FeatureService createPointGeometryInformation(String xField,
                                                       String yField,
                                                       String newTableName)
                                                throws H2FeatureServiceFactory.NegativeValueException,
                                                       Exception

Adds point geometries to the service.

Parameters:

xField - The field with the x value

yField - The field with the y value

newTableName - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

H2FeatureServiceFactory.NegativeValueException - DOCUMENT ME!

Exception - DOCUMENT ME!

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

decoratePropertyName

public String decoratePropertyName(String name)

Description copied from class: AbstractFeatureService

DOCUMENT ME!

Overrides:

decoratePropertyName in class AbstractFeatureService<JDBCFeature,String>

Parameters:

name - DOCUMENT ME!

Returns:

DOCUMENT ME!

tableAlreadyExists

public static boolean tableAlreadyExists(String tableName)

Checks, if the given table exists in the db.

Parameters:

tableName - the name of the table to check

Returns:

True, if the given db table exists

lockFeature

public static void lockFeature(Integer id,
                               String tableName)
                        throws Exception

Lock the given features.

Parameters:

id - the id of the feature to lock or null to lock the hole table

tableName - The table name of the feature to lock

Throws:

Exception - DOCUMENT ME!

LockFromSameUserAlreadyExistsException - DOCUMENT ME!

clearLocks

public static void clearLocks()

Clear all locks.

removeUnusedSequences

public static void removeUnusedSequences()

remove all unused sequences.

unlockFeature

public static void unlockFeature(Integer id,
                                 String tableName)

Unlock the features, which are described by the given values.

Parameters:

id - the id of the feature to unlock or null to unlock all features of the given table

tableName - the name of the table to unlock

removeTableIfExists

public static boolean removeTableIfExists(String tableName)

Checks, if the given table exists in the db.

Parameters:

tableName - the name of the table to check

Returns:

True, if the given was removed

getTableFormat

public static String getTableFormat(String tableName,
                                    String dbName)

Checks, if the given table exists in the db.

Parameters:

tableName - DOCUMENT ME!

dbName - DOCUMENT ME!

Returns:

True, if the given was removed

isTableNotFound

public boolean isTableNotFound()

Checks, if the table of the layer does exist.

Returns:

true, if the table of the layer does not exist

setTableNotFound

public void setTableNotFound(boolean tableNotFound)

DOCUMENT ME!

Parameters:

tableNotFound - the tableNotFound to set