AbstractBDTopoWorkflow (Groovy Documentation)

org.orbisgis.geoclimate.bdtopo.AbstractBDTopoWorkflow

```
abstract class AbstractBDTopoWorkflow
extends BDTopoUtils
```
Abstract class that contains all methods to run the GeoClimate workflow on formated data

Constructor Summary

Constructors
Constructor and description
`AbstractBDTopoWorkflow()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`abstractModelTableBatchExportTable(java.lang.Object output_datasource, java.lang.Object output_table, java.lang.Object id_zone, java.lang.Object h2gis_datasource, java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)` Generic method to save the abstract model tables prepared in H2GIS to another database
	`java.lang.Object`	`bdTopoProcessingSingleArea(java.lang.Object h2gis_datasource, java.lang.Object id_zone, java.lang.Object subCommuneTableName, java.lang.Object srid, java.lang.Object processing_parameters)` This process is used to compute the indicators on a single geometry
	`java.lang.Object`	`bdtopo_processing(java.lang.Object location, H2GIS h2gis_datasource, java.lang.Object processing_parameters, java.lang.Object outputFolder, java.lang.Object outputFiles, java.lang.Object output_datasource, java.lang.Object outputTableNames, java.lang.Object outputSRID, java.lang.Object inputSRID, java.lang.Object deleteOutputData)` Utility method to run commmune by commune the geoclimate chain and save the result in a folder or/and in a database
	`java.lang.Object`	`checkAndFormatLocations(java.lang.Object locations)` Sanity check for the location value
	`java.lang.Object`	`computeGridIndicators(H2GIS h2gis_datasource, java.lang.Object id_zone, java.lang.Object srid, java.lang.Object processing_parameters, java.lang.Object results)` Compute the grid indicators outside the workflow to be sure that the grid domain is continuous e.g if the input are is defined by a multipolygon (a location with islands)
	`java.lang.Object`	`createMainFolder(java.lang.Object outputFolder, java.lang.Object location)` This method is used to create a main folder for each location.
	`java.lang.Object`	`deleteH2GISDb(java.lang.Object delete, java.sql.Connection connection, java.lang.Object dbFolder, java.lang.Object dbName)` Method to delete the local H2GIS database used by the workflow
	`java.util.Map`	`execute(java.lang.Object input)` Run the workflow
	`java.lang.Object`	`extractProcessingParameters(java.lang.Object processing_parameters)` Read the file parameters and create a new map of parameters The map of parameters is initialized with default values
	`abstract java.lang.Object`	`filterLinkedShapeFiles(java.lang.Object location, float distance, java.util.LinkedHashMap inputTables, int sourceSRID, int inputSRID, H2GIS h2gis_datasource)` Method to filter the table loaded from shapefiles
	`abstract java.util.Map`	`formatLayers(JdbcDataSource datasource, java.util.Map layers, float distance, float hLevMin)` Implement it to format the layers
	`abstract java.util.List`	`getInputTables()`
	`java.util.List`	`getOutputTables()`
	`abstract int`	`getVersion()` Returns: the version of the BDTopo database
	`java.lang.Object`	`indicatorTableBatchExportTable(java.lang.Object output_datasource, java.lang.Object output_table, java.lang.Object id_zone, java.lang.Object h2gis_datasource, java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)` Generic method to save the indicator tables prepared in H2GIS to another database
	`java.lang.Object`	`linkDataFromFolder(java.lang.Object inputFolder, java.lang.Object inputWorkflowTableNames, H2GIS h2gis_datasource, java.lang.Object inputSRID)` Load shapefiles into the local H2GIS database
	`abstract java.lang.Integer`	`loadDataFromPostGIS(java.lang.Object input_database_properties, java.lang.Object code, java.lang.Object distance, java.lang.Object inputTables, java.lang.Object inputSRID, H2GIS h2gis_datasource)` Load the required tables stored in a database
	`java.lang.Object`	`mergeResultTables(java.lang.Object tablesToMerge, H2GIS h2gis_datasource)` Method to merge a list of tables e.g : all building tables computed by zone are merged in one building table
	`java.lang.Object`	`prepareTableOutput(java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object h2gis_datasource, java.lang.Object output_table, java.lang.Object outputSRID, java.lang.Object output_datasource)` Method to prepare a ITable aka resulset to export table in a database
	`java.lang.Object`	`saveOutputFiles(java.lang.Object h2gis_datasource, java.lang.Object results, java.lang.Object outputFiles, java.lang.Object outputFolder, java.lang.Object outputSRID, java.lang.Object reproject, java.lang.Object deleteOutputData, java.lang.Object outputGrid)` Save the geoclimate tables into geojson files
	`java.lang.Object`	`saveResults(java.lang.Object h2gis_datasource, java.lang.Object id_zone, java.lang.Object results, java.lang.Object srid, java.lang.Object outputFolder, java.lang.Object outputFiles, java.lang.Object output_datasource, java.lang.Object outputTableNames, java.lang.Object outputSRID, java.lang.Object deleteOutputData, java.lang.Object outputGrid)` Method to store the results in a folder or a database
	`java.lang.Object`	`saveTablesInDatabase(java.lang.Object output_datasource, java.lang.Object h2gis_datasource, java.lang.Object outputTableNames, java.lang.Object h2gis_tables, java.lang.Object id_zone, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)` Save the output tables in a database

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class BDTopoUtils`	`bbox, bbox, bbox`

