Configuration

java.lang.Object
- eu.slipo.athenarc.triplegeo.utils.Configuration

```
public final class Configuration
extends java.lang.Object
```
Parser of user-specified configuration files to be used during transformation of geospatial features into RDF triples.

Version:

2.0

Author:

Kostas Patroumpas

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`attrCategory` Name of the attribute specifying the category of a feature according to a classification scheme.
`java.lang.String`	`attrGeometry` Name of the attribute containing the geometry of a feature.
`java.lang.String`	`attrKey` Name of the input attribute containing a unique identifier of each feature.
`java.lang.String`	`attrName` Name of the attribute specifying the main name of a feature.
`java.lang.String`	`attrX` Name of the attribute containing the X-ordinate (or longitude) of a feature.
`java.lang.String`	`attrY` Name of the attribute containing the Y-ordinate (or latitude) of a feature.
`int`	`batch_size` Default number of entities (i.e., records) to handle in each batch (applicable to STREAM and RML modes).
`java.lang.String`	`classificationSpec` Path to a file specifying a classification hierarchy with categories assigned to features in the dataset.
`boolean`	`classifyByName` Specifies whether the join attribute with the classification scheme is based on the category identifier (false) or the actual name of the category (true).
`java.lang.String`	`dbHost` JDBC parameter for the host name (or IP address) of the computer hosting the database.
`java.lang.String`	`dbName` JDBC parameter for the name of the database to connect to.
`java.lang.String`	`dbPassword` JDBC parameter for the password in the database connection.
`int`	`dbPort` JDBC parameter for the port number on which the database in the host computer accepts user requests.
`java.lang.String`	`dbType` Type of database connection.
`java.lang.String`	`dbUserName` JDBC parameter for the username in the database connection.
`java.lang.String`	`defaultLang` Default language specification tag for string literals.
`char`	`delimiter` Delimiter character for CSV file data sources.
`java.lang.String`	`encoding` Encoding used for strings.
`java.lang.String`	`featureClassificationNS` Namespace for the classification scheme employed for the features.
`java.lang.String`	`featureClassNS` Namespace for the URIs of the category assigned to each feature.
`java.lang.String`	`featureNS` Namespace for feature URIs.
`java.lang.String`	`featureSource` String specifying the data source (provider) of the input dataset(s).
`java.lang.String`	`featureSourceNS` Namespace for the data source URI assigned to each feature.
`java.lang.String`	`filterSQLCondition` SQL filter to be applied on the database table; also, thematic filter (in SQL syntax) over geographical files.
`java.lang.String`	`geometryNS` Geometry namespace for WKT literals and spatial properties.
`java.lang.String`	`inputFiles` Path to file(s) containing input dataset(s).
`java.lang.String`	`inputFormat` Format of input data.
`java.lang.String`	`mappingSpec` Path to a file containing mappings of attributes from input schema to RDF properties.
`java.lang.String`	`mode` Transformation mode: (disk-based) GRAPH, (in-memory) STREAM, (in-memory) XSLT, or RML.
`(package private) Assistant`	`myAssistant`
`java.lang.String[]`	`namespaces` List of namespaces corresponding to the prefixes.
`java.lang.String`	`ontologyNS` Ontology namespace of each transformed feature.
`java.lang.String`	`outputDir` Path to the directory where output files will be written.
`int`	`partitions` Spark parameter for the number of partitions.
`private java.lang.String`	`path` Path to a properties file containing all parameters used in the transformation.
`java.lang.String[]`	`prefixes` List of prefixes for namespaces employed in the transformation.
`char`	`quote` Quote character for strings in CSV file data sources.
`boolean`	`registerFeatures` Indicates whether to export a CSV file with records for the SLIPO Registry.
`java.lang.String`	`runtime` Execution platform at runtime: either JVM (default) or SPARK.
`java.lang.String`	`serialization` Output RDF serialization.
`java.lang.String`	`sourceCRS` Spatial reference system (EPSG code) of the input dataset.
`java.lang.String`	`spark_logger_level` Spark parameter specifying the logging level.
`java.lang.String`	`spatialExtent` Spatial filter to be applied on the input dataset.
`java.lang.String`	`tableName` Name of the database table (or view) where the features will be retrieved from.
`java.lang.String`	`targetCRS` Spatial reference system (EPSG code) of geometries in the output RDF triples.
`java.lang.String`	`targetGeoOntology` Specifies the spatial ontology for geometries in the exported RDF data.
`java.lang.String`	`tmpDir` Path to a directory where intermediate files may be temporarily written during transformation.

