AbstractDBStoreParameters

java.lang.Object
- org.gvsig.fmap.dal.spi.AbstractDataParameters
- - org.gvsig.fmap.dal.spi.AbstractDataStoreParameters
  - - org.gvsig.fmap.dal.store.db.AbstractDBStoreParameters

All Implemented Interfaces:

DataParameters, DataStoreParameters, OpenFeatureStoreParameters, OpenDataStoreParameters, DBParameters, DBConnectionParameter, DBStoreParameters, SupportFromJson, SupportToJson, DynObject, Persistent, Validator

Direct Known Subclasses:

JDBCStoreParametersBase
```
public abstract class AbstractDBStoreParameters
extends AbstractDataStoreParameters
implements DBStoreParameters
```
Abstract Data base Store Parameters

Field Summary
- 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.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.DataParameters
  CRS_PARAMTER_NAME

Constructor Summary

Constructors
Constructor and Description

AbstractDBStoreParameters(java.lang.String parametersDefinitionName, java.lang.String providerName)

Constructors
Constructor and Description
`AbstractDBStoreParameters(java.lang.String parametersDefinitionName, java.lang.String providerName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBaseFilter()` Get initial filter to use.
`java.lang.String`	`getBaseOrder()` Get initial order to use.
`IProjection`	`getCRS()` Get the SRS id string set manually for the `default geometry` field of this layer.
`java.lang.String`	`getDataStoreName()` Returns the DataStore's name
`java.lang.String`	`getDBName()` Return the value of `data base name` parameter
`java.lang.String`	`getDefaultGeometryField()` Return the geometry field to use like default geometry (see `Feature.getDefaultGeometry()`) This option is supported only in geometry providers.
`protected DelegatedDynObject`	`getDelegatedDynObject()` Returns an instance of the `DynObject` to delegate to.
`java.lang.String`	`getDescription()` Returns the DataStore's description
`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.
`int`	`getGeometrySubtype()`
`int`	`getGeometryType()`
`java.lang.String`	`getHost()` Return the value of `host` 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`	`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`	`getUser()` Return the value of `user` parameter
`Envelope`	`getWorkingArea()` Get the filter by area of `getDefaultGeometryField()` used in this store.
`boolean`	`isValid()` Indicates whether these parameters are valid.
`void`	`setBaseFilter(java.lang.String filter)` Set initial filter to use.
`void`	`setBaseOrder(java.lang.String order)` Set initial order to use.
`void`	`setCRS(IProjection srs)` Set manually the SRS for the `default geometry` field of this layer.
`void`	`setCRS(java.lang.String srs)`
`void`	`setDBName(java.lang.String dbName)` Set `data base name/code> parameter value`
`void`	`setDefaultGeometryField(java.lang.String geomName)` Set the geometry field to use like default geometry.
`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`	`setGeometrySubtype(int geometrySubtype)`
`void`	`setGeometryType(int geometryType)`
`void`	`setHost(java.lang.String host)`
`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`	`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`	`setUser(java.lang.String user)` Set `user/code> parameter value`
`void`	`setWorkingArea(Envelope workingArea)` Set the filter by area of `getDefaultGeometryField()` used in this store.

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataStoreParameters
getSourceId, isTheSameStore

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataParameters
clear, copyValuesTo, delegate, equals, fromByteArray, fromJson, getCause, getCopy, getDynClass, getDynValue, getMessage, getProviderName, hasDynValue, hashCode, implement, invokeDynMethod, invokeDynMethod, isValid, loadFromState, loadPRJ, loadWLD, saveToState, setDynValue, toByteArray, toJson, toJsonBuilder, toString, toString, validate

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

Methods inherited from interface org.gvsig.fmap.dal.DataStoreParameters
getProviderName, getSourceId, isTheSameStore

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

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

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

Methods inherited from interface org.gvsig.json.SupportToJson
toJson, toJson, toJsonBuilder, toJsonBuilder

Methods inherited from interface org.gvsig.json.SupportFromJson
fromJson

- Constructor Detail
  - AbstractDBStoreParameters
```
public AbstractDBStoreParameters(java.lang.String parametersDefinitionName,
                                 java.lang.String providerName)
```
- Method Detail
  - getDelegatedDynObject
```
protected DelegatedDynObject getDelegatedDynObject()
```
    Description copied from class: AbstractDataParameters
    
    Returns an instance of the DynObject to delegate to.
    
    Specified by:
    
    getDelegatedDynObject in class AbstractDataParameters
    
    Returns:
    
    the delegate DynObject
  - getDataStoreName
```
public java.lang.String getDataStoreName()
```
    Description copied from interface: DataStoreParameters
    
    Returns the DataStore's name
    
    Specified by:
    
    getDataStoreName in interface DataStoreParameters
    
    Specified by:
    
    getDataStoreName in interface DBStoreParameters
    
    Overrides:
    
    getDataStoreName in class AbstractDataParameters
    
    Returns:
    
    a String containing the DataStore's name
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: DataStoreParameters
    
    Returns the DataStore's description
    
    Specified by:
    
    getDescription in interface DataStoreParameters
    
    Specified by:
    
    getDescription in interface DBStoreParameters
    
    Overrides:
    
    getDescription in class AbstractDataParameters
    
    Returns:
    
    a String containing the DataStore's description
  - isValid
```
public 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.
  - getHost
```
public java.lang.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:
  - getPort
```
public java.lang.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:
  - 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
    
    Specified by:
    
    getDBName in interface 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
    
    Specified by:
    
    getUser in interface 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
    
    Specified by:
    
    getPassword in interface DBStoreParameters
    
    Returns:
  - setHost
```
public void setHost(java.lang.String host)
```
    Specified by:
    
    setHost in interface DBParameters
    
    Specified by:
    
    setHost in interface DBStoreParameters
  - setPort
```
public void setPort(int port)
```
    Specified by:
    
    setPort in interface DBStoreParameters
  - setPort
```
public void setPort(java.lang.Integer port)
```
    Set port/code> parameter value
    Specified by: setPort in interface DBParameters Specified by: setPort in interface DBStoreParameters Parameters: port -
  setDBName public void setDBName(java.lang.String dbName) Set data base name/code> parameter value Specified by: setDBName in interface DBParameters Specified by: setDBName in interface DBStoreParameters Parameters: data - base name setUser public void setUser(java.lang.String user) Set user/code> parameter value Specified by: setUser in interface DBParameters Specified by: setUser in interface DBStoreParameters Parameters: user - setPassword public void setPassword(java.lang.String password) Set password/code> parameter value Specified by: setPassword in interface DBParameters Specified by: setPassword in interface DBStoreParameters Parameters: password - getTable public java.lang.String getTable() 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 Parameters: password - See Also: setTable(String), getSQL(), setSQL(String) setTable public void setTable(java.lang.String table) 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 Parameters: password - See Also: #getTable(String), getSQL(), setSQL(String) getFieldsString public java.lang.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. Specified by: getFieldsString in interface DBStoreParameters Returns: See Also: getFields(), setFields(String), setFields(String[]) getFields public java.lang.String[] getFields() 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: getFieldsString(), setFields(String), setFields(String[]) setFields public void setFields(java.lang.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. Specified by: setFields in interface DBStoreParameters See Also: getFields(), getFieldsString(), setFields(String[]) setFields public void setFields(java.lang.String[] fields) 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: getFieldsString(), getFields(), setFields(String) getSQL public java.lang.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) Specified by: getSQL in interface DBStoreParameters Returns: sql to use See Also: getTable(), #setTable(), getPkFields(), setPkFields(String) setSQL public void setSQL(java.lang.String sql) Set the SQL to use as source of the store instead a table or a view. Note:see getSQL() for description Specified by: setSQL in interface DBStoreParameters See Also: getSQL(), getTable(), #setTable(), getPkFields(), setPkFields(String) getBaseFilter public java.lang.String getBaseFilter() 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: setBaseFilter(String) setBaseFilter public void setBaseFilter(java.lang.String filter) 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: #getInitialFilter(String) getBaseOrder public java.lang.String getBaseOrder() 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: setBaseOrder(String) setBaseOrder public void setBaseOrder(java.lang.String order) 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: getBaseOrder() getPkFieldsString public java.lang.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()) Specified by: getPkFieldsString in interface DBStoreParameters Returns: See Also: getPkFields(), setPkFields(String), setPkFields(String[]) getPkFields public java.lang.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 getPkFieldsString() Specified by: getPkFields in interface DBStoreParameters Returns: See Also: getPkFieldsString(), setPkFields(String), setPkFields(String[]) setPkFields public void setPkFields(java.lang.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 getPkFieldsString() Specified by: setPkFields in interface DBStoreParameters See Also: getPkFields(), getPkFieldsString(), setPkFields(String[]) setPkFields public void setPkFields(java.lang.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 getPkFieldsString() Specified by: setPkFields in interface DBStoreParameters See Also: getPkFieldsString(), getPkFieldsString(), setPkFields(String) getDefaultGeometryField public java.lang.String getDefaultGeometryField() Return the geometry field to use like default geometry (see Feature.getDefaultGeometry()) This option is supported only in geometry providers. If this parameters is not set and store has only one field geometry then library uses that field as default Specified by: getDefaultGeometryField in interface DBStoreParameters Returns: See Also: setDefaultGeometryField(String) setDefaultGeometryField public void setDefaultGeometryField(java.lang.String geomName) Set the geometry field to use like default geometry. See getDefaultGeometryField() for description. Specified by: setDefaultGeometryField in interface DBStoreParameters Parameters: geomName - See Also: getDefaultGeometryField() getWorkingArea public Envelope getWorkingArea() Get the filter by area of getDefaultGeometryField() used in this store. Supported only for stores with geometric fields Specified by: getWorkingArea in interface DBStoreParameters Returns: setWorkingArea public void setWorkingArea(Envelope workingArea) Set the filter by area of getDefaultGeometryField() used in this store. Supported only for stores with geometric fields Specified by: setWorkingArea in interface DBStoreParameters setCRS public void setCRS(IProjection srs) Set manually the SRS for the default geometry field of this layer. if is set to null or empty string means that the library must detect it automatically. Supported only for stores with geometric fields. Specified by: setCRS in interface DBStoreParameters See Also: #setSRSID(String), #getSRSID(), #getSRS() setCRS public void setCRS(java.lang.String srs) Specified by: setCRS in interface DBStoreParameters getCRS public IProjection getCRS() Get the SRS id string set manually for the default geometry field of this layer. if is set to null means that the library must detect it automatically. Supported only for stores with geometric fields. Specified by: getCRS in interface DBStoreParameters Returns: See Also: #setSRSID(String), #getSRS(), #setSRS(IProjection) getGeometryType public int getGeometryType() Specified by: getGeometryType in interface DBStoreParameters setGeometryType public void setGeometryType(int geometryType) Specified by: setGeometryType in interface DBStoreParameters getGeometrySubtype public int getGeometrySubtype() Specified by: getGeometrySubtype in interface DBStoreParameters setGeometrySubtype public void setGeometrySubtype(int geometrySubtype) Specified by: setGeometrySubtype in interface DBStoreParameters

Class AbstractDBStoreParameters

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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.DataStoreParameters

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

Methods inherited from interface org.gvsig.json.SupportToJson

Methods inherited from interface org.gvsig.json.SupportFromJson

Constructor Detail

AbstractDBStoreParameters

Method Detail

getDelegatedDynObject

getDataStoreName

getDescription

isValid

getHost

getPort

getDBName

getUser

getPassword

setHost

setPort

setPort

setDBName

setUser

setPassword

getTable

setTable

getFieldsString

getFields

setFields

setFields

getSQL

setSQL

getBaseFilter

setBaseFilter

getBaseOrder

setBaseOrder

getPkFieldsString

getPkFields

setPkFields

setPkFields

getDefaultGeometryField

setDefaultGeometryField

getWorkingArea

setWorkingArea

setCRS

setCRS

getCRS

getGeometryType

setGeometryType

getGeometrySubtype

setGeometrySubtype