org.gvsig.fmap.dal.store.jdbc

Class JDBCHelper

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.store.jdbc.JDBCHelper

All Implemented Interfaces:

ResourceConsumer, Disposable

Direct Known Subclasses:

H2Helper, PostgreSQLHelper

public class JDBCHelper
extends AbstractDisposable
implements ResourceConsumer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JDBCHelper.DalValueToJDBCException

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultSchema
protected GeometryManager	geomManager
protected boolean	isOpen
protected java.lang.String	name
protected JDBCConnectionParameters	params
protected JDBCHelperUser	user

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JDBCHelper(JDBCHelperUser consumer, JDBCConnectionParameters params)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowAutomaticValues()
void	close()
void	closeConnection(java.sql.Connection connection)
boolean	closeResourceRequested(ResourceProvider resource)
protected Geometry	coerce(GeometryType type, Geometry geometry)
java.lang.String	compoundLimitAndOffset(long limit, long offset)
protected EditableFeatureAttributeDescriptor	createAttributeFromJDBC(EditableFeatureType fType, java.sql.Connection conn, java.sql.ResultSetMetaData rsMetadata, int colIndex)
protected EditableFeatureAttributeDescriptor	createAttributeFromJDBCNativeType(EditableFeatureType fType, java.sql.ResultSetMetaData rsMetadata, int colIndex)
protected java.util.List	createGrantStatements(JDBCNewStoreParameters ndsp)
protected java.util.List	createGrantStatements(JDBCNewStoreParameters ndsp, java.lang.String table)
protected java.util.List	createGrantStatements(java.lang.String tableName, java.lang.String privilege, java.lang.String theRoles)
java.lang.Object	dalValueToJDBC(FeatureAttributeDescriptor attributeDescriptor, java.lang.Object value)
java.lang.Object	doConnectionAction(ConnectionAction action) Executes an atomic action that uses an DB Connection.
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
java.lang.String	escapeFieldName(java.lang.String field)
static void	execute(java.sql.PreparedStatement st, java.lang.String sql)
static void	execute(java.sql.Statement st, java.lang.String sql)
void	execute(java.lang.String sql)
static java.sql.ResultSet	executeQuery(java.sql.PreparedStatement st, java.lang.String sql)
static java.sql.ResultSet	executeQuery(java.sql.Statement st, java.lang.String sql)
static int	executeUpdate(java.sql.PreparedStatement st)
java.util.List	getAdditionalSqlToCreate(NewDataStoreParameters ndsp, FeatureType fType)
protected EditableFeatureAttributeDescriptor	getAttributeFromJDBC(EditableFeatureType fType, java.sql.Connection conn, java.sql.ResultSetMetaData rsMetadata, int colIndex)
java.sql.Connection	getConnection()
protected java.lang.String	getDefaltFieldValueString(FeatureAttributeDescriptor attr) Deprecated. use getDefaultFieldValueString this has a type writer error.
protected java.lang.String	getDefaultFieldValueString(FeatureAttributeDescriptor attr)
protected java.lang.String	getDefaultSchema(java.sql.Connection conn)
Envelope	getFullEnvelopeOfField(JDBCStoreParameters storeParams, java.lang.String geometryAttrName, Envelope limit) Override if provider has geometry support
Geometry	getGeometry(byte[] buffer)
protected java.lang.String	getIdentifierQuoteString()
protected java.lang.String[]	getPksFrom(java.sql.Connection conn, JDBCStoreParameters params)
protected java.lang.String[]	getPksFromInformationSchema(java.sql.Connection conn, JDBCStoreParameters params)
int	getProviderSRID(IProjection srs)
int	getProviderSRID(java.lang.String srs)
JDBCResource	getResource()
java.lang.String	getSqlColumnTypeDescription(FeatureAttributeDescriptor attr)
java.lang.String	getSqlFieldDescription(FeatureAttributeDescriptor attr)
java.lang.String	getSqlFieldName(FeatureAttributeDescriptor attribute)
protected void	initializeResource()
boolean	isOpen()
protected boolean	isReservedWord(java.lang.String field)
protected void	loadFeatureType(java.sql.Connection conn, EditableFeatureType featureType, java.lang.String sql, java.lang.String[] pks, java.lang.String defGeomName, java.lang.String schema, java.lang.String table)
void	loadFeatureType(EditableFeatureType featureType, JDBCStoreParameters storeParams)
void	loadFeatureType(EditableFeatureType featureType, JDBCStoreParameters storeParams, java.lang.String sql, java.lang.String schema, java.lang.String table)
protected void	loadSRS_and_shapeType(java.sql.Connection conn, java.sql.ResultSetMetaData rsMetadata, EditableFeatureType featureType, java.lang.String baseSchema, java.lang.String baseTable) Fill featureType geometry attributes with SRS and ShapeType information Override this if provider has native eometry support
boolean	open() open the resource
void	resourceChanged(ResourceProvider resource)
protected void	setResource(JDBCResource resource)
java.lang.String	stringJoin(java.util.List listToJoin, java.lang.String sep)
void	stringJoin(java.util.List listToJoin, java.lang.String sep, java.lang.StringBuilder strb)
boolean	supportOffset()
protected boolean	supportsGeometry() Inform that provider has supports for geometry store and operations natively
boolean	supportsUnion()

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

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

