@LcdService(service=ILcdModelEncoder.class, priority=20000) public class TLcdPostGISModelEncoder extends Object implements ILcdModelEncoder
ILcdModelEncoder
encodes models into PostgreSQL PostGIS
databases.
A spatial database is accessed based on a set of properties. The properties
can be passed in a Properties
object, or using a properties file
with extension "pgs
".
The common properties needed to establish a connection and to specify tables,
columns, rows, etc. are the same as those for the
TLcdPostGISModelDecoder
. In addition, the following
properties are required:
SRID
the spatial reference ID for the spatial data.
geometryType
(default = "GEOMETRY
"): the SQL
data type of the geometry column, as listed the OpenGIS Well Known Binary
specification. The encoder also supports the special geodetic type
GEOGRAPHY
that is available in PostGIS 1.5 and higher.
featureDataTypes.0
, ...: the SQL data types of the feature
columns. Each featureNames.i
must have a
corresponding featureDataTypes.i
.
dropBeforeCreatingTable
(optional, default =
false
): if set to true
, the encoder will
attempt to drop the spatial table before re-creating it.
# The basic database connection properties. driver = org.postgresql.Driver url = jdbc:postgresql://server:5432/database user = user password = password # The data of interest. table = STATES spatialColumn = GEOM # The feature columns to be decoded. featureNames.0 = ID featureNames.1 = STATE # The index of the feature that can be used as primary key. primaryFeatureIndex = 0 # Optional additional constraints to retrieve a subset of the table. #selectionTables = #selectionFilter = STATE = 'New York' # Optional maximum cache size (expressed as number of objects, default is 100). maxCacheSize = 60 # Optionally close the database connection after each query. # Only advisable when using a connection pooling database driver. #alwaysCloseConnection = false # Additional properties required for creating a new PostgreSQL PostGIS table. SRID = 4326 # WGS 84 lon lat # Optional geometry type of the geometry column. #geometryType = MULTIPOLYGON # The regular SQL data types of the feature columns. featureDataTypes.0 = NUMERIC(11,3) featureDataTypes.1 = CHAR(20)# Optional the dimension size of the geometry. # 2 for 2D geometry (default), 3 for 3D geometry. #dimensions = 3 The encoder supports
ILcdShape
objects. They are converted
to PostgreSQL PostGIS objects as follows:
FROMILcdShape | TOWKB GEOMETRY |
---|---|
ILcd2DEditablePoint or ILcd3DEditablePoint | POINT |
ILcd2DEditablePolypoint or ILcd3DEditablePolypoint | MULTIPOINT |
ILcd2DEditablePolyline or ILcd3DEditablePolyline | POLYLINE |
ILcd2DEditablePolygon or ILcd3DEditablePolygon | POLYGON |
ILcdComplexPolygon | POLYGON |
ILcdShapeList containing *multiple ILcd2DEditablePoint or ILcd3DEditablePoint instances | MULTIPOINT |
ILcdShapeList containing *multiple ILcd2DEditablePolyline or ILcd3DEditablePolyline instances | MULTIPOLYLINE |
ILcdShapeList containing *multiple ILcd2DEditablePolygon or ILcd3DEditablePolygon instances | MULTIPOLYGON |
ILcdShapeList containing *multiple ILcdComplexPolygon instances | MULTIPOLYGON |
ILcdShapeList containing one of the above (recursive) instances | GEOMETRYCOLLECTION |
ILcdDataObject
interface using the getValue
method.
Objects must therefore implement the ILcdDataObject
interface.Constructor and Description |
---|
TLcdPostGISModelEncoder()
Creates a new PostGIS PostgreSQL model encoder.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canExport(ILcdModel aModel,
String aDestinationName)
Returns whether the given model can be saved into the database described by the given properties file.
|
boolean |
canSave(ILcdModel aModel)
Returns whether the given model can be saved back into the database.
|
void |
export(ILcdModel aModel,
Properties aProperties)
Exports the given model in a new table, based on the given properties.
|
void |
export(ILcdModel aModel,
String aDestinationName)
Exports the given model in a new table, based on the properties in the given file.
|
int |
getAutoCommitCount()
Returns the number of inserted elements after which an export operation
is committed.
|
String |
getDisplayName()
Returns a short, displayable name for the format this
ILcdModelEncoder encodes to. |
void |
save(ILcdModel aModel)
Saves the given model in its original location, by committing all changes.
|
void |
setAutoCommitCount(int aAutoCommitCount)
Sets the number of inserted elements after which an export operation
should be committed, periodically.
|
public TLcdPostGISModelEncoder()
public void setAutoCommitCount(int aAutoCommitCount)
public int getAutoCommitCount()
public String getDisplayName()
ILcdModelEncoder
ILcdModelEncoder
encodes to.getDisplayName
in interface ILcdModelEncoder
ILcdModelEncoder
.public boolean canExport(ILcdModel aModel, String aDestinationName)
canExport
in interface ILcdModelEncoder
aModel
- the model to be verified.aDestinationName
- the location where the model should be exported to.true
if this encoder can export the specified model to the
specified location, false
otherwise.ILcdModelEncoder.export(com.luciad.model.ILcdModel, java.lang.String)
public void export(ILcdModel aModel, String aDestinationName) throws IOException, IllegalArgumentException
export
in interface ILcdModelEncoder
aModel
- the model to be exported.aDestinationName
- the properties file describing the database table to be created.IOException
- for any database access errors. This includes the case where the table already exists.IllegalArgumentException
- if the model cannot be saved by this encoder (!canExport(aModel, aDestinationName)
).public void export(ILcdModel aModel, Properties aProperties) throws IOException, IllegalArgumentException
aModel
- the model to be exported.aProperties
- the properties describing the database table to be created.IOException
- for any database access errors. This includes the case where the table already exists.IllegalArgumentException
public boolean canSave(ILcdModel aModel)
canSave
in interface ILcdModelEncoder
aModel
- the model to be verified.true
if this encoder can save the model in the location where it originally came from,
false
otherwise.ILcdModelEncoder.save(com.luciad.model.ILcdModel)
public void save(ILcdModel aModel) throws IOException, IllegalArgumentException
save
in interface ILcdModelEncoder
aModel
- the database model to be committed.IOException
- for any database access errors.IllegalArgumentException
- if the model cannot be saved by this encoder (!canSave(aModel)
).