Package org.geotools.data.oracle

Class OracleNGDataStoreFactory

Object

JDBCDataStoreFactory

OracleNGDataStoreFactory

All Implemented Interfaces:

DataAccessFactory, DataStoreFactorySpi, Factory

Direct Known Subclasses:

OracleNGOCIDataStoreFactory

public class OracleNGDataStoreFactory
extends JDBCDataStoreFactory

Oracle data store factory.

Author:

Justin Deoliveira, OpenGEO, Andrea Aime, OpenGEO, Hendrik Peilke

Nested Class Summary

Nested classes/interfaces inherited from interface DataAccessFactory

DataAccessFactory.Param

Field Summary

Fields

Modifier and Type	Field	Description
static DataAccessFactory.Param	CONNECTION_TIMEOUT	Specifies the socket connection timeout to the database.
static DataAccessFactory.Param	DATABASE	parameter for database instance
static DataAccessFactory.Param	DBTYPE	parameter for database type
static DataAccessFactory.Param	ESTIMATED_EXTENTS	parameter that enables estimated extends instead of exact ones
static DataAccessFactory.Param	GEOMETRY_METADATA_TABLE	Metadata table providing information about primary keys *
static DataAccessFactory.Param	GET_REMARKS	Specifies whether REMARKS metadata will be returned.
static DataAccessFactory.Param	HOST	parameter for database host
static DataAccessFactory.Param	LOGIN_TIMEOUT	parameter for specify the login timeout.
static DataAccessFactory.Param	LOOSEBBOX	parameter for namespace of the datastore
static DataAccessFactory.Param	METADATA_BBOX	parameter for getting bbox from MDSYS.USER_SDO_GEOM_METADATA or MDSYS.ALL_SDO_GEOM_METADATA table
static DataAccessFactory.Param	OUTBOUND_CONNECTION_TIMEOUT	Specifies the timeout when negotiating a session with the database.
static DataAccessFactory.Param	PORT	parameter for database port

Fields inherited from class JDBCDataStoreFactory

BATCH_INSERT_SIZE, CALLBACK_FACTORY, DATASOURCE, EVICTOR_TESTS_PER_RUN, EXPOSE_PK, FETCHSIZE, MAX_OPEN_PREPARED_STATEMENTS, MAXCONN, MAXWAIT, MIN_EVICTABLE_TIME, MINCONN, NAMESPACE, PASSWD, PK_METADATA_TABLE, SCHEMA, SQL_ON_BORROW, SQL_ON_RELEASE, TEST_WHILE_IDLE, TIME_BETWEEN_EVICTOR_RUNS, USER, VALIDATECONN

Constructor Summary

Constructors

Constructor	Description
OracleNGDataStoreFactory()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkDBType(Map<String,?> params)
protected JDBCDataStore	createDataStoreInternal(JDBCDataStore dataStore, Map<String,?> params)	Subclass hook to do additional initialization of a newly created datastore.
protected SQLDialect	createSQLDialect(JDBCDataStore dataStore)	Creates the dialect that the datastore uses for communication with the underlying database.
protected String	getDatabaseID()	Returns a string to identify the type of the database.
String	getDescription()	Describe the nature of the datasource constructed by this factory.
String	getDisplayName()	Name suitable for display to end user.
protected String	getDriverClassName()	Returns the fully qualified class name of the jdbc driver.
protected String	getJDBCUrl(Map<String,?> params)	Builds up the JDBC url in a jdbc:://:/ Override if you need a different setup
protected String	getValidationQuery()	Override this to return a good validation query (a very quick one, such as one that asks the database what time is it) or return null if the factory does not support validation.
protected void	setupParameters(Map<String,Object> parameters)	Sets up the database connection parameters.

Methods inherited from class JDBCDataStoreFactory

canProcess, checkDBType, createDataSource, createDataSource, createDataStore, createNewDataStore, createSQLDialect, getImplementationHints, getParametersInfo, isAvailable

Methods inherited from class Object

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

Field Detail

DBTYPE

public static final DataAccessFactory.Param DBTYPE

parameter for database type

PORT

public static final DataAccessFactory.Param PORT

parameter for database port

HOST

public static final DataAccessFactory.Param HOST

parameter for database host

DATABASE

public static final DataAccessFactory.Param DATABASE

parameter for database instance

ESTIMATED_EXTENTS

public static final DataAccessFactory.Param ESTIMATED_EXTENTS

parameter that enables estimated extends instead of exact ones

LOOSEBBOX

public static final DataAccessFactory.Param LOOSEBBOX

parameter for namespace of the datastore

GEOMETRY_METADATA_TABLE

