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
- Author:
- fdiaz
-
Field Summary
FieldsFields inherited from interface org.gvsig.fmap.dal.DataParameters
CRS_PARAMTER_NAMEFields inherited from interface org.gvsig.fmap.dal.resource.db.DBParameters
DBNAME_PARAMTER_NAME, HOST_PARAMTER_NAME, PASSWORD_PARAMTER_NAME, PORT_PARAMTER_NAME, USER_PARAMTER_NAMEFields 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_NAMEFields 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 TypeMethodDescriptionGet initial filter to use.
This filter is passed to BD provider on each request as a base filter.Get initial order to use.
This order is used if no custom order is request in query.intReturncatalogparametergetCopy()Creates and returns a new copy of this DataParameters.Return the value ofdata base nameparameterString[]Get an array of the field names that we want to use.
Anullmeans that we want all fields available.Get a comma separated list of the field names that we want to use.
Anullor empty string means that we want all fields available.getHost()Return the value ofhostparameterReturnJDBC driver class nameparameterReturn the value ofpasswordparameterString[]Get an array of the field names that compound the primary key.
Anullor empty string means that library must detect this information.
Note: seeDBStoreParameters.getPkFieldsString()Get a comma separated list of the field names that compound the primary key.
Anullor 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 orFeature.getReference())getPort()Return the value ofportparameterReturnschemaparameterCompound a string that can identify the sourcegetSQL()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.tableproperty is ignored.pkFieldsis not identified automatically filter and order will be resolved locally (pour performance)getTable()Gettableparameter value
This parameters describes what table or view we want to connect.
Not used ifsqlparameter set.getUrl()ReturnJDBC connection URLparametergetUser()Return the value ofuserparameterbooleanisTheSameStore(DataStoreParameters params) booleanisValid()Indicates whether these parameters are valid.voidsetBaseFilter(String initialFilter) Set initial filter to use.
This filter is passed to BD provider on each request as a base filter.voidsetBaseOrder(String order) Set initial order to use.
This order is used if no custom order is request in query.voidsetBatchSize(int batchSize) voidsetCatalog(String catalog) SetcatalogparametervoidSet a comma separated list of the field names that we want to use.
Anullmeans that we want all fields available.voidSet an array of the field names that we want to use.
Anullmeans that we want all fields available.voidsetJDBCDriverClassName(String className) SetJDBC Driver class nameparametervoidsetPkFields(String fields) Set a comma separated list of the field names that compound the primary key.
Anullor empty string means that library must detect this information.
Note: seeDBStoreParameters.getPkFieldsString()voidsetPkFields(String[] fields) Set an array of the field names that compound the primary key.
Anullor empty string means that library must detect this information.
Note: seeDBStoreParameters.getPkFieldsString()voidsetPort(int port) voidSetschemaparametervoidSet the SQL to use as source of the store instead a table or a view.
Note:seeDBStoreParameters.getSQL()for descriptionvoidSettableparameter value
This parameters describes what table or view we want to connect.
Not used ifsqlparameter set.voidSetJDBC connection urlparametertableID()Return tablenameorschema.tableNameifschemaparameter is set.Methods inherited from interface org.gvsig.fmap.dal.DataParameters
clear, toByteArray, toString, validateMethods inherited from interface org.gvsig.fmap.dal.DataStoreParameters
getProviderName, isTheSameExplorerMethods 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, setWorkingAreaMethods inherited from interface org.gvsig.tools.dynobject.DynObject
delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValueMethods inherited from interface org.gvsig.tools.persistence.Persistent
loadFromState, saveToStateMethods inherited from interface org.gvsig.json.SupportFromJson
fromJsonMethods inherited from interface org.gvsig.json.SupportToJson
toJson, toJson, toJsonBuilder, toJsonBuilder
-
Field Details
-
BATCHSIZE_PARAMTER_NAME
- See Also:
-
-
Method Details
-
getBaseFilter
String getBaseFilter()Description copied from interface:DBStoreParametersGet initial filter to use.
This filter is passed to BD provider on each request as a base filter.- Specified by:
getBaseFilterin interfaceDBStoreParameters- Returns:
- filter
- See Also:
-
getBaseOrder
String getBaseOrder()Description copied from interface:DBStoreParametersGet initial order to use.
This order is used if no custom order is request in query.- Specified by:
getBaseOrderin interfaceDBStoreParameters- Returns:
- order
- See Also:
-
getBatchSize
int getBatchSize()- Specified by:
getBatchSizein interfaceJDBCConnectionParameters
-
getCatalog
String getCatalog()Description copied from interface:JDBCConnectionParametersReturncatalogparameter- Specified by:
getCatalogin interfaceJDBCConnectionParameters- Returns:
-
getCopy
JDBCStoreParameters getCopy()Description copied from interface:DataParametersCreates and returns a new copy of this DataParameters.- Specified by:
getCopyin interfaceDataParameters- Returns:
- a new copy of this
-
getDBName
String getDBName()Description copied from interface:DBParametersReturn the value ofdata base nameparameter- Specified by:
getDBNamein interfaceDBParameters- Specified by:
getDBNamein interfaceDBStoreParameters- Returns:
-
getFields
String[] getFields()Description copied from interface:DBStoreParametersGet an array of the field names that we want to use.
Anullmeans that we want all fields available.- Specified by:
getFieldsin interfaceDBStoreParameters- Returns:
- See Also:
-
getFieldsString
String getFieldsString()Description copied from interface:DBStoreParametersGet a comma separated list of the field names that we want to use.
Anullor empty string means that we want all fields available.- Specified by:
getFieldsStringin interfaceDBStoreParameters- Returns:
- See Also:
-
getHost
String getHost()Description copied from interface:DBParametersReturn the value ofhostparameter- Specified by:
getHostin interfaceDBParameters- Specified by:
getHostin interfaceDBStoreParameters- Returns:
-
getJDBCDriverClassName
String getJDBCDriverClassName()Description copied from interface:JDBCConnectionParametersReturnJDBC driver class nameparameter- Specified by:
getJDBCDriverClassNamein interfaceJDBCConnectionParameters- Returns:
-
getPassword
String getPassword()Description copied from interface:DBParametersReturn the value ofpasswordparameter- Specified by:
getPasswordin interfaceDBParameters- Specified by:
getPasswordin interfaceDBStoreParameters- Returns:
-
getPkFields
String[] getPkFields()Description copied from interface:DBStoreParametersGet an array of the field names that compound the primary key.
Anullor empty string means that library must detect this information.
Note: seeDBStoreParameters.getPkFieldsString()- Specified by:
getPkFieldsin interfaceDBStoreParameters- Returns:
- See Also:
-
getPkFieldsString
String getPkFieldsString()Description copied from interface:DBStoreParametersGet a comma separated list of the field names that compound the primary key.
Anullor 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 orFeature.getReference())- Specified by:
getPkFieldsStringin interfaceDBStoreParameters- Returns:
- See Also:
-
getPort
Integer getPort()Description copied from interface:DBParametersReturn the value ofportparameter- Specified by:
getPortin interfaceDBParameters- Specified by:
getPortin interfaceDBStoreParameters- Returns:
-
getSQL
String getSQL()Description copied from interface:DBStoreParametersGet 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.
tableproperty is ignored.pkFieldsis not identified automatically- filter and order will be resolved locally (pour performance)
- Specified by:
getSQLin interfaceDBStoreParameters- Returns:
- sql to use
- See Also:
-
getSchema
String getSchema()Description copied from interface:JDBCConnectionParametersReturnschemaparameter- Specified by:
getSchemain interfaceJDBCConnectionParameters- Returns:
-
getSourceId
String getSourceId()Compound a string that can identify the source- Specified by:
getSourceIdin interfaceDataStoreParameters- Returns:
-
getTable
String getTable()Description copied from interface:DBStoreParametersGettableparameter value
This parameters describes what table or view we want to connect.
Not used ifsqlparameter set.- Specified by:
getTablein interfaceDBStoreParameters- See Also:
-
getUrl
String getUrl()Description copied from interface:JDBCConnectionParametersReturnJDBC connection URLparameter- Specified by:
getUrlin interfaceJDBCConnectionParameters- Returns:
-
getUser
String getUser()Description copied from interface:DBParametersReturn the value ofuserparameter- Specified by:
getUserin interfaceDBParameters- Specified by:
getUserin interfaceDBStoreParameters- Returns:
-
isTheSameStore
- Specified by:
isTheSameStorein interfaceDataStoreParameters
-
isValid
boolean isValid()Description copied from interface:DataStoreParametersIndicates whether these parameters are valid.- Specified by:
isValidin interfaceDataStoreParameters- Specified by:
isValidin interfaceDBStoreParameters- Returns:
- true if these parameters are valid, false if not.
-
setBaseFilter
Description copied from interface:DBStoreParametersSet initial filter to use.
This filter is passed to BD provider on each request as a base filter.- Specified by:
setBaseFilterin interfaceDBStoreParameters- See Also:
-
setBaseOrder
Description copied from interface:DBStoreParametersSet initial order to use.
This order is used if no custom order is request in query.- Specified by:
setBaseOrderin interfaceDBStoreParameters- See Also:
-
setBatchSize
void setBatchSize(int batchSize) -
setCatalog
Setcatalogparameter- Parameters:
className-
-
setFields
Description copied from interface:DBStoreParametersSet a comma separated list of the field names that we want to use.
Anullmeans that we want all fields available.- Specified by:
setFieldsin interfaceDBStoreParameters- See Also:
-
setFields
Description copied from interface:DBStoreParametersSet an array of the field names that we want to use.
Anullmeans that we want all fields available.- Specified by:
setFieldsin interfaceDBStoreParameters- See Also:
-
setJDBCDriverClassName
SetJDBC Driver class nameparameter- Parameters:
className-
-
setPkFields
Description copied from interface:DBStoreParametersSet a comma separated list of the field names that compound the primary key.
Anullor empty string means that library must detect this information.
Note: seeDBStoreParameters.getPkFieldsString()- Specified by:
setPkFieldsin interfaceDBStoreParameters- See Also:
-
setPkFields
Description copied from interface:DBStoreParametersSet an array of the field names that compound the primary key.
Anullor empty string means that library must detect this information.
Note: seeDBStoreParameters.getPkFieldsString()- Specified by:
setPkFieldsin interfaceDBStoreParameters- See Also:
-
setPort
void setPort(int port) - Specified by:
setPortin interfaceDBStoreParameters
-
setSQL
Description copied from interface:DBStoreParametersSet the SQL to use as source of the store instead a table or a view.
Note:seeDBStoreParameters.getSQL()for description- Specified by:
setSQLin interfaceDBStoreParameters- See Also:
-
setSchema
Setschemaparameter- Parameters:
className-
-
setTable
Description copied from interface:DBStoreParametersSettableparameter value
This parameters describes what table or view we want to connect.
Not used ifsqlparameter set.- Specified by:
setTablein interfaceDBStoreParameters- See Also:
-
setUrl
SetJDBC connection urlparameter- Parameters:
url-
-
tableID
String tableID()Return tablenameorschema.tableNameifschemaparameter is set.- Returns:
-