- Constructor Detail
  - AbstractBDTopoWorkflow()
- Method Detail
  - java.lang.Object abstractModelTableBatchExportTable(java.lang.Object output_datasource, java.lang.Object output_table, java.lang.Object id_zone, java.lang.Object h2gis_datasource, java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)
    
    Generic method to save the abstract model tables prepared in H2GIS to another database @return
    Parameters:
    output_datasource - connexion to a database
    output_table - name of the output table
    srid - srid to reproject
    h2gis_datasource - local H2GIS database
    h2gis_table_to_save - name of the H2GIS table to save
    batchSize - size of the batch
    filter - to limit the data from H2GIS *
    outputSRID - srid code used to reproject the output table
  - java.lang.Object bdTopoProcessingSingleArea(java.lang.Object h2gis_datasource, java.lang.Object id_zone, java.lang.Object subCommuneTableName, java.lang.Object srid, java.lang.Object processing_parameters)
    
    This process is used to compute the indicators on a single geometry @return
    Parameters:
    h2gis_datasource
    id_zone
    subCommuneTableName
    srid
    processing_parameters
  - java.lang.Object bdtopo_processing(java.lang.Object location, H2GIS h2gis_datasource, java.lang.Object processing_parameters, java.lang.Object outputFolder, java.lang.Object outputFiles, java.lang.Object output_datasource, java.lang.Object outputTableNames, java.lang.Object outputSRID, java.lang.Object inputSRID, java.lang.Object deleteOutputData)
    
    Utility method to run commmune by commune the geoclimate chain and save the result in a folder or/and in a database @return
    Parameters:
    h2gis_datasource - the local H2GIS database
    processing_parameters - the geoclimate chain parameters
    outputFolder - folder to store the files, null otherwise
    outputFiles - the name of the tables that will be saved
    output_datasource - a connexion to a database to save the results
    outputTableNames - the name of the tables in the output_datasource to save the results
    outputSRID - force the srid for the output data
    inputSRID - force the srid for the input data
    deleteOutputData - true to delete the output files if exist
  - java.lang.Object checkAndFormatLocations(java.lang.Object locations)
    
    Sanity check for the location value @return
    Parameters:
    id_zones
  - java.lang.Object computeGridIndicators(H2GIS h2gis_datasource, java.lang.Object id_zone, java.lang.Object srid, java.lang.Object processing_parameters, java.lang.Object results)
    
    Compute the grid indicators outside the workflow to be sure that the grid domain is continuous e.g if the input are is defined by a multipolygon (a location with islands) @return
    Parameters:
    h2gis_datasource
    id_zone
    processing_parameters
    results
  - java.lang.Object createMainFolder(java.lang.Object outputFolder, java.lang.Object location)
    
    This method is used to create a main folder for each location. This folder is used to store all results and can contain subfolders. We delete it if it already exists @return
    Parameters:
    outputFolder
    location
  - java.lang.Object deleteH2GISDb(java.lang.Object delete, java.sql.Connection connection, java.lang.Object dbFolder, java.lang.Object dbName)
    
    Method to delete the local H2GIS database used by the workflow @return
    Parameters:
    delete
    h2GIS
  - java.util.Map execute(java.lang.Object input)
    
    Run the workflow @return
    Parameters:
    input
  - java.lang.Object extractProcessingParameters(java.lang.Object processing_parameters)
    
    Read the file parameters and create a new map of parameters The map of parameters is initialized with default values
    Parameters:
    processing_parameters - the file parameters
    Returns:
    a filled map of parameters
  - abstract java.lang.Object filterLinkedShapeFiles(java.lang.Object location, float distance, java.util.LinkedHashMap inputTables, int sourceSRID, int inputSRID, H2GIS h2gis_datasource)
    
    Method to filter the table loaded from shapefiles @return
    Parameters:
    location
    distance
    inputTables
    sourceSRID
    inputSRID
    h2gis_datasource
  - abstract java.util.Map formatLayers(JdbcDataSource datasource, java.util.Map layers, float distance, float hLevMin)
    
    Implement it to format the layers @return
    Parameters:
    datasource
    layers
    distance
    hLevMin
  - abstract java.util.List getInputTables()
  - java.util.List getOutputTables()
  - abstract int getVersion()
    
    Returns:
    the version of the BDTopo database
  - java.lang.Object indicatorTableBatchExportTable(java.lang.Object output_datasource, java.lang.Object output_table, java.lang.Object id_zone, java.lang.Object h2gis_datasource, java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)
    
    Generic method to save the indicator tables prepared in H2GIS to another database @return
    Parameters:
    output_datasource - connexion to a database
    output_table - name of the output table
    id_zone - id of the zone
    h2gis_datasource - local H2GIS database
    h2gis_table_to_save - name of the H2GIS table to save
    filter - to limit the data from H2GIS *
    inputSRID - srid code of the inputable
    outputSRID - srid code used to reproject the output table
  - java.lang.Object linkDataFromFolder(java.lang.Object inputFolder, java.lang.Object inputWorkflowTableNames, H2GIS h2gis_datasource, java.lang.Object inputSRID)
    
    Load shapefiles into the local H2GIS database
    Parameters:
    locations - the locations to process
    inputFolder - where the files are
    h2gis_datasource - the local database for the geoclimate processes
    inputSRID - a list of SRID set the geometries
    Returns:
    a list of id_zones
  - abstract java.lang.Integer loadDataFromPostGIS(java.lang.Object input_database_properties, java.lang.Object code, java.lang.Object distance, java.lang.Object inputTables, java.lang.Object inputSRID, H2GIS h2gis_datasource)
    
    Load the required tables stored in a database
    Parameters:
    inputDatasource - database where the tables are
    Returns:
    true is succeed, false otherwise
  - java.lang.Object mergeResultTables(java.lang.Object tablesToMerge, H2GIS h2gis_datasource)
    
    Method to merge a list of tables e.g : all building tables computed by zone are merged in one building table @return
    Parameters:
    tablesToMerge
    h2gis_datasource
  - java.lang.Object prepareTableOutput(java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object h2gis_datasource, java.lang.Object output_table, java.lang.Object outputSRID, java.lang.Object output_datasource)
    
    Method to prepare a ITable aka resulset to export table in a database @return
    Parameters:
    h2gis_table_to_save
    inputSRID
    h2gis_datasource
    output_table
    outputSRID
    output_datasource
  - java.lang.Object saveOutputFiles(java.lang.Object h2gis_datasource, java.lang.Object results, java.lang.Object outputFiles, java.lang.Object outputFolder, java.lang.Object outputSRID, java.lang.Object reproject, java.lang.Object deleteOutputData, java.lang.Object outputGrid)
    
    Save the geoclimate tables into geojson files @return
    Parameters:
    id_zone - the id of the zone
    results - a list of tables computed by geoclimate
    outputFolder - the output folder
    outputSRID - srid code to reproject the result
    deleteOutputData - true to delete the file if exists
  - java.lang.Object saveResults(java.lang.Object h2gis_datasource, java.lang.Object id_zone, java.lang.Object results, java.lang.Object srid, java.lang.Object outputFolder, java.lang.Object outputFiles, java.lang.Object output_datasource, java.lang.Object outputTableNames, java.lang.Object outputSRID, java.lang.Object deleteOutputData, java.lang.Object outputGrid)
    
    Method to store the results in a folder or a database @return
    Parameters:
    h2gis_datasource
    id_zone
    srid
    outputFolder
    outputFiles
    output_datasource
    outputTableNames
    outputSRID
    deleteOutputData
  - java.lang.Object saveTablesInDatabase(java.lang.Object output_datasource, java.lang.Object h2gis_datasource, java.lang.Object outputTableNames, java.lang.Object h2gis_tables, java.lang.Object id_zone, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)
    
    Save the output tables in a database @return
    Parameters:
    output_datasource - a connexion a database
    h2gis_datasource - local H2GIS database
    outputTableNames - name of the output tables
    h2gis_tables - name of H2GIS to save
    id_zone - id of the zone

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractBDTopoWorkflow

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

