JDBCStoreParameters

java.lang.Object
- org.gvsig.fmap.dal.spi.AbstractDataParameters
- - org.gvsig.fmap.dal.store.db.DBStoreParameters
  - - org.gvsig.fmap.dal.store.jdbc.JDBCStoreParameters

All Implemented Interfaces:

DataParameters, DataStoreParameters, OpenDataStoreParameters, DBParameters, DBConnectionParameter, JDBCConnectionParameters, DynObject, Persistent

Direct Known Subclasses:

H2StoreParameters, PostgreSQLStoreParameters
```
public class JDBCStoreParameters
extends DBStoreParameters
implements JDBCConnectionParameters
```
Parameters class for JDBC generic provider

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PARAMETERS_DEFINITION_NAME
- Fields inherited from class org.gvsig.fmap.dal.store.db.DBStoreParameters
  BASEFILTER_PARAMTER_NAME, BASEORDER_PARAMTER_NAME, CRS_PARAMTER_NAME, DEFAULTGEOMETRY_PARAMTER_NAME, FIELDS_PARAMTER_NAME, PKFIELDS_PARAMTER_NAME, SQL_PARAMTER_NAME, TABLE_PARAMTER_NAME, WORKINGAREA_PARAMTER_NAME
- Fields inherited from interface org.gvsig.fmap.dal.store.jdbc.JDBCConnectionParameters
  CATALOG_PARAMTER_NAME, JDBC_DRIVER_CLASS_PARAMTER_NAME, SCHEMA_PARAMTER_NAME, URL_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
Modifier and Type	Field and Description
`static java.lang.String`	`PARAMETERS_DEFINITION_NAME`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`JDBCStoreParameters()`
`protected`	`JDBCStoreParameters(java.lang.String parametersDefinitionName)`
`protected`	`JDBCStoreParameters(java.lang.String parametersDefinitionName, java.lang.String providerName)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`escapeName(java.lang.String name)`
`java.lang.String`	`getBaseFilter()` Get initial filter to use.
`java.lang.String`	`getBaseOrder()` Get initial order to use.
`java.lang.String`	`getCatalog()` Return `catalog` parameter
`java.lang.String`	`getDBName()` Return the value of `data base name` parameter
`java.lang.String[]`	`getFields()` Get an array of the field names that we want to use.
`java.lang.String`	`getFieldsString()` Get a comma separated list of the field names that we want to use.
`java.lang.String`	`getHost()` Return the value of `host` parameter
`java.lang.String`	`getJDBCDriverClassName()` Return `JDBC driver class name` parameter
`java.lang.String`	`getPassword()` Return the value of `password` parameter
`java.lang.String[]`	`getPkFields()` Get an array of the field names that compound the primary key.
`java.lang.String`	`getPkFieldsString()` Get a comma separated list of the field names that compound the primary key.
`java.lang.Integer`	`getPort()` Return the value of `port` parameter
`java.lang.String`	`getSchema()` Return `schema` parameter
`java.lang.String`	`getSourceId()` Compound a string that can identify the source
`java.lang.String`	`getSQL()` Get the SQL to use as source of the store instead a table or a view.
`java.lang.String`	`getTable()` Get `table` parameter value This parameters describes what table or view we want to connect.
`java.lang.String`	`getUrl()` Return `JDBC connection URL` parameter
`java.lang.String`	`getUser()` Return the value of `user` parameter
`boolean`	`isValid()` Indicates whether these parameters are valid.
`void`	`setBaseFilter(java.lang.String initialFilter)` Set initial filter to use.
`void`	`setBaseOrder(java.lang.String order)` Set initial order to use.
`void`	`setCatalog(java.lang.String catalog)` Set `catalog` parameter
`void`	`setDBName(java.lang.String dbName)` Set `data base name/code> parameter value`
`void`	`setFields(java.lang.String fields)` Set a comma separated list of the field names that we want to use.
`void`	`setFields(java.lang.String[] fields)` Set an array of the field names that we want to use.
`void`	`setHost(java.lang.String host)`
`void`	`setJDBCDriverClassName(java.lang.String className)` Set `JDBC Driver class name` parameter
`void`	`setPassword(java.lang.String password)` Set `password/code> parameter value`
`void`	`setPkFields(java.lang.String fields)` Set a comma separated list of the field names that compound the primary key.
`void`	`setPkFields(java.lang.String[] fields)` Set an array of the field names that compound the primary key.
`void`	`setPort(int port)`
`void`	`setPort(java.lang.Integer port)` Set `port/code> parameter value`
`void`	`setSchema(java.lang.String schema)` Set `schema` parameter
`void`	`setSQL(java.lang.String sql)` Set the SQL to use as source of the store instead a table or a view.
`void`	`setTable(java.lang.String table)` Set `table` parameter value This parameters describes what table or view we want to connect.
`void`	`setUrl(java.lang.String url)` Set `JDBC connection url` parameter
`void`	`setUser(java.lang.String user)` Set `user/code> parameter value`
`java.lang.String`	`tableID()` Return table `name` or `schema.tableName` if `schema` parameter is set.

Methods inherited from class org.gvsig.fmap.dal.store.db.DBStoreParameters
getCRS, getDataStoreName, getDefaultGeometryField, getDelegatedDynObject, getDescription, getWorkingArea, setCRS, setDefaultGeometryField, setWorkingArea

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataParameters
clear, copyValuesTo, delegate, getCopy, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, loadFromState, saveToState, setDynValue, toString, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.dal.DataParameters
clear, getCopy, validate

Methods inherited from interface org.gvsig.tools.persistence.Persistent
loadFromState, saveToState

Methods inherited from interface org.gvsig.tools.dynobject.DynObject
delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

- Field Detail
  - PARAMETERS_DEFINITION_NAME
```
public static final java.lang.String PARAMETERS_DEFINITION_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - JDBCStoreParameters
```
public JDBCStoreParameters()
```
  - JDBCStoreParameters