Constructor Summary

Constructors
Constructor and Description

Configuration(java.lang.String path)
Constructor of a Configuration object.

Constructors
Constructor and Description
`Configuration(java.lang.String path)` Constructor of a Configuration object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`buildConfiguration()` Loads the configuration from a properties file.
`private void`	`initializeParameters(java.util.Properties properties)` Initializes all the parameters for the transformation from the configuration file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - myAssistant
```
Assistant myAssistant
```
  - runtime
```
public java.lang.String runtime
```
    Execution platform at runtime: either JVM (default) or SPARK. JVM also supports multi-threaded (concurrent) execution.
  - mode
```
public java.lang.String mode
```
    Transformation mode: (disk-based) GRAPH, (in-memory) STREAM, (in-memory) XSLT, or RML.
  - inputFormat
```
public java.lang.String inputFormat
```
    Format of input data. Supported formats: SHAPEFILE, DBMS, CSV, GPX, GEOJSON, XML, OSM.
  - path
```
private java.lang.String path
```
    Path to a properties file containing all parameters used in the transformation.
  - inputFiles
```
public java.lang.String inputFiles
```
    Path to file(s) containing input dataset(s). Multiple input files (of exactly the same format and attributes) can be specified, separating them by ';' in order to activate multiple concurrent threads for their transformation.
  - tmpDir
```
public java.lang.String tmpDir
```
    Path to a directory where intermediate files may be temporarily written during transformation.
  - outputDir
```
public java.lang.String outputDir
```
    Path to the directory where output files will be written. By convention, output RDF files have the same name as their corresponding input dataset.
  - batch_size
```
public int batch_size
```
    Default number of entities (i.e., records) to handle in each batch (applicable to STREAM and RML modes).
  - mappingSpec
```
public java.lang.String mappingSpec
```
    Path to a file containing mappings of attributes from input schema to RDF properties.
  - classificationSpec
```
public java.lang.String classificationSpec
```
    Path to a file specifying a classification hierarchy with categories assigned to features in the dataset.
  - classifyByName
```
public boolean classifyByName
```
    Specifies whether the join attribute with the classification scheme is based on the category identifier (false) or the actual name of the category (true). By default, transformation uses identifiers of categories in the classification scheme. This parameter has no effect if no classification hierarchy has been specified.
  - serialization
```
public java.lang.String serialization
```
    Output RDF serialization. Supported formats: RDF/XML (default), RDF/XML-ABBREV, N-TRIPLES, TURTLE (or TTL), N3.
  - targetGeoOntology
```
public java.lang.String targetGeoOntology
```
    Specifies the spatial ontology for geometries in the exported RDF data. Possible values: 1) "GeoSPARQL", 2) "Virtuoso" (legacy RDF ontology for points only), 3) "wgs84_pos" (for WGS84 Geoposition RDF vocabulary).
  - prefixes
```
public java.lang.String[] prefixes
```
    List of prefixes for namespaces employed in the transformation.
  - namespaces
```
public java.lang.String[] namespaces
```
    List of namespaces corresponding to the prefixes.
  - ontologyNS
```
public java.lang.String ontologyNS
```
    Ontology namespace of each transformed feature.
  - geometryNS
```
public java.lang.String geometryNS
```
    Geometry namespace for WKT literals and spatial properties.
  - featureNS
```
public java.lang.String featureNS
```
    Namespace for feature URIs.
  - featureClassNS
```
public java.lang.String featureClassNS
```
    Namespace for the URIs of the category assigned to each feature.
  - featureClassificationNS
```
public java.lang.String featureClassificationNS
```
    Namespace for the classification scheme employed for the features.
  - featureSourceNS
```
public java.lang.String featureSourceNS
```
    Namespace for the data source URI assigned to each feature.
  - defaultLang
```
public java.lang.String defaultLang
```
    Default language specification tag for string literals.
  - featureSource
```
public java.lang.String featureSource
```
    String specifying the data source (provider) of the input dataset(s).
  - tableName
```
public java.lang.String tableName
```
    Name of the database table (or view) where the features will be retrieved from.
  - filterSQLCondition