public static final DataAccessFactory.Param GEOMETRY_METADATA_TABLE

Metadata table providing information about primary keys *

METADATA_BBOX

public static final DataAccessFactory.Param METADATA_BBOX

parameter for getting bbox from MDSYS.USER_SDO_GEOM_METADATA or MDSYS.ALL_SDO_GEOM_METADATA table

LOGIN_TIMEOUT

public static final DataAccessFactory.Param LOGIN_TIMEOUT

parameter for specify the login timeout.

CONNECTION_TIMEOUT

public static final DataAccessFactory.Param CONNECTION_TIMEOUT

Specifies the socket connection timeout to the database.

OUTBOUND_CONNECTION_TIMEOUT

public static final DataAccessFactory.Param OUTBOUND_CONNECTION_TIMEOUT

Specifies the timeout when negotiating a session with the database.

GET_REMARKS

public static final DataAccessFactory.Param GET_REMARKS

Specifies whether REMARKS metadata will be returned.

Constructor Detail

OracleNGDataStoreFactory

public OracleNGDataStoreFactory()

Method Detail

createSQLDialect

protected SQLDialect createSQLDialect(JDBCDataStore dataStore)

Description copied from class: JDBCDataStoreFactory

Creates the dialect that the datastore uses for communication with the underlying database.

Specified by:

createSQLDialect in class JDBCDataStoreFactory

Parameters:

dataStore - The datastore.

getDatabaseID

protected String getDatabaseID()

Description copied from class: JDBCDataStoreFactory

Returns a string to identify the type of the database.

Example: 'postgis'.

Specified by:

getDatabaseID in class JDBCDataStoreFactory

getDisplayName

public String getDisplayName()

Description copied from interface: DataAccessFactory

Name suitable for display to end user.

A non localized display name for this data store type.

Specified by:

getDisplayName in interface DataAccessFactory

Overrides:

getDisplayName in class JDBCDataStoreFactory

Returns:

A short name suitable for display in a user interface.

getDescription

public String getDescription()

Description copied from interface: DataAccessFactory

Describe the nature of the datasource constructed by this factory.

A non localized description of this data store type.

Returns:

A human readable description that is suitable for inclusion in a list of available datasources.

getDriverClassName

protected String getDriverClassName()

Description copied from class: JDBCDataStoreFactory

Returns the fully qualified class name of the jdbc driver.

For example: org.postgresql.Driver

Specified by:

getDriverClassName in class JDBCDataStoreFactory

checkDBType

protected boolean checkDBType(Map<String,?> params)

Overrides:

checkDBType in class JDBCDataStoreFactory

createDataStoreInternal

protected JDBCDataStore createDataStoreInternal(JDBCDataStore dataStore,
                                                Map<String,?> params)
                                         throws IOException

Description copied from class: JDBCDataStoreFactory

Subclass hook to do additional initialization of a newly created datastore.

Typically subclasses will want to override this method in the case where they provide additional datastore parameters, those should be processed here.

This method is provided with an instance of the datastore. In some cases subclasses may wish to create a new instance of the datastore, for instance in order to wrap the original instance. This is supported but the new datastore must be returned from this method. If not is such the case this method should still return the original passed in.

Overrides:

createDataStoreInternal in class JDBCDataStoreFactory

Parameters:

dataStore - The newly created datastore.

params - THe datastore parameters.

Throws:

IOException

getJDBCUrl

protected String getJDBCUrl(Map<String,?> params)
                     throws IOException

Description copied from class: JDBCDataStoreFactory

Builds up the JDBC url in a jdbc:://:/ Override if you need a different setup

Overrides:

getJDBCUrl in class JDBCDataStoreFactory

Throws:

IOException

setupParameters

protected void setupParameters(Map<String,Object> parameters)

Description copied from class: JDBCDataStoreFactory

Sets up the database connection parameters.

Subclasses may extend, but should not override. This implementation registers the following parameters.

• JDBCDataStoreFactory.HOST
• JDBCDataStoreFactory.PORT
• JDBCDataStoreFactory.DATABASE
• JDBCDataStoreFactory.SCHEMA
• JDBCDataStoreFactory.USER
• JDBCDataStoreFactory.PASSWD

Subclass implementation may remove any parameters from the map, or may overrwrite any parameters in the map.

Overrides:

setupParameters in class JDBCDataStoreFactory

Parameters:

parameters - Map of DataAccessFactory.Param objects.

getValidationQuery

protected String getValidationQuery()

Description copied from class: JDBCDataStoreFactory

Override this to return a good validation query (a very quick one, such as one that asks the database what time is it) or return null if the factory does not support validation.

Specified by:

getValidationQuery in class JDBCDataStoreFactory