```
protected JDBCStoreParameters(java.lang.String parametersDefinitionName)
```
  - JDBCStoreParameters
```
protected JDBCStoreParameters(java.lang.String parametersDefinitionName,
                   java.lang.String providerName)
```
- Method Detail
  - isValid
```
public boolean isValid()
```
    Description copied from interface: DataStoreParameters
    
    Indicates whether these parameters are valid.
    
    Specified by:
    
    isValid in interface DataStoreParameters
    
    Overrides:
    
    isValid in class DBStoreParameters
    
    Returns:
    true if these parameters are valid, false if not.
  - getHost
```
public java.lang.String getHost()
```
    Description copied from interface: DBParameters
    
    Return the value of host parameter
    
    Specified by:
    
    getHost in interface DBParameters
    
    Overrides:
    
    getHost in class DBStoreParameters
    
    Returns:
  - getPort
```
public java.lang.Integer getPort()
```
    Description copied from interface: DBParameters
    
    Return the value of port parameter
    
    Specified by:
    
    getPort in interface DBParameters
    
    Overrides:
    
    getPort in class DBStoreParameters
    
    Returns:
  - getDBName
```
public java.lang.String getDBName()
```
    Description copied from interface: DBParameters
    
    Return the value of data base name parameter
    
    Specified by:
    
    getDBName in interface DBParameters
    
    Overrides:
    
    getDBName in class DBStoreParameters
    
    Returns:
  - getUser
```
public java.lang.String getUser()
```
    Description copied from interface: DBParameters
    
    Return the value of user parameter
    
    Specified by:
    
    getUser in interface DBParameters
    
    Overrides:
    
    getUser in class DBStoreParameters
    
    Returns:
  - getPassword
```
public java.lang.String getPassword()
```
    Description copied from interface: DBParameters
    
    Return the value of password parameter
    
    Specified by:
    
    getPassword in interface DBParameters
    
    Overrides:
    
    getPassword in class DBStoreParameters
    
    Returns:
  - setHost
