Package org.gvsig.fmap.dal.store.jdbc

Interface JDBCStoreParameters

All Superinterfaces:

DataParameters, DataStoreParameters, DBConnectionParameter, DBParameters, DBStoreParameters, org.gvsig.tools.dynobject.DynObject, JDBCConnectionParameters, OpenDataStoreParameters, OpenFeatureStoreParameters, org.gvsig.tools.persistence.Persistent, org.gvsig.json.SupportFromJson, org.gvsig.json.SupportToJson

public interface JDBCStoreParameters
extends JDBCConnectionParameters, DBStoreParameters

Author:

fdiaz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BATCHSIZE_PARAMTER_NAME

Fields inherited from interface org.gvsig.fmap.dal.DataParameters

CRS_PARAMTER_NAME

Fields inherited from interface org.gvsig.fmap.dal.resource.db.DBParameters

DBNAME_PARAMTER_NAME, HOST_PARAMTER_NAME, PASSWORD_PARAMTER_NAME, PORT_PARAMTER_NAME, USER_PARAMTER_NAME

Fields inherited from interface org.gvsig.fmap.dal.store.db.DBStoreParameters

BASEFILTER_PARAMTER_NAME, BASEORDER_PARAMTER_NAME, DEFAULTGEOMETRY_PARAMTER_NAME, FIELDS_PARAMTER_NAME, GEOMETRYSUBTYPE_PARAMTER_NAME, GEOMETRYTYPE_PARAMTER_NAME, PARAMETERS_DEFINITION_NAME, PKFIELDS_PARAMTER_NAME, SQL_PARAMTER_NAME, TABLE_PARAMTER_NAME, WORKINGAREA_PARAMTER_NAME

Fields inherited from interface org.gvsig.fmap.dal.store.jdbc.JDBCConnectionParameters

BATCH_SIZE_PARAMETER_NAME, CATALOG_PARAMTER_NAME, DEFAULT_BATCH_SIZE, JDBC_DRIVER_CLASS_PARAMTER_NAME, SCHEMA_PARAMTER_NAME, URL_PARAMTER_NAME

Method Summary

Modifier and Type	Method	Description
String	getBaseFilter()	Get initial filter to use. This filter is passed to BD provider on each request as a base filter.
String	getBaseOrder()	Get initial order to use. This order is used if no custom order is request in query.
int	getBatchSize()
String	getCatalog()	Return catalog parameter
JDBCStoreParameters	getCopy()	Creates and returns a new copy of this DataParameters.
String	getDBName()	Return the value of data base name parameter
String[]	getFields()	Get an array of the field names that we want to use. A null means that we want all fields available.
String	getFieldsString()	Get a comma separated list of the field names that we want to use. A null or empty string means that we want all fields available.
String	getHost()	Return the value of host parameter
String	getJDBCDriverClassName()	Return JDBC driver class name parameter
String	getPassword()	Return the value of password parameter
String[]	getPkFields()	Get an array of the field names that compound the primary key. A null or empty string means that library must detect this information. Note: see DBStoreParameters.getPkFieldsString()
String	getPkFieldsString()	Get a comma separated list of the field names that compound the primary key. A null or empty string means that library must detect this information. Note:If this parameters is undefined, the library can't do this detection, some services will don't be available for this store (like selection, editing or Feature.getReference())
Integer	getPort()	Return the value of port parameter
String	getSchema()	Return schema parameter
String	getSourceId()	Compound a string that can identify the source
String	getSQL()	Get the SQL to use as source of the store instead a table or a view. If this property is set the store changes his work flow: store is in read only mode. table property is ignored. pkFields is not identified automatically filter and order will be resolved locally (pour performance)
String	getTable()	Get table parameter value This parameters describes what table or view we want to connect. Not used if sql parameter set.
String	getUrl()	Return JDBC connection URL parameter
String	getUser()	Return the value of user parameter
boolean	isTheSameStore(DataStoreParameters params)
boolean	isValid()	Indicates whether these parameters are valid.
void	setBaseFilter(String initialFilter)	Set initial filter to use. This filter is passed to BD provider on each request as a base filter.
void	setBaseOrder(String order)	Set initial order to use. This order is used if no custom order is request in query.
void	setBatchSize(int batchSize)
void	setCatalog(String catalog)	Set catalog parameter
void	setFields(String fields)	Set a comma separated list of the field names that we want to use. A null means that we want all fields available.
void	setFields(String[] fields)	Set an array of the field names that we want to use. A null means that we want all fields available.
void	setJDBCDriverClassName(String className)	Set JDBC Driver class name parameter
void	setPkFields(String fields)	Set a comma separated list of the field names that compound the primary key. A null or empty string means that library must detect this information. Note: see DBStoreParameters.getPkFieldsString()
void	setPkFields(String[] fields)	Set an array of the field names that compound the primary key. A null or empty string means that library must detect this information. Note: see DBStoreParameters.getPkFieldsString()
void	setPort(int port)
void	setSchema(String schema)	Set schema parameter
void	setSQL(String sql)	Set the SQL to use as source of the store instead a table or a view. Note:see DBStoreParameters.getSQL() for description
void	setTable(String table)	Set table parameter value This parameters describes what table or view we want to connect. Not used if sql parameter set.
void	setUrl(String url)	Set JDBC connection url parameter
String	tableID()	Return table name or schema.tableName if schema parameter is set.