Field Detail

user

protected JDBCHelperUser user

isOpen

protected boolean isOpen

name

protected java.lang.String name

defaultSchema

protected java.lang.String defaultSchema

params

protected JDBCConnectionParameters params

geomManager

protected GeometryManager geomManager

Constructor Detail

JDBCHelper

protected JDBCHelper(JDBCHelperUser consumer,
          JDBCConnectionParameters params)
              throws InitializeException

Throws:

InitializeException

Method Detail

executeQuery

public static java.sql.ResultSet executeQuery(java.sql.Statement st,
                              java.lang.String sql)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

execute

public static void execute(java.sql.Statement st,
           java.lang.String sql)
                    throws java.sql.SQLException

Throws:

java.sql.SQLException

executeQuery

public static java.sql.ResultSet executeQuery(java.sql.PreparedStatement st,
                              java.lang.String sql)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

execute

public static void execute(java.sql.PreparedStatement st,
           java.lang.String sql)
                    throws java.sql.SQLException

Throws:

java.sql.SQLException

executeUpdate

public static int executeUpdate(java.sql.PreparedStatement st)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

closeConnection

public void closeConnection(java.sql.Connection connection)

execute

public void execute(java.lang.String sql)
             throws JDBCExecuteSQLException

Throws:

JDBCExecuteSQLException

initializeResource

protected void initializeResource()
                           throws InitializeException

Throws:

InitializeException

setResource

protected final void setResource(JDBCResource resource)

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

open

public boolean open()
             throws OpenException

open the resource

Returns:

true if the resourse was open in this call

Throws:

OpenException

getResource

public JDBCResource getResource()

close

public void close()
           throws CloseException

Throws:

CloseException

getConnection

public java.sql.Connection getConnection()
                                  throws AccessResourceException

Throws:

AccessResourceException

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Specified by:

doDispose in class AbstractDisposable

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

isOpen

public boolean isOpen()

doConnectionAction

public java.lang.Object doConnectionAction(ConnectionAction action)
                                    throws java.lang.Exception

Executes an atomic action that uses an DB Connection.
This methos prepares a connection and close it at the end of execution of action.
if action is an instance of TransactionalAction the action will be execute inside of a DB transaction.

Parameters:

action -

Throws:

java.lang.Exception

getDefaultSchema

protected java.lang.String getDefaultSchema(java.sql.Connection conn)
                                     throws JDBCException

Throws:

JDBCException

createAttributeFromJDBC

protected EditableFeatureAttributeDescriptor createAttributeFromJDBC(EditableFeatureType fType,
                                                         java.sql.Connection conn,
                                                         java.sql.ResultSetMetaData rsMetadata,
                                                         int colIndex)
                                                              throws java.sql.SQLException

Throws:

java.sql.SQLException

createAttributeFromJDBCNativeType

protected EditableFeatureAttributeDescriptor createAttributeFromJDBCNativeType(EditableFeatureType fType,
                                                                   java.sql.ResultSetMetaData rsMetadata,
                                                                   int colIndex)
                                                                        throws java.sql.SQLException

Throws:

java.sql.SQLException

getAttributeFromJDBC

protected EditableFeatureAttributeDescriptor getAttributeFromJDBC(EditableFeatureType fType,
                                                      java.sql.Connection conn,
                                                      java.sql.ResultSetMetaData rsMetadata,
                                                      int colIndex)
                                                           throws JDBCException

Throws:

JDBCException

loadSRS_and_shapeType

protected void loadSRS_and_shapeType(java.sql.Connection conn,
                         java.sql.ResultSetMetaData rsMetadata,
                         EditableFeatureType featureType,
                         java.lang.String baseSchema,
                         java.lang.String baseTable)
                              throws JDBCException