AbstractBDTopoWorkflow()

Method Detail

java.lang.Object bdTopoProcessingSingleArea(java.lang.Object h2gis_datasource, java.lang.Object id_zone, java.lang.Object subCommuneTableName, java.lang.Object srid, java.lang.Object processing_parameters)

java.lang.Object checkAndFormatLocations(java.lang.Object locations)

java.lang.Object computeGridIndicators(H2GIS h2gis_datasource, java.lang.Object id_zone, java.lang.Object srid, java.lang.Object processing_parameters, java.lang.Object results)

java.lang.Object createMainFolder(java.lang.Object outputFolder, java.lang.Object location)

java.lang.Object deleteH2GISDb(java.lang.Object delete, java.sql.Connection connection, java.lang.Object dbFolder, java.lang.Object dbName)

java.util.Map execute(java.lang.Object input)

java.lang.Object extractProcessingParameters(java.lang.Object processing_parameters)

abstract java.lang.Object filterLinkedShapeFiles(java.lang.Object location, float distance, java.util.LinkedHashMap inputTables, int sourceSRID, int inputSRID, H2GIS h2gis_datasource)

abstract java.util.Map formatLayers(JdbcDataSource datasource, java.util.Map layers, float distance, float hLevMin)

abstract java.util.List getInputTables()

