import_export::QueryExporter Class Reference

#include <QueryExporter.h>

Inheritance diagram for import_export::QueryExporter:

Public Types
enum	FileType {   FileType::kCSV, FileType::kGeoJSON, FileType::kGeoJSONL, FileType::kShapefile,   FileType::kFlatGeobuf }
enum	FileCompression { FileCompression::kNone, FileCompression::kGZip, FileCompression::kZip }
enum	ArrayNullHandling { ArrayNullHandling::kAbortWithWarning, ArrayNullHandling::kExportSentinels, ArrayNullHandling::kExportZeros, ArrayNullHandling::kNullEntireField }

Public Member Functions
	QueryExporter (const FileType file_type)
	QueryExporter ()=delete
virtual	~QueryExporter ()
virtual void	beginExport (const std::string &file_path, const std::string &layer_name, const CopyParams &copy_params, const std::vector< TargetMetaInfo > &column_info, const FileCompression file_compression, const ArrayNullHandling array_null_handling)=0
virtual void	exportResults (const std::vector< AggregatedResult > &query_results)=0
virtual void	endExport ()=0

Static Public Member Functions
static std::unique_ptr < QueryExporter >	create (const FileType file_type)

Protected Member Functions
void	validateFileExtensions (const std::string &file_path, const std::string &file_type, const std::unordered_set< std::string > &valid_extensions) const
std::string	safeColumnName (const std::string &resname, const int column_index)

Protected Attributes
const FileType	file_type_

Detailed Description

Definition at line 27 of file QueryExporter.h.

Member Enumeration Documentation

enum import_export::QueryExporter::ArrayNullHandling

strong

Enumerator
kAbortWithWarning
kExportSentinels
kExportZeros
kNullEntireField

Definition at line 31 of file QueryExporter.h.

                               {
    kAbortWithWarning,
    kExportSentinels,
    kExportZeros,
    kNullEntireField
  };

enum import_export::QueryExporter::FileCompression

strong

Enumerator
kNone
kGZip
kZip

Definition at line 30 of file QueryExporter.h.

{ kNone, kGZip, kZip };

enum import_export::QueryExporter::FileType

strong

Enumerator
kCSV
kGeoJSON
kGeoJSONL
kShapefile
kFlatGeobuf

Definition at line 29 of file QueryExporter.h.

{ kCSV, kGeoJSON, kGeoJSONL, kShapefile, kFlatGeobuf };

Constructor & Destructor Documentation

import_export::QueryExporter::QueryExporter ( const FileType  file_type )

explicit

Definition at line 27 of file QueryExporter.cpp.

: file_type_{file_type} {}

import_export::QueryExporter::QueryExporter ( )

delete

virtual import_export::QueryExporter::~QueryExporter ( )

inlinevirtual

Definition at line 40 of file QueryExporter.h.

{}

Member Function Documentation

virtual void import_export::QueryExporter::beginExport ( const std::string &  file_path, const std::string &  layer_name, const CopyParams &  copy_params, const std::vector< TargetMetaInfo > &  column_info, const FileCompression  file_compression, const ArrayNullHandling  array_null_handling  )

pure virtual

Implemented in import_export::QueryExporterCSV.

std::unique_ptr< QueryExporter > import_export::QueryExporter::create ( const FileType  file_type )

static

Definition at line 29 of file QueryExporter.cpp.

References CHECK, kCSV, kFlatGeobuf, kGeoJSON, kGeoJSONL, and kShapefile.

Referenced by Parser::ExportQueryStmt::execute().

                                                                     {
  switch (file_type) {
    case FileType::kCSV:
      return std::make_unique<QueryExporterCSV>();
    case FileType::kGeoJSON:
    case FileType::kGeoJSONL:
    case FileType::kShapefile:
    case FileType::kFlatGeobuf:
      return std::make_unique<QueryExporterGDAL>(file_type);
  }
  CHECK(false);
  return nullptr;
}

Here is the caller graph for this function:

virtual void import_export::QueryExporter::endExport ( )

pure virtual

Implemented in import_export::QueryExporterGDAL, and import_export::QueryExporterCSV.

virtual void import_export::QueryExporter::exportResults ( const std::vector< AggregatedResult > &  query_results )

pure virtual

Implemented in import_export::QueryExporterGDAL, and import_export::QueryExporterCSV.

std::string import_export::QueryExporter::safeColumnName ( const std::string &  resname, const int  column_index  )

protected

Definition at line 55 of file QueryExporter.cpp.

References to_string().

Referenced by import_export::QueryExporterCSV::beginExport(), import_export::QueryExporterGDAL::beginExport(), and import_export::QueryExporterGDAL::exportResults().

                                                                  {
  if (resname.size() == 0) {
    return "result_" + std::to_string(column_index);
  }
  return resname;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void import_export::QueryExporter::validateFileExtensions ( const std::string &  file_path, const std::string &  file_type, const std::unordered_set< std::string > &  valid_extensions  ) const

protected

Definition at line 43 of file QueryExporter.cpp.

Referenced by import_export::QueryExporterCSV::beginExport(), and import_export::QueryExporterGDAL::beginExport().

                                                               {
  auto extension = boost::algorithm::to_lower_copy(
      boost::filesystem::path(file_path).extension().string());
  if (valid_extensions.find(extension) == valid_extensions.end()) {
    throw std::runtime_error("Invalid file extension '" + extension +
                             "' for file type '" + file_type + "'");
  }
}

Here is the caller graph for this function:

Member Data Documentation

const FileType import_export::QueryExporter::file_type_

protected

Definition at line 54 of file QueryExporter.h.

Referenced by import_export::QueryExporterGDAL::beginExport().

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/ImportExport/QueryExporter.h
• /home/jenkins-slave/workspace/core-os-doxygen/ImportExport/QueryExporter.cpp