Fill featureType geometry attributes with SRS and ShapeType information Override this if provider has native eometry support

Parameters:

conn -

rsMetadata -

featureType -

Throws:

ReadException

JDBCException

loadFeatureType

public void loadFeatureType(EditableFeatureType featureType,
                   JDBCStoreParameters storeParams)
                     throws DataException

Throws:

DataException

loadFeatureType

public void loadFeatureType(EditableFeatureType featureType,
                   JDBCStoreParameters storeParams,
                   java.lang.String sql,
                   java.lang.String schema,
                   java.lang.String table)
                     throws DataException

Throws:

DataException

getPksFrom

protected java.lang.String[] getPksFrom(java.sql.Connection conn,
                            JDBCStoreParameters params)
                                 throws JDBCException

Throws:

JDBCException

getPksFromInformationSchema

protected java.lang.String[] getPksFromInformationSchema(java.sql.Connection conn,
                                             JDBCStoreParameters params)
                                                  throws JDBCException

Throws:

JDBCException

loadFeatureType

protected void loadFeatureType(java.sql.Connection conn,
                   EditableFeatureType featureType,
                   java.lang.String sql,
                   java.lang.String[] pks,
                   java.lang.String defGeomName,
                   java.lang.String schema,
                   java.lang.String table)
                        throws DataException

Throws:

DataException

getFullEnvelopeOfField

public Envelope getFullEnvelopeOfField(JDBCStoreParameters storeParams,
                              java.lang.String geometryAttrName,
                              Envelope limit)
                                throws DataException

Override if provider has geometry support

Parameters:

storeParams -

geometryAttrName -

limit -

Returns:

Throws:

DataException

getGeometry

public Geometry getGeometry(byte[] buffer)
                     throws BaseException

Throws:

BaseException

escapeFieldName

public java.lang.String escapeFieldName(java.lang.String field)

coerce

protected Geometry coerce(GeometryType type,
              Geometry geometry)

dalValueToJDBC

public java.lang.Object dalValueToJDBC(FeatureAttributeDescriptor attributeDescriptor,
                              java.lang.Object value)
                                throws WriteException

Throws:

WriteException

getSqlColumnTypeDescription

public java.lang.String getSqlColumnTypeDescription(FeatureAttributeDescriptor attr)

getProviderSRID

public int getProviderSRID(java.lang.String srs)

getProviderSRID

public int getProviderSRID(IProjection srs)

getSqlFieldName

public java.lang.String getSqlFieldName(FeatureAttributeDescriptor attribute)

getSqlFieldDescription

public java.lang.String getSqlFieldDescription(FeatureAttributeDescriptor attr)
                                        throws DataException

Throws:

DataException

getDefaltFieldValueString

protected java.lang.String getDefaltFieldValueString(FeatureAttributeDescriptor attr)
                                              throws WriteException

Deprecated. use getDefaultFieldValueString this has a type writer error.

Throws:

WriteException

getDefaultFieldValueString

protected java.lang.String getDefaultFieldValueString(FeatureAttributeDescriptor attr)
                                               throws WriteException

Throws:

WriteException

compoundLimitAndOffset

public java.lang.String compoundLimitAndOffset(long limit,
                                      long offset)

supportOffset

public boolean supportOffset()

getAdditionalSqlToCreate

public java.util.List getAdditionalSqlToCreate(NewDataStoreParameters ndsp,
                                      FeatureType fType)

stringJoin

public java.lang.String stringJoin(java.util.List listToJoin,
                          java.lang.String sep)

stringJoin

public void stringJoin(java.util.List listToJoin,
              java.lang.String sep,
              java.lang.StringBuilder strb)

supportsGeometry

protected boolean supportsGeometry()

Inform that provider has supports for geometry store and operations natively

Returns:

allowAutomaticValues

public boolean allowAutomaticValues()

supportsUnion

public boolean supportsUnion()

getIdentifierQuoteString

protected java.lang.String getIdentifierQuoteString()

isReservedWord

protected boolean isReservedWord(java.lang.String field)

createGrantStatements

protected java.util.List createGrantStatements(JDBCNewStoreParameters ndsp)

createGrantStatements

protected java.util.List createGrantStatements(JDBCNewStoreParameters ndsp,
                                   java.lang.String table)

createGrantStatements

protected java.util.List createGrantStatements(java.lang.String tableName,
                                   java.lang.String privilege,
                                   java.lang.String theRoles)