Methods inherited from interface org.gvsig.fmap.dal.DataParameters

clear, toByteArray, toString, validate

Methods inherited from interface org.gvsig.fmap.dal.DataStoreParameters

getProviderName, isTheSameExplorer

Methods inherited from interface org.gvsig.fmap.dal.store.db.DBStoreParameters

getCRS, getDataStoreName, getDefaultGeometryField, getDescription, getGeometrySubtype, getGeometryType, getWorkingArea, setCRS, setCRS, setDBName, setDefaultGeometryField, setGeometrySubtype, setGeometryType, setHost, setPassword, setPort, setUser, setWorkingArea

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Methods inherited from interface org.gvsig.json.SupportFromJson

fromJson

Methods inherited from interface org.gvsig.json.SupportToJson

toJson, toJson, toJsonBuilder, toJsonBuilder

Field Details

BATCHSIZE_PARAMTER_NAME

static final String BATCHSIZE_PARAMTER_NAME

See Also:

• Constant Field Values

Method Details

getBaseFilter

String getBaseFilter()

Description copied from interface: DBStoreParameters

Get initial filter to use.

This filter is passed to BD provider on each request as a base filter.

Specified by:

getBaseFilter in interface DBStoreParameters

Returns:

filter

See Also:

• DBStoreParameters.setBaseFilter(String)

getBaseOrder

String getBaseOrder()

Description copied from interface: DBStoreParameters

Get initial order to use.

This order is used if no custom order is request in query.

Specified by:

getBaseOrder in interface DBStoreParameters

Returns:

order

See Also:

• DBStoreParameters.setBaseOrder(String)

getBatchSize

int getBatchSize()

Specified by:

getBatchSize in interface JDBCConnectionParameters

getCatalog

String getCatalog()

Description copied from interface: JDBCConnectionParameters

Return catalog parameter

Specified by:

getCatalog in interface JDBCConnectionParameters

Returns:

getCopy

JDBCStoreParameters getCopy()

Description copied from interface: DataParameters

Creates and returns a new copy of this DataParameters.

Specified by:

getCopy in interface DataParameters

Returns:

a new copy of this

getDBName

String getDBName()

Description copied from interface: DBParameters

Return the value of data base name parameter

Specified by:

getDBName in interface DBParameters

Specified by:

getDBName in interface DBStoreParameters

Returns:

getFields

String[] getFields()

Description copied from interface: DBStoreParameters

Get an array of the field names that we want to use.

A null means that we want all fields available.

Specified by:

getFields in interface DBStoreParameters

Returns:

See Also:

• DBStoreParameters.getFieldsString()
• DBStoreParameters.setFields(String)
• DBStoreParameters.setFields(String[])

getFieldsString

String getFieldsString()

Description copied from interface: DBStoreParameters

Get a comma separated list of the field names that we want to use.

A null or empty string means that we want all fields available.

Specified by:

getFieldsString in interface DBStoreParameters

Returns:

See Also:

• DBStoreParameters.getFields()
• DBStoreParameters.setFields(String)
• DBStoreParameters.setFields(String[])

getHost

String getHost()

Description copied from interface: DBParameters

Return the value of host parameter

Specified by:

getHost in interface DBParameters

Specified by:

getHost in interface DBStoreParameters

Returns:

getJDBCDriverClassName

String getJDBCDriverClassName()

Description copied from interface: JDBCConnectionParameters

Return JDBC driver class name parameter

Specified by:

getJDBCDriverClassName in interface JDBCConnectionParameters

Returns:

getPassword

String getPassword()

Description copied from interface: DBParameters

Return the value of password parameter

Specified by:

getPassword in interface DBParameters

Specified by:

getPassword in interface DBStoreParameters

Returns:

getPkFields

String[] getPkFields()

Description copied from interface: DBStoreParameters

Get an array of the field names that compound the primary key.

A null or empty string means that library must detect this information.

Note: see DBStoreParameters.getPkFieldsString()

Specified by:

getPkFields in interface DBStoreParameters

Returns:

See Also:

• DBStoreParameters.getPkFieldsString()
• DBStoreParameters.setPkFields(String)
• DBStoreParameters.setPkFields(String[])

getPkFieldsString

String getPkFieldsString()

Description copied from interface: DBStoreParameters

Get a comma separated list of the field names that compound the primary key.

A null or empty string means that library must detect this information.

Note:If this parameters is undefined, the library can't do this detection, some services will don't be available for this store (like selection, editing or Feature.getReference())

Specified by:

getPkFieldsString in interface DBStoreParameters

Returns:

See Also:

• DBStoreParameters.getPkFields()
• DBStoreParameters.setPkFields(String)
• DBStoreParameters.setPkFields(String[])

getPort

Integer getPort()

Description copied from interface: DBParameters

Return the value of port parameter

Specified by:

getPort in interface DBParameters

Specified by:

getPort in interface DBStoreParameters

Returns:

getSQL

String getSQL()

Description copied from interface: DBStoreParameters

Get the SQL to use as source of the store instead a table or a view.

If this property is set the store changes his work flow:

• store is in read only mode.
• table property is ignored.
• pkFields is not identified automatically
• filter and order will be resolved locally (pour performance)

Specified by:

getSQL in interface DBStoreParameters

Returns:

sql to use

See Also:

• DBStoreParameters.getTable()
• invalid reference

  #setTable()

• DBStoreParameters.getPkFields()
• DBStoreParameters.setPkFields(String)

getSchema

String getSchema()

Description copied from interface: JDBCConnectionParameters

Return schema parameter

Specified by:

getSchema in interface JDBCConnectionParameters

Returns:

getSourceId

String getSourceId()

Compound a string that can identify the source

Specified by:

getSourceId in interface DataStoreParameters

Returns:

getTable

String getTable()

Description copied from interface: DBStoreParameters

Get table parameter value

This parameters describes what table or view we want to connect.
Not used if sql parameter set.

Specified by:

getTable in interface DBStoreParameters

See Also:

• DBStoreParameters.setTable(String)
• DBStoreParameters.getSQL()
• DBStoreParameters.setSQL(String)

getUrl

String getUrl()

Description copied from interface: JDBCConnectionParameters

Return JDBC connection URL parameter

Specified by:

getUrl in interface JDBCConnectionParameters

Returns:

getUser

String getUser()

Description copied from interface: DBParameters

Return the value of user parameter

Specified by:

getUser in interface DBParameters

Specified by:

getUser in interface DBStoreParameters

Returns:

isTheSameStore

boolean isTheSameStore(DataStoreParameters params)