```
public void setHost(java.lang.String host)
```
    Overrides:
    
    setHost in class DBStoreParameters
  - setPort
```
public void setPort(int port)
```
    Overrides:
    
    setPort in class DBStoreParameters
  - setPort
```
public void setPort(java.lang.Integer port)
```
    Description copied from class: DBStoreParameters
    
    Set port/code> parameter value
    Overrides: setPort in class DBStoreParameters
  setDBName public void setDBName(java.lang.String dbName) Description copied from class: DBStoreParameters Set data base name/code> parameter value Overrides: setDBName in class DBStoreParameters setUser public void setUser(java.lang.String user) Description copied from class: DBStoreParameters Set user/code> parameter value Overrides: setUser in class DBStoreParameters setPassword public void setPassword(java.lang.String password) Description copied from class: DBStoreParameters Set password/code> parameter value Overrides: setPassword in class DBStoreParameters setJDBCDriverClassName public void setJDBCDriverClassName(java.lang.String className) Set JDBC Driver class name parameter Parameters: className - getJDBCDriverClassName public java.lang.String getJDBCDriverClassName() Description copied from interface: JDBCConnectionParameters Return JDBC driver class name parameter Specified by: getJDBCDriverClassName in interface JDBCConnectionParameters Returns: getCatalog public java.lang.String getCatalog() Description copied from interface: JDBCConnectionParameters Return catalog parameter Specified by: getCatalog in interface JDBCConnectionParameters Returns: setCatalog public void setCatalog(java.lang.String catalog) Set catalog parameter Parameters: className - getSchema public java.lang.String getSchema() Description copied from interface: JDBCConnectionParameters Return schema parameter Specified by: getSchema in interface JDBCConnectionParameters Returns: setSchema public void setSchema(java.lang.String schema) Set schema parameter Parameters: className - getTable public java.lang.String getTable() Description copied from class: DBStoreParameters Get table parameter value This parameters describes what table or view we want to connect. Not used if sql parameter set. Overrides: getTable in class DBStoreParameters See Also: DBStoreParameters.setTable(String), DBStoreParameters.getSQL(), DBStoreParameters.setSQL(String) setTable public void setTable(java.lang.String table) Description copied from class: DBStoreParameters Set table parameter value This parameters describes what table or view we want to connect. Not used if sql parameter set. Overrides: setTable in class DBStoreParameters See Also: #getTable(String), DBStoreParameters.getSQL(), DBStoreParameters.setSQL(String) getFieldsString public java.lang.String getFieldsString() Description copied from class: 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. Overrides: getFieldsString in class DBStoreParameters Returns: See Also: DBStoreParameters.getFields(), DBStoreParameters.setFields(String), DBStoreParameters.setFields(String[]) getFields public java.lang.String[] getFields() Description copied from class: DBStoreParameters Get an array of the field names that we want to use. A null means that we want all fields available. Overrides: getFields in class DBStoreParameters Returns: See Also: DBStoreParameters.getFieldsString(), DBStoreParameters.setFields(String), DBStoreParameters.setFields(String[]) setFields public void setFields(java.lang.String fields) Description copied from class: DBStoreParameters Set a comma separated list of the field names that we want to use. A null means that we want all fields available. Overrides: setFields in class DBStoreParameters See Also: DBStoreParameters.getFields(), DBStoreParameters.getFieldsString(), DBStoreParameters.setFields(String[]) setFields public void setFields(java.lang.String[] fields) Description copied from class: DBStoreParameters Set an array of the field names that we want to use. A null means that we want all fields available. Overrides: setFields in class DBStoreParameters See Also: DBStoreParameters.getFieldsString(), DBStoreParameters.getFields(), DBStoreParameters.setFields(String) getSQL public java.lang.String getSQL() Description copied from class: 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) Overrides: getSQL in class DBStoreParameters Returns: sql to use See Also: DBStoreParameters.getTable(), #setTable(), DBStoreParameters.getPkFields(), DBStoreParameters.setPkFields(String) setSQL public void setSQL(java.lang.String sql) Description copied from class: DBStoreParameters Set the SQL to use as source of the store instead a table or a view. Note:see DBStoreParameters.getSQL() for description Overrides: setSQL in class DBStoreParameters See Also: DBStoreParameters.getSQL(), DBStoreParameters.getTable(), #setTable(), DBStoreParameters.getPkFields(), DBStoreParameters.setPkFields(String) getBaseFilter public java.lang.String getBaseFilter() Description copied from class: DBStoreParameters Get initial filter to use. This filter is passed to BD provider on each request as a base filter. Overrides: getBaseFilter in class DBStoreParameters Returns: filter See Also: DBStoreParameters.setBaseFilter(String) setBaseFilter public void setBaseFilter(java.lang.String initialFilter) Description copied from class: DBStoreParameters Set initial filter to use. This filter is passed to BD provider on each request as a base filter. Overrides: setBaseFilter in class DBStoreParameters See Also: #getInitialFilter(String) getBaseOrder public java.lang.String getBaseOrder() Description copied from class: DBStoreParameters Get initial order to use. This order is used if no custom order is request in query. Overrides: getBaseOrder in class DBStoreParameters Returns: order See Also: DBStoreParameters.setBaseOrder(String) setBaseOrder public void setBaseOrder(java.lang.String order) Description copied from class: DBStoreParameters Set initial order to use. This order is used if no custom order is request in query. Overrides: setBaseOrder in class DBStoreParameters See Also: DBStoreParameters.getBaseOrder() getPkFieldsString public java.lang.String getPkFieldsString() Description copied from class: 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()) Overrides: getPkFieldsString in class DBStoreParameters Returns: See Also: DBStoreParameters.getPkFields(), DBStoreParameters.setPkFields(String), DBStoreParameters.setPkFields(String[]) getPkFields public java.lang.String[] getPkFields() Description copied from class: 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() Overrides: getPkFields in class DBStoreParameters Returns: See Also: DBStoreParameters.getPkFieldsString(), DBStoreParameters.setPkFields(String), DBStoreParameters.setPkFields(String[]) setPkFields public void setPkFields(java.lang.String fields) Description copied from class: 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() Overrides: setPkFields in class DBStoreParameters See Also: DBStoreParameters.getPkFields(), DBStoreParameters.getPkFieldsString(), DBStoreParameters.setPkFields(String[]) setPkFields public void setPkFields(java.lang.String[] fields) Description copied from class: 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() Overrides: setPkFields in class DBStoreParameters See Also: DBStoreParameters.getPkFieldsString(), DBStoreParameters.getPkFieldsString(), DBStoreParameters.setPkFields(String) tableID public java.lang.String tableID() Return table name or schema.tableName if schema parameter is set. Returns: escapeName protected java.lang.String escapeName(java.lang.String name) getSourceId public java.lang.String getSourceId() Compound a string that can identify the source Returns: getUrl public java.lang.String getUrl() Description copied from interface: JDBCConnectionParameters Return JDBC connection URL parameter Specified by: getUrl in interface JDBCConnectionParameters Returns: setUrl public void setUrl(java.lang.String url) Set JDBC connection url parameter Parameters: url -

Class JDBCStoreParameters

Field Summary

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataParameters

Methods inherited from class java.lang.Object

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

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

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

Field Detail

PARAMETERS_DEFINITION_NAME

Constructor Detail

JDBCStoreParameters

JDBCStoreParameters

JDBCStoreParameters

Method Detail

isValid

getHost

getPort

getDBName

getUser

getPassword

setHost

setPort

setPort

setDBName

setUser

setPassword

setJDBCDriverClassName

getJDBCDriverClassName

getCatalog

setCatalog

getSchema

setSchema

getTable

setTable

getFieldsString

getFields

setFields

setFields

getSQL

setSQL

getBaseFilter

setBaseFilter

getBaseOrder

setBaseOrder

getPkFieldsString

getPkFields

setPkFields

setPkFields

tableID

escapeName

getSourceId

getUrl

setUrl