java.util.List getOutputTables()

abstract int getVersion()

java.lang.Object linkDataFromFolder(java.lang.Object inputFolder, java.lang.Object inputWorkflowTableNames, H2GIS h2gis_datasource, java.lang.Object inputSRID)

abstract java.lang.Integer loadDataFromPostGIS(java.lang.Object input_database_properties, java.lang.Object code, java.lang.Object distance, java.lang.Object inputTables, java.lang.Object inputSRID, H2GIS h2gis_datasource)

java.lang.Object mergeResultTables(java.lang.Object tablesToMerge, H2GIS h2gis_datasource)

java.lang.Object prepareTableOutput(java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object h2gis_datasource, java.lang.Object output_table, java.lang.Object outputSRID, java.lang.Object output_datasource)

java.lang.Object saveOutputFiles(java.lang.Object h2gis_datasource, java.lang.Object results, java.lang.Object outputFiles, java.lang.Object outputFolder, java.lang.Object outputSRID, java.lang.Object reproject, java.lang.Object deleteOutputData, java.lang.Object outputGrid)

java.lang.Object saveTablesInDatabase(java.lang.Object output_datasource, java.lang.Object h2gis_datasource, java.lang.Object outputTableNames, java.lang.Object h2gis_tables, java.lang.Object id_zone, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)