```
public java.lang.String filterSQLCondition
```
    SQL filter to be applied on the database table; also, thematic filter (in SQL syntax) over geographical files.
  - spatialExtent
```
public java.lang.String spatialExtent
```
    Spatial filter to be applied on the input dataset.
  - attrKey
```
public java.lang.String attrKey
```
    Name of the input attribute containing a unique identifier of each feature.
  - attrGeometry
```
public java.lang.String attrGeometry
```
    Name of the attribute containing the geometry of a feature.
  - attrName
```
public java.lang.String attrName
```
    Name of the attribute specifying the main name of a feature.
  - attrCategory
```
public java.lang.String attrCategory
```
    Name of the attribute specifying the category of a feature according to a classification scheme.
  - attrX
```
public java.lang.String attrX
```
    Name of the attribute containing the X-ordinate (or longitude) of a feature. Ignored in case that attrGeometry has been specified.
  - attrY
```
public java.lang.String attrY
```
    Name of the attribute containing the Y-ordinate (or latitude) of a feature. Ignored in case that attrGeometry has been specified.
  - registerFeatures
```
public boolean registerFeatures
```
    Indicates whether to export a CSV file with records for the SLIPO Registry. CAUTION! This functionality is applicable in the context of the SLIPO Workbench only.
  - delimiter
```
public char delimiter
```
    Delimiter character for CSV file data sources. Mandatory for CSV input; ignored otherwise.
  - quote
```
public char quote
```
    Quote character for strings in CSV file data sources. Mandatory for CSV input; ignored otherwise.
  - encoding
```
public java.lang.String encoding
```
    Encoding used for strings. Default encoding: UTF-8.
  - sourceCRS
```
public java.lang.String sourceCRS
```
    Spatial reference system (EPSG code) of the input dataset. If omitted, geometries are assumed in WGS84 reference system (EPSG:4326). Example: EPSG:2100
  - targetCRS
```
public java.lang.String targetCRS
```
    Spatial reference system (EPSG code) of geometries in the output RDF triples. If omitted, RDF geometries will retain their original georeference (i.e., no reprojection of coordinates will take place). Example: EPSG:4326
  - dbType
```
public java.lang.String dbType
```
    Type of database connection. Possible values: MSAccess; MySQL; Oracle; PostGIS; DB2; SQLServer; SpatiaLite.
  - dbName
```
public java.lang.String dbName
```
    JDBC parameter for the name of the database to connect to.
  - dbUserName
```
public java.lang.String dbUserName
```
    JDBC parameter for the username in the database connection.
  - dbPassword
```
public java.lang.String dbPassword
```
    JDBC parameter for the password in the database connection.
  - dbHost
```
public java.lang.String dbHost
```
    JDBC parameter for the host name (or IP address) of the computer hosting the database.
  - dbPort
```
public int dbPort
```
    JDBC parameter for the port number on which the database in the host computer accepts user requests.
  - partitions
```
public int partitions
```
    Spark parameter for the number of partitions.
  - spark_logger_level
```
public java.lang.String spark_logger_level
```
    Spark parameter specifying the logging level. Values INFO, WARN, and ERROR are allowed.
- Constructor Detail
  - Configuration
```
public Configuration(java.lang.String path)
```
    Constructor of a Configuration object.
    
    Parameters:
    
    path - Path to a properties file containing all parameters to be used in the transformation.
- Method Detail
  - buildConfiguration
```
private void buildConfiguration()
```
    Loads the configuration from a properties file.
  - initializeParameters
```
private void initializeParameters(java.util.Properties properties)
```
    Initializes all the parameters for the transformation from the configuration file.
    
    Parameters:
    
    properties - All properties as specified in the configuration file.

Class Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

myAssistant

runtime

mode

inputFormat

path

inputFiles

tmpDir

outputDir

batch_size

mappingSpec

classificationSpec

classifyByName

serialization

targetGeoOntology

prefixes

namespaces

ontologyNS

geometryNS

featureNS

featureClassNS

featureClassificationNS

featureSourceNS

defaultLang

featureSource

tableName

filterSQLCondition

spatialExtent

attrKey

attrGeometry

attrName

attrCategory

attrX

attrY

registerFeatures

delimiter

quote

encoding

sourceCRS

targetCRS

dbType

dbName

dbUserName

dbPassword

dbHost

dbPort

partitions

spark_logger_level

Constructor Detail

Configuration

Method Detail

buildConfiguration

initializeParameters