public abstract class DBStoreParameters extends AbstractDataParameters implements OpenFeatureStoreParameters, DBConnectionParameter
Modifier and Type | Field and Description |
---|---|
static String |
BASEFILTER_PARAMTER_NAME
Parameter name for
initial filter |
static String |
BASEORDER_PARAMTER_NAME
Parameter name for
initial order |
static String |
CRS_PARAMTER_NAME
Parameter name for
CRS |
static String |
DEFAULTGEOMETRY_PARAMTER_NAME
Parameter name for
default geometry |
static String |
FIELDS_PARAMTER_NAME
Parameter name for
fields |
static String |
PARAMETERS_DEFINITION_NAME |
static String |
PKFIELDS_PARAMTER_NAME
Parameter name for
pk fields |
static String |
SQL_PARAMTER_NAME
Parameter name for
sql |
static String |
TABLE_PARAMTER_NAME
Parameter name for the name of
table |
static String |
WORKINGAREA_PARAMTER_NAME
Parameter name for
working area O |
DBNAME_PARAMTER_NAME, HOST_PARAMTER_NAME, PASSWORD_PARAMTER_NAME, PORT_PARAMTER_NAME, USER_PARAMTER_NAME
Constructor and Description |
---|
DBStoreParameters(String parametersDefinitionName,
String providerName) |
Modifier and Type | Method and Description |
---|---|
String |
getBaseFilter()
Get initial filter to use.
|
String |
getBaseOrder()
Get initial order to use.
|
IProjection |
getCRS()
Get the SRS id string set manually for the
default geometry
field of this layer. |
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. |
protected DelegatedDynObject |
getDelegatedDynObject()
Returns an instance of the
DynObject to delegate to. |
String |
getDescription()
Returns the DataStore's description
|
String[] |
getFields()
Get an array of the field names that we want to use.
|
String |
getFieldsString()
Get a comma separated list of the field names that we want to use.
|
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.
|
String |
getPkFieldsString()
Get a comma separated list of the field names that compound the primary
key.
|
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.
|
String |
getTable()
Get
table parameter valueThis parameters describes what table or view we want to connect. |
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(String filter)
Set initial filter to use.
|
void |
setBaseOrder(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(String srs) |
void |
setDBName(String dbName)
Set
data base name/code> parameter value |
void |
setDefaultGeometryField(String geomName)
Set the geometry field to use like default geometry.
|
void |
setFields(String fields)
Set a comma separated list of the field names that we want to use.
|
void |
setFields(String[] fields)
Set an array of the field names that we want to use.
|
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.
|
void |
setPkFields(String[] fields)
Set an array of the field names that compound the primary key.
|
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.
|
void |
setTable(String table)
Set
table parameter valueThis parameters describes what table or view we want to connect. |
void |
setUser(String user)
Set
user/code> parameter value |
void |
setWorkingArea(Envelope workingArea)
Set the filter by area of
getDefaultGeometryField() used in this
store. |
clear, copyValuesTo, delegate, getCopy, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, loadFromState, saveToState, setDynValue, toString, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
clear, getCopy, validate
loadFromState, saveToState
delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue
public static final String PARAMETERS_DEFINITION_NAME
public static final String SQL_PARAMTER_NAME
sql
getSQL()
,
setSQL(String)
,
Constant Field Valuespublic static final String FIELDS_PARAMTER_NAME
fields
public static final String BASEFILTER_PARAMTER_NAME
initial filter
public static final String BASEORDER_PARAMTER_NAME
initial order
getBaseOrder()
,
setBaseOrder(String)
,
Constant Field Valuespublic static final String PKFIELDS_PARAMTER_NAME
pk fields
public static final String DEFAULTGEOMETRY_PARAMTER_NAME
default geometry
public static final String TABLE_PARAMTER_NAME
table
getTable()
,
setTable(String)
,
Constant Field Valuespublic static final String WORKINGAREA_PARAMTER_NAME
working area
public static final String CRS_PARAMTER_NAME
CRS
#setSRSID(String)
,
#getSRS()
,
#setSRS(IProjection)
,
Constant Field Valuesprotected DelegatedDynObject getDelegatedDynObject()
AbstractDataParameters
DynObject
to delegate to.getDelegatedDynObject
in class AbstractDataParameters
DynObject
public String getDataStoreName()
DataStoreParameters
getDataStoreName
in interface DataStoreParameters
getDataStoreName
in class AbstractDataParameters
public String getDescription()
DataStoreParameters
getDescription
in interface DataStoreParameters
getDescription
in class AbstractDataParameters
public boolean isValid()
DataStoreParameters
isValid
in interface DataStoreParameters
public String getHost()
DBParameters
host
parametergetHost
in interface DBParameters
public Integer getPort()
DBParameters
port
parametergetPort
in interface DBParameters
public String getDBName()
DBParameters
data base name
parametergetDBName
in interface DBParameters
public String getUser()
DBParameters
user
parametergetUser
in interface DBParameters
public String getPassword()
DBParameters
password
parametergetPassword
in interface DBParameters
public void setHost(String host)
public void setPort(int port)
public void setPort(Integer port)
port/code> parameter value
port
- public void setDBName(String dbName)
data base name/code> parameter value
data
- base namepublic void setUser(String user)
user/code> parameter value
user
- public void setPassword(String password)
password/code> parameter value
password
- public String getTable()
table
parameter valuesql
parameter set.password
- setTable(String)
,
getSQL()
,
setSQL(String)
public void setTable(String table)
table
parameter valuesql
parameter set.password
- #getTable(String)
,
getSQL()
,
setSQL(String)
public String getFieldsString()
null
or empty string means that we want all fields
available.getFields()
,
setFields(String)
,
setFields(String[])
public String[] getFields()
null
means that we want all fields available.getFieldsString()
,
setFields(String)
,
setFields(String[])
public void setFields(String fields)
null
means that we want all fields available.getFields()
,
getFieldsString()
,
setFields(String[])
public void setFields(String[] fields)
null
means that we want all fields available.getFieldsString()
,
getFields()
,
setFields(String)
public String getSQL()
table
property is ignored.pkFields
is not identified automaticallygetTable()
,
#setTable()
,
getPkFields()
,
setPkFields(String)
public void setSQL(String sql)
getSQL()
for descriptiongetSQL()
,
getTable()
,
#setTable()
,
getPkFields()
,
setPkFields(String)
public String getBaseFilter()
setBaseFilter(String)
public void setBaseFilter(String filter)
#getInitialFilter(String)
public String getBaseOrder()
setBaseOrder(String)
public void setBaseOrder(String order)
getBaseOrder()
public String getPkFieldsString()
null
or empty string means that library must detect this
information.Feature.getReference()
)getPkFields()
,
setPkFields(String)
,
setPkFields(String[])
public String[] getPkFields()
null
or empty string means that library must detect this
information.getPkFieldsString()
getPkFieldsString()
,
setPkFields(String)
,
setPkFields(String[])
public void setPkFields(String fields)
null
or empty string means that library must detect this
information.getPkFieldsString()
getPkFields()
,
getPkFieldsString()
,
setPkFields(String[])
public void setPkFields(String[] fields)
null
or empty string means that library must detect this
information.getPkFieldsString()
public String getDefaultGeometryField()
Feature.getDefaultGeometry()
)setDefaultGeometryField(String)
public void setDefaultGeometryField(String geomName)
getDefaultGeometryField()
for description.geomName
- getDefaultGeometryField()
public Envelope getWorkingArea()
getDefaultGeometryField()
used in this
store.public void setWorkingArea(Envelope workingArea)
getDefaultGeometryField()
used in this
store.public void setCRS(IProjection srs)
default geometry
field of this
layer.null
or empty string means that the library
must detect it automatically.#setSRSID(String)
,
#getSRSID()
,
#getSRS()
public void setCRS(String srs)
public IProjection getCRS()
default geometry
field of this layer.null
means that the library must detect it
automatically.#setSRSID(String)
,
#getSRS()
,
#setSRS(IProjection)