Package org.gvsig.fmap.dal.store.db

Interface DBStoreParameters

All Superinterfaces:

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

All Known Subinterfaces:

JDBCStoreParameters

public interface DBStoreParameters
extends DBConnectionParameter, OpenFeatureStoreParameters

Author:

fdiaz

Field Summary

Fields

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

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

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.
org.gvsig.crs.projection.lib.Projection	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.
String	getDataStoreName()	Returns the DataStore's name
String	getDBName()	Return the value of data base name parameter
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
String	getDescription()	Returns the DataStore's description
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.
int	getGeometrySubtype()
int	getGeometryType()
String	getHost()	Return the value of host 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 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	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	getUser()	Return the value of user parameter
org.gvsig.fmap.geom.primitive.Envelope	getWorkingArea()	Get the filter by area of getDefaultGeometryField() used in this store. Supported only for stores with geometric fields
boolean	isValid()	Indicates whether these parameters are valid.
void	setBaseFilter(String filter)	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	setCRS(String srs)
void	setCRS(org.gvsig.crs.projection.lib.Projection 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.
void	setDBName(String dbName)	Set data base name/code> parameter value
void	setDefaultGeometryField(String geomName)	Set the geometry field to use like default geometry. See getDefaultGeometryField() for description.
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	setGeometrySubtype(int geometrySubtype)
void	setGeometryType(int geometryType)
void	setHost(String host)
void	setPassword(String password)	Set password/code> parameter value
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 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 getPkFieldsString()
void	setPort(int port)
void	setPort(Integer port)	Set port/code> parameter value
void	setSQL(String sql)	Set the SQL to use as source of the store instead a table or a view. Note:see 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	setUser(String user)	Set user/code> parameter value
void	setWorkingArea(org.gvsig.fmap.geom.primitive.Envelope workingArea)	Set the filter by area of getDefaultGeometryField() used in this store. Supported only for stores with geometric fields

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

clear, getCopy, toByteArray, toString, validate

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

getProviderName, getSourceId, isTheSameExplorer, isTheSameStore

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

BASEFILTER_PARAMTER_NAME

static final String BASEFILTER_PARAMTER_NAME

Parameter name for initial filter

See Also:

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

BASEORDER_PARAMTER_NAME

static final String BASEORDER_PARAMTER_NAME

Parameter name for initial order

See Also:

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

DEFAULTGEOMETRY_PARAMTER_NAME

static final String DEFAULTGEOMETRY_PARAMTER_NAME

Parameter name for default geometry

See Also:

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

FIELDS_PARAMTER_NAME

static final String FIELDS_PARAMTER_NAME

Parameter name for fields

See Also:

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

GEOMETRYSUBTYPE_PARAMTER_NAME

static final String GEOMETRYSUBTYPE_PARAMTER_NAME

Parameter name for GeometrySubtype

See Also:

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

GEOMETRYTYPE_PARAMTER_NAME

static final String GEOMETRYTYPE_PARAMTER_NAME

Parameter name for GeometryType

See Also:

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

PARAMETERS_DEFINITION_NAME

static final String PARAMETERS_DEFINITION_NAME

See Also:

• Constant Field Values

PKFIELDS_PARAMTER_NAME

static final 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 String SQL_PARAMTER_NAME

Parameter name for sql

See Also:

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

TABLE_PARAMTER_NAME

static final String TABLE_PARAMTER_NAME

Parameter name for the name of table

See Also:

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

WORKINGAREA_PARAMTER_NAME

static final String WORKINGAREA_PARAMTER_NAME

Parameter name for working area
O

See Also:

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

Method Details

getBaseFilter

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

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

org.gvsig.crs.projection.lib.Projection 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:

• invalid reference

  #setSRSID(String)

• invalid reference

  #getSRS()

• invalid reference

  #setSRS(Projection)

getDBName

String getDBName()

Description copied from interface: DBParameters

Return the value of data base name parameter

Specified by:

getDBName in interface DBParameters

Returns:

getDataStoreName

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

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

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

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

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

String getHost()

Description copied from interface: DBParameters

Return the value of host parameter

Specified by:

getHost in interface DBParameters

Returns:

getPassword

String getPassword()

Description copied from interface: DBParameters

Return the value of password parameter

Specified by:

getPassword in interface DBParameters

Returns:

getPkFields

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

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

Integer getPort()

Description copied from interface: DBParameters

Return the value of port parameter

Specified by:

getPort in interface DBParameters

Returns:

getSQL

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()
• invalid reference

  #setTable()

• getPkFields()
• setPkFields(String)

getTable

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

String getUser()

Description copied from interface: DBParameters

Return the value of user parameter

Specified by:

getUser in interface DBParameters

Returns:

getWorkingArea

org.gvsig.fmap.geom.primitive.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(String filter)

Set initial filter to use.

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

See Also:

• invalid reference

  #getInitialFilter(String)

setBaseOrder

void setBaseOrder(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(org.gvsig.crs.projection.lib.Projection 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:

• invalid reference

  #setSRSID(String)

• invalid reference

  #getSRSID()

• invalid reference

  #getSRS()

setCRS

void setCRS(String srs)

setDBName

void setDBName(String dbName)

Set data base name/code> parameter value

Specified by:

setDBName in interface DBParameters

Parameters:

data - base name

setDefaultGeometryField

void setDefaultGeometryField(String geomName)

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

Parameters:

geomName -

See Also:

• getDefaultGeometryField()

setFields

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.

See Also:

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

setFields

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.

See Also:

• getFieldsString()
• getFields()
• setFields(String)

setGeometrySubtype

void setGeometrySubtype(int geometrySubtype)

setGeometryType

void setGeometryType(int geometryType)

setHost

void setHost(String host)

Specified by:

setHost in interface DBParameters

setPassword

void setPassword(String password)

Set password/code> parameter value

Specified by:

setPassword in interface DBParameters

Parameters:

password -

setPkFields

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

See Also:

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

setPkFields

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

See Also:

• getPkFieldsString()
• getPkFieldsString()
• setPkFields(String)

setPort

void setPort(int port)

setPort

void setPort(Integer port)

Set port/code> parameter value

Specified by:

setPort in interface DBParameters

Parameters:

port -

setSQL

void setSQL(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()
• invalid reference

  #setTable()

• getPkFields()
• setPkFields(String)

setTable

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.

Parameters:

password -

See Also:

• invalid reference

  #getTable(String)

• getSQL()
• setSQL(String)

setUser

void setUser(String user)

Set user/code> parameter value

Specified by:

setUser in interface DBParameters

Parameters:

user -

setWorkingArea

void setWorkingArea(org.gvsig.fmap.geom.primitive.Envelope workingArea)

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

Supported only for stores with geometric fields