This is documentation of a bèta release.
For documentation on the current version, please check Knowledge Base.

Orbit DataBase File

An Orbit DataBase file (*.odb) is Orbit's database resource (database table) connection file.
An odb file is a file based connection to one well defined database resource. It makes it possible to work with database resources in the same way as file based resources.

It is strongly advised to read first the documentation about Spatial Databases.

Structure

The odb configuration settings :

  • Spatial type
    • Oracle Spatial
    • SpatialCLOB
      • WKT: read and write
      • eWKT: read only
    • SpatialBLOB
      • WKB: read and write
    • PointXY (2D) and PointXYZ (3D)
  • Required fields
    • Unique identifier
    • References about spatial fields in the database
  • Desired visible attributes
  • Edit rights
  • Fixed Fields

An odb file can be edited using a text editor, take care of its structure.

Tags

Parameter Value Value Type Description
DATABASE
CONNECTION <Orbit Database Connection> String Name of Orbit Database Connection.
MODELS
MODEL
ID <Model sequence number> Integer Starting from 1 to amount of models
NAME <Model name> String Orbit name of the model
TYPE POINT String Spatial component are Points
LINE String Spatial component are Lines
AREA String Spatial component are Areas
COORDINATEMODEL 2D String 2 dimension Spatial Component (without Z value)
3D String 3 dimension Spatial Component (with Z value)
TABLENAME <Database Scheme>.<Table name> String Name of database table in table within the database connection.
For some databases : case sensitive and/or scheme name must be added as prefix (e.g. Oracle).
OBJECTID_COLUMN <Column name> String Unique identifier defined by a single column
KEY(<Column names comma separated>) String Unique idintifier defined by multiple columns
SPATIALTYPE SpatialCLOB String Text markup language : Well Known Text Characters (WKT)
* Type of objects : points, lines or areas
* Dimension : 2D or 3D
SpatialBLOB String Text markup language : Well Known Text Binary (WKB)
* Type of objects : points, lines or areas
* Dimension : 2D or 3D
com.orbitgis.orbitx.driver.
spatialsql.oracle10.TypeOracleSpatial
String Oracle Spatial SQL
* Type of objects : points, lines or areas
* Dimension : 2D or 3D
com.orbitgis.orbitx.driver.
spatialsql.oracle11.TypeOracleSpatial
PointXY String Separated coordinate fields
* Type of objects : points
* Dimension : 2D
PointXYZ String Separated coordinate fields
* Type of objects : points
* Dimension : 3D
SPATIAL_COLUMN <Column name> Longtext Column containing vector geometry for the following spatialtypes:
* SpatialCLOB (WKT)
* SpatialBLOB (WKB)
* Oracle Spatial SQL
SPATIAL_COLUMN_X <Column name X coordinate> Double Column containing a separate x,y - coordinate
* PointXY (2D)
* PointXYZ (3D)
SPATIAL_COLUMN_Y <Column name Y coordinate> Double
SPATIAL_COLUMN_Z <Column name Z coordinate> Double Column containing a separate z-coordinate (only PointXYZ)
SPATIAL_SRID <Oracle SRID number> Integer Only necessary when using SPATIALTYPE Oracle Spatial SQL. See Wikipedia Srid
ATTRIBUTES <Column names comma separated> String Columns that should be visible as attribute.
If this tag isn't available or no columns are listed, Orbit will display all available database columns as attribute except spatial columns.
ATTRIBUTES_HIDDEN <Column names comma separated> String Columns that should be hidden.
UPDATEMODE READONLY String Database table access level: read only
ONLY_UPDATES String Database table access level: editing existing objects (attribute and spatial information) is permitted, but one cannot add or delete objects (rows)
ONLY_SPATIAL_UPDATES String Database table access level: editing of existing objects (only spatial information) is permitted, but one cannot add or delete objects (rows)
FULL_CONTROL String Database table access level: full control
FIXED_FIELDS <column name>:<value>
<column name>:<value>;<column name>:<value>
String the records or objects included in a separate model can be restricted to a specific attribute value

Examples

Single Model Dataset - Oracle

DATABASE=
 CONNECTION=
MODELS=
 MODEL=
  ID=1
  NAME=
  TYPE=
  COORDINATEMODEL=
  TABLENAME=
  OBJECTID_COLUMN=
  SPATIALTYPE=
  SPATIAL_COLUMN=
  SPATIAL_SRID=
  UPDATEMODE=

Multi Model Dataset

DATABASE=
 CONNECTION=inventory
MODELS=
 MODEL=
  ID=1
  NAME=Trees
  TYPE=POINT
  COORDINATEMODEL=2D
  TABLENAME=green_elements
  OBJECTID_COLUMN=ID
  SPATIALTYPE=PointXY
  SPATIAL_COLUMN_X=area_x
  SPATIAL_COLUMN_Y=area_y
  ATTRIBUTES=
  LASTCHANGEQUERY=
  UPDATEMODE=READONLY
  FIXED_FIELDS=type:1
 MODEL=
  ID=2
  NAME=roads
  TYPE=LINE
  COORDINATEMODEL=2D
  TABLENAME=public_space
  OBJECTID_COLUMN=id
  SPATIAL_COLUMN=area_geometry
  SPATIALTYPE=SpatialCLOB
  ATTRIBUTES=
  LASTCHANGEQUERY=
  UPDATEMODE=READONLY
  FIXED_FIELDS=type:2
 MODEL=
  ID=3
  NAME=Areas
  TYPE=AREA
  COORDINATEMODEL=2D
  TABLENAME=public_space
  OBJECTID_COLUMN=id
  SPATIAL_COLUMN=area_geometry
  SPATIALTYPE=SpatialCLOB
  ATTRIBUTES=
  LASTCHANGEQUERY=
  UPDATEMODE=FULL_CONTROL
  FIXED_FIELDS=type:3  
 
Last modified:: 2023/02/20 13:39