Specified by:

isTheSameStore in interface DataStoreParameters

isValid

boolean isValid()

Description copied from interface: DataStoreParameters

Indicates whether these parameters are valid.

Specified by:

isValid in interface DataStoreParameters

Specified by:

isValid in interface DBStoreParameters

Returns:

true if these parameters are valid, false if not.

setBaseFilter

void setBaseFilter(String initialFilter)

Description copied from interface: DBStoreParameters

Set initial filter to use.

This filter is passed to BD provider on each request as a base filter.

Specified by:

setBaseFilter in interface DBStoreParameters

See Also:

• invalid reference

  #getInitialFilter(String)

setBaseOrder

void setBaseOrder(String order)

Description copied from interface: DBStoreParameters

Set initial order to use.

This order is used if no custom order is request in query.

Specified by:

setBaseOrder in interface DBStoreParameters

See Also:

• DBStoreParameters.getBaseOrder()

setBatchSize

void setBatchSize(int batchSize)

setCatalog

void setCatalog(String catalog)

Set catalog parameter

Parameters:

className -

setFields

void setFields(String fields)

Description copied from interface: DBStoreParameters

Set a comma separated list of the field names that we want to use.

A null means that we want all fields available.

Specified by:

setFields in interface DBStoreParameters

See Also:

• DBStoreParameters.getFields()
• DBStoreParameters.getFieldsString()
• DBStoreParameters.setFields(String[])

setFields

void setFields(String[] fields)

Description copied from interface: DBStoreParameters

Set an array of the field names that we want to use.

A null means that we want all fields available.

Specified by:

setFields in interface DBStoreParameters

See Also:

• DBStoreParameters.getFieldsString()
• DBStoreParameters.getFields()
• DBStoreParameters.setFields(String)

setJDBCDriverClassName

void setJDBCDriverClassName(String className)

Set JDBC Driver class name parameter

Parameters:

className -

setPkFields

void setPkFields(String fields)

Description copied from interface: DBStoreParameters

Set a comma separated list of the field names that compound the primary key.

A null or empty string means that library must detect this information.

Note: see DBStoreParameters.getPkFieldsString()

Specified by:

setPkFields in interface DBStoreParameters

See Also:

• DBStoreParameters.getPkFields()
• DBStoreParameters.getPkFieldsString()
• DBStoreParameters.setPkFields(String[])

setPkFields

void setPkFields(String[] fields)

Description copied from interface: DBStoreParameters

Set an array of the field names that compound the primary key.

A null or empty string means that library must detect this information.

Note: see DBStoreParameters.getPkFieldsString()

Specified by:

setPkFields in interface DBStoreParameters

See Also:

• DBStoreParameters.getPkFieldsString()
• DBStoreParameters.getPkFieldsString()
• DBStoreParameters.setPkFields(String)

setPort

void setPort(int port)

Specified by:

setPort in interface DBStoreParameters

setSQL

void setSQL(String sql)

Description copied from interface: DBStoreParameters

Set the SQL to use as source of the store instead a table or a view.

Note:see DBStoreParameters.getSQL() for description

Specified by:

setSQL in interface DBStoreParameters

See Also:

• DBStoreParameters.getSQL()
• DBStoreParameters.getTable()
• invalid reference

  #setTable()

• DBStoreParameters.getPkFields()
• DBStoreParameters.setPkFields(String)

setSchema

void setSchema(String schema)

Set schema parameter

Parameters:

className -

setTable

void setTable(String table)

Description copied from interface: DBStoreParameters

Set table parameter value

This parameters describes what table or view we want to connect.
Not used if sql parameter set.

Specified by:

setTable in interface DBStoreParameters

See Also:

• invalid reference

  #getTable(String)

• DBStoreParameters.getSQL()
• DBStoreParameters.setSQL(String)

setUrl

void setUrl(String url)

Set JDBC connection url parameter

Parameters:

url -

tableID

String tableID()

Return table name or schema.tableName if schema parameter is set.

Returns: