org.gvsig.fmap.dal.store.db

Interface DBStoreParameters

All Superinterfaces:

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

All Known Subinterfaces:

JDBCStoreParameters

All Known Implementing Classes:

AbstractDBStoreParameters, H2SpatialStoreParameters, JDBCStoreParametersBase, MDBStoreParameters, PostgreSQLStoreParameters, SQLiteStoreParameters

public interface DBStoreParameters
extends DBConnectionParameter, OpenFeatureStoreParameters

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASEFILTER_PARAMTER_NAME Parameter name for initial filter
static java.lang.String	BASEORDER_PARAMTER_NAME Parameter name for initial order
static java.lang.String	DEFAULTGEOMETRY_PARAMTER_NAME Parameter name for default geometry
static java.lang.String	FIELDS_PARAMTER_NAME Parameter name for fields
static java.lang.String	GEOMETRYSUBTYPE_PARAMTER_NAME Parameter name for GeometrySubtype
static java.lang.String	GEOMETRYTYPE_PARAMTER_NAME Parameter name for GeometryType
static java.lang.String	PARAMETERS_DEFINITION_NAME
static java.lang.String	PKFIELDS_PARAMTER_NAME Parameter name for pk fields
static java.lang.String	SQL_PARAMTER_NAME Parameter name for sql
static java.lang.String	TABLE_PARAMTER_NAME Parameter name for the name of table
static java.lang.String	WORKINGAREA_PARAMTER_NAME Parameter name for working area O

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

Method Summary

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

Field Detail

BASEFILTER_PARAMTER_NAME

static final java.lang.String BASEFILTER_PARAMTER_NAME

Parameter name for initial filter

See Also:

getBaseFilter(), setBaseFilter(String), Constant Field Values

BASEORDER_PARAMTER_NAME

static final java.lang.String BASEORDER_PARAMTER_NAME

Parameter name for initial order

See Also:

getBaseOrder(), setBaseOrder(String), Constant Field Values

DEFAULTGEOMETRY_PARAMTER_NAME

static final java.lang.String DEFAULTGEOMETRY_PARAMTER_NAME

Parameter name for default geometry

See Also:

getDefaultGeometryField(), setDefaultGeometryField(String), Constant Field Values

FIELDS_PARAMTER_NAME

static final java.lang.String FIELDS_PARAMTER_NAME

Parameter name for fields

See Also:

getFields(), getFieldsString(), setFields(String), setFields(String[]), Constant Field Values

GEOMETRYSUBTYPE_PARAMTER_NAME

static final java.lang.String GEOMETRYSUBTYPE_PARAMTER_NAME

Parameter name for GeometrySubtype

See Also:

setGeometrySubtype(int), getGeometrySubtype(), Constant Field Values

GEOMETRYTYPE_PARAMTER_NAME

static final java.lang.String GEOMETRYTYPE_PARAMTER_NAME

Parameter name for GeometryType

See Also:

setGeometryType(int), getGeometryType(), Constant Field Values

PARAMETERS_DEFINITION_NAME

static final java.lang.String PARAMETERS_DEFINITION_NAME

See Also:

Constant Field Values

PKFIELDS_PARAMTER_NAME

static final java.lang.String PKFIELDS_PARAMTER_NAME

Parameter name for pk fields

See Also:

getPkFields(), getPkFieldsString(), setPkFields(String), setPkFields(String[]), Constant Field Values

SQL_PARAMTER_NAME

static final java.lang.String SQL_PARAMTER_NAME

Parameter name for sql

See Also:

getSQL(), setSQL(String), Constant Field Values

TABLE_PARAMTER_NAME

static final java.lang.String TABLE_PARAMTER_NAME

Parameter name for the name of table

See Also:

getTable(), setTable(String), Constant Field Values

WORKINGAREA_PARAMTER_NAME

static final java.lang.String WORKINGAREA_PARAMTER_NAME

Parameter name for working area
O

See Also:

getWorkingArea(), setWorkingArea(Envelope), Constant Field Values

Method Detail

getBaseFilter

java.lang.String getBaseFilter()

Get initial filter to use.

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

Returns:

filter

See Also:

setBaseFilter(String)

getBaseOrder

java.lang.String getBaseOrder()

Get initial order to use.

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

Returns:

order

See Also:

setBaseOrder(String)

getCRS

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.

Returns:

See Also:

#setSRSID(String), #getSRS(), #setSRS(IProjection)

getDBName

java.lang.String getDBName()

Description copied from interface: DBParameters

Return the value of data base name parameter

Specified by:

getDBName in interface DBParameters

Returns:

getDataStoreName

java.lang.String getDataStoreName()

Description copied from interface: DataStoreParameters

Returns the DataStore's name

Specified by:

getDataStoreName in interface DataStoreParameters

Returns:

a String containing the DataStore's name

getDefaultGeometryField

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

Returns:

See Also:

setDefaultGeometryField(String)

getDescription

java.lang.String getDescription()

Description copied from interface: DataStoreParameters

Returns the DataStore's description

Specified by:

getDescription in interface DataStoreParameters

Returns:

a String containing the DataStore's description

getFields

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.

Returns:

See Also:

getFieldsString(), setFields(String), setFields(String[])

getFieldsString

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.

Returns:

See Also:

getFields(), setFields(String), setFields(String[])

getGeometrySubtype

int getGeometrySubtype()

getGeometryType

int getGeometryType()

getHost

java.lang.String getHost()

Description copied from interface: DBParameters

Return the value of host parameter

Specified by:

getHost in interface DBParameters

Returns:

getPassword

java.lang.String getPassword()

Description copied from interface: DBParameters

Return the value of password parameter

Specified by:

getPassword in interface DBParameters

Returns:

getPkFields

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()

Returns:

See Also:

getPkFieldsString(), setPkFields(String), setPkFields(String[])

getPkFieldsString

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())

Returns:

See Also:

getPkFields(), setPkFields(String), setPkFields(String[])

getPort

java.lang.Integer getPort()

Description copied from interface: DBParameters

Return the value of port parameter

Specified by:

getPort in interface DBParameters

Returns:

getSQL

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)

Returns:

sql to use

See Also:

getTable(), #setTable(), getPkFields(), setPkFields(String)

getTable

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.

Parameters:

password -

See Also:

setTable(String), getSQL(), setSQL(String)

getUser

java.lang.String getUser()

Description copied from interface: DBParameters

Return the value of user parameter

Specified by:

getUser in interface DBParameters

Returns:

getWorkingArea

Envelope getWorkingArea()

Get the filter by area of getDefaultGeometryField() used in this store.

Supported only for stores with geometric fields

Returns:

isValid

boolean isValid()

Description copied from interface: DataStoreParameters

Indicates whether these parameters are valid.

Specified by:

isValid in interface DataStoreParameters

Returns:

true if these parameters are valid, false if not.

setBaseFilter

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.

See Also:

#getInitialFilter(String)

setBaseOrder

void setBaseOrder(java.lang.String order)

Set initial order to use.

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

See Also:

getBaseOrder()

setCRS

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.

See Also:

#setSRSID(String), #getSRSID(), #getSRS()

setCRS

void setCRS(java.lang.String srs)

setDBName

void setDBName(java.lang.String dbName)

Set data base name/code> parameter value

Specified by:

setDBName in interface DBParameters

Parameters:

data - base name

setDefaultGeometryField

void setDefaultGeometryField(java.lang.String geomName)

Set the geometry field to use like default geometry.
See getDefaultGeometryField() for description.

Parameters:

geomName -

See Also:

getDefaultGeometryField()

setFields

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.

See Also:

getFields(), getFieldsString(), setFields(String[])

setFields

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.

See Also:

getFieldsString(), getFields(), setFields(String)

setGeometrySubtype

void setGeometrySubtype(int geometrySubtype)

setGeometryType

void setGeometryType(int geometryType)

setHost

void setHost(java.lang.String host)

Specified by:

setHost in interface DBParameters

setPassword

void setPassword(java.lang.String password)

Set password/code> parameter value

Specified by:

setPassword in interface DBParameters

Parameters:

password -

setPkFields

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()

See Also:

getPkFields(), getPkFieldsString(), setPkFields(String[])

setPkFields

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()

See Also:

getPkFieldsString(), getPkFieldsString(), setPkFields(String)

setPort

void setPort(int port)

setPort

void setPort(java.lang.Integer port)

Set port/code> parameter value

Specified by:

setPort in interface DBParameters

Parameters:

port -

setSQL

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

See Also:

getSQL(), getTable(), #setTable(), getPkFields(), setPkFields(String)

setTable

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.

Parameters:

password -

See Also:

#getTable(String), getSQL(), setSQL(String)

setUser

void setUser(java.lang.String user)

Set user/code> parameter value

Specified by:

setUser in interface DBParameters

Parameters:

user -

setWorkingArea

void setWorkingArea(Envelope workingArea)

Set the filter by area of getDefaultGeometryField() used in this store.

Supported only for stores with geometric fields