gdb_catalog.h

Go to the documentation of this file.

#ifndef SDK_GDB_CATALOG_INTERFACE_H_
#define SDK_GDB_CATALOG_INTERFACE_H_
#pragma once
 
#include <base/inc/sdk_any_handler.h>
#include <base/inc/interfaces/resource/generic_resource_interface.h>
#include <datalayer/inc/geodatabase/gdb_const.h>
#include <datalayer/inc/geodatabase/gdb_dataset.h>
#include <geometry/inc/geometry/geometry.h>
 
SDK_GDB_BEGIN_NAMESPACE
 
// Classes declared in other files
class IQueryParameters;
class IEnumDatasetID;
 
// Classes declared in this file
FWD_DECL_INTERFACE(IRootCatalogFactory);
FWD_DECL_INTERFACE(ICatalog);
FWD_DECL_INTERFACE(ICatalogEdit);
FWD_DECL_INTERFACE(IRootCatalog);
FWD_DECL_INTERFACE(IDatasetCatalog);
FWD_DECL_INTERFACE(IDatasetCoverageCatalog);
FWD_DECL_INTERFACE(IEnumCatalogEntry);
FWD_DECL_INTERFACE(ICatalogEntry);
FWD_DECL_INTERFACE(IRootCatalogEdit);
FWD_DECL_INTERFACE(IChartCatalogUtil);
 
#define kCatalogFactoryCID "CatalogFactoryCID"
 
typedef SDKUInt32 CatalogPropertyID;
typedef SDKAny    CatalogEntryKey;
typedef SDKUInt32 CatalogEntryPropertyID;
 
typedef enum CatalogEntryType {
  kCatEntryType_Any                        = kDT_Any,
  kCatEntryType_FeatureDataset             = kDT_FeatureDataset, 
  kCatEntryType_UpdateHistory              = kDT_UpdateHistory,  
  kCatEntryType_FeatureCatalog             = kDT_FeatureCatalog, 
  kCatEntryType_Portrayal                  = kDT_Portrayal,      
  kCatEntryType_Coverage                   = kDT_Coverage,       
  kCatEntryType_SpatialIndex               = kDT_SpatialIndex,   
  kCatEntryType_Raster                     = kDT_Raster,         
  kCatEntryType_XML                        = kDT_XML,            
  kCatEntryType_XSLT                       = kDT_XSLT,           
  kCatEntryType_Text                       = kDT_Text,           
  kCatEntryType_HTML                       = kDT_HTML,           
  kCatEntryType_Multimedia                 = kDT_Multimedia,     
  kCatEntryType_RootCatalog                = kDT_RootCatalog,    
  kCatEntryType_DatasetCatalog             = kDT_DatasetCatalog, 
  kCatEntryType_DatasetCatalogSpatialIndex = kDT_DatasetCatalogSpatialIndex, 
  kCatEntryType_CoverageCatalog            = kDT_CoverageCatalog,
  kCatEntryType_CRS                        = kDT_CRS,            
  kCatEntryType_S63Permit                  = kDT_S63Permit,      
  kCatEntryType_DataProducerCodesCatalog   = kDT_DataProducerCodesCatalog, 
  kCatEntryType_Rules                      = kDT_Rules,          
  kCatEntryType_IndexDataset               = kDT_IndexDataset,   
  kCatEntryType_BLOB                       = 100,
} CatalogEntryType;
 
typedef enum CatalogType {
  kCatType_Any             = 0, 
  kCatType_RootCatalog     = kCatEntryType_RootCatalog, 
  kCatType_DatasetCatalog  = kCatEntryType_DatasetCatalog, 
  kCatType_CoverageCatalog = kCatEntryType_CoverageCatalog, 
  kCatType_DataProducerCodesCatalog = kCatEntryType_DataProducerCodesCatalog, 
} CatalogType;
 
typedef enum CatalogProperty {
  kCatProperty_FileName = 0,
  kCatProperty_FilePath,
  kCatProperty_SpatialIndex_Name,
  kCatProperty_PermitCollection,
  kCatProperty_SpatialIndex,
  kCatProperty_WorkspaceID,
  kCatProperty_TempPath,
} CatalogProperty;
 
typedef enum CatalogFlag {
  kCatFlag_NoFlags      = 0x00,
  kCatFlag_IsEncrypted  = 0x01,
  kCatFlag_IsCompressed = 0x02,
  kCatFlag_CollectExternalFilesFromRootPath = 0x04,
} CatalogFlag;
 
typedef enum RootCatalogEntryProperty {
  kRootCatEntryProperty_PRSP = 0, 
  kRootCatEntryProperty_CRC = kRootCatEntryProperty_PRSP, 
  kRootCatEntryProperty_VolumeType, 
  kRootCatEntryProperty_VolumeName, 
  kRootCatEntryProperty_FileName, 
  kRootCatEntryProperty_FileOffset, 
  kRootCatEntryProperty_FileSize, 
  kRootCatEntryProperty_Flags, 
  kRootCatEntryProperty_DID, 
  kRootCatEntryProperty_FileType, 
} RootCatalogEntryProperty;
 
typedef enum RootCatalogGeodatabaseProperty {
  kRootCatGeodatabaseProperty_GeodatabaseName = 0, 
  kRootCatGeodatabaseProperty_CompilationTime, 
  kRootCatGeodatabaseProperty_Encryption, 
  kRootCatGeodatabaseProperty_NavStick, 
  kRootCatGeodatabaseProperty_ENCIssueDate, 
  kRootCatGeodatabaseProperty_SencVersion, 
  kRootCatGeodatabaseProperty_ValidThrough = 0x80, 
  kRootCatGeodatabaseProperty_SencDescription = 0x81, 
} RootCatalogGeodatabaseProperty;
 
typedef enum DatasetCatalogEntryProperty {
  kDSCatEntryProperty_First = 0,
 
  kDSCatEntryProperty_PRSP = kDSCatEntryProperty_First,
  kDSCatEntryProperty_VolumeType = kRootCatEntryProperty_VolumeType,
  kDSCatEntryProperty_VolumeName = kRootCatEntryProperty_VolumeName,
  kDSCatEntryProperty_FileName = kRootCatEntryProperty_FileName,
  kDSCatEntryProperty_FileOffset = kRootCatEntryProperty_FileOffset,
  kDSCatEntryProperty_FileSize = kRootCatEntryProperty_FileSize,
  kDSCatEntryProperty_Flags = kRootCatEntryProperty_Flags,
  kDSCatEntryProperty_DID = kRootCatEntryProperty_DID,
  kDSCatEntryProperty_EditionNumber,
  kDSCatEntryProperty_UpdateNumber,
  kDSCatEntryProperty_ProducingAgency,
  kDSCatEntryProperty_Scale_Min,
  kDSCatEntryProperty_Scale_Max,
  kDSCatEntryProperty_CompilationScale,
  kDSCatEntryProperty_Bounds_SWLat,
  kDSCatEntryProperty_Bounds_SWLon,
  kDSCatEntryProperty_Bounds_NELat,
  kDSCatEntryProperty_Bounds_NELon,
  kDSCatEntryProperty_CoverageType,
  kDSCatEntryProperty_Encryption,
  kDSCatEntryProperty_Layering,
  kDSCatEntryProperty_IssueDate,
  kDSCatEntryProperty_UpdateApplicationDate,
  kDSCatEntryProperty_IntendedUsage,
  kDSCatEntryProperty_Terminated,
  kDSCatEntryProperty_OfficialStatus,
  kDSCatEntryProperty_WorkspaceID,
  kDSCatEntryProperty_ConversionDate,
  kDSCatEntryProperty_DataserverID,
  kDSCatEntryProperty_DatasetOverlayType,
  kDSCatEntryProperty_DatasetProfile,
  kDSCatEntryProperty_DatasetSpecificUsage,
  kDSCatEntryProperty_ProductSpecificationDescription,
  kDSCatEntryProperty_NewEditionAvailable,
  kDSCatEntryProperty_Volatile,
 
  kDSCatEntryProperty_Last = kDSCatEntryProperty_Volatile,
} DatasetCatalogEntryProperty;
 
struct DatasetCatalogDatasetHeaderPropertyCrossTable {
  DatasetCatalogEntryProperty catalog_property;
  DatasetProperty dataset_property;
};
static const DatasetCatalogDatasetHeaderPropertyCrossTable 
  kDatasetCatalogDatasetHeaderPropertyCrossTable[] = {
    { kDSCatEntryProperty_PRSP,                   kDSP_PRSP },
    { kDSCatEntryProperty_EditionNumber,          kDSP_EditionNumber },
    { kDSCatEntryProperty_UpdateNumber,           kDSP_UpdateNumber },
    { kDSCatEntryProperty_ProducingAgency,        kDSP_ProducingAgency },
    { kDSCatEntryProperty_Scale_Min,              kDSP_MinDispScale },       
    { kDSCatEntryProperty_Scale_Max,              kDSP_MaxDispScale },
    { kDSCatEntryProperty_CompilationScale,       kDSP_CompilationScale },
    { kDSCatEntryProperty_Bounds_SWLat,           kDSP_DS_SW_LAT },
    { kDSCatEntryProperty_Bounds_SWLon,           kDSP_DS_SW_LON },
    { kDSCatEntryProperty_Bounds_NELat,           kDSP_DS_NE_LAT },
    { kDSCatEntryProperty_Bounds_NELon,           kDSP_DS_NE_LON },
    { kDSCatEntryProperty_Encryption,             kDSP_Encryption },
    { kDSCatEntryProperty_Layering,               kDSP_Layering   },
    { kDSCatEntryProperty_IssueDate,              kDSP_IssueDate  },
    { kDSCatEntryProperty_UpdateApplicationDate,  kDSP_UpdateApplicationDate },
    { kDSCatEntryProperty_IntendedUsage,          kDSP_IntendedUsage },
    { kDSCatEntryProperty_Terminated,             kDSP_Terminated },
    { kDSCatEntryProperty_OfficialStatus,         kDSP_OfficialStatus },
    { kDSCatEntryProperty_ConversionDate,         kDSP_ConversionDate },
    { kDSCatEntryProperty_DataserverID,           kDSP_DataserverID },
    { kDSCatEntryProperty_DatasetOverlayType,     kDSP_DatasetOverlayType },
    { kDSCatEntryProperty_DatasetProfile,         kDSP_Profile },
    { kDSCatEntryProperty_DatasetSpecificUsage,   kDSP_SpecificUsage},
    { kDSCatEntryProperty_ProductSpecificationDescription, kDSP_ProductSpecificationDescription },
    { kDSCatEntryProperty_NewEditionAvailable,    kDSP_NewEditionAvailable },
    { kDSCatEntryProperty_Volatile,               kDSP_Volatile },
    { kDSCatEntryProperty_Flags,                  kDSP_Flags },
};
 
typedef enum CoverageCatalogEntryProperty {
  kCoverageCatEntryProperty_FileName = 0,
  kCoverageCatEntryProperty_Geometry,
} CoverageCatalogEntryProperty;
 
typedef enum DatasetCoverageType {
  kDSCovType_Normal = 0,
  kDSCovType_Empty,
  kDSCovType_Infinite,
  kDSCovType_Max,
} DatasetCoverageType;
 
typedef enum VolumeType {
  kVolumeType_NoVolume = 0, 
  kVolumeType_BLOB, 
  kVolumeType_DB3,  
  kVolumeType_S01,  
  kVolumeType_Max, 
} VolumeType;
 
typedef enum DataProducerCodesCatalogEntryProperty {
  kDataProducerCodesCatalogEntry_AgencyName = 0,
  kDataProducerCodesCatalogEntry_AgencyCode,
  kDataProducerCodesCatalogEntry_AgencyID,
  kDataProducerCodesCatalogEntry_CountryCode,
  kDataProducerCodesCatalogEntry_CountryName,
  kDataProducerCodesCatalogEntry_Official,
} DataProducerCodesCatalogEntryProperty;
 
class IRootCatalogFactory : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE Open(
    const SDKString& file_name,
    IRootCatalog** catalog) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE Create(
    IRootCatalog** catalog) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE OpenFromResourceStorage(
    sdk::base::ISDKResourceStorage* resource_storage,
    IRootCatalog** catalog) noexcept = 0;
 
  SDK_IMPLEMENT_IID(IRootCatalogFactory)
  SDK_END_INTERFACE(IRootCatalogFactory)
};
SDK_DECLARE_IID(IRootCatalogFactory)
 
class ICatalog : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE GetCatalogEntries(
    CatalogEntryType type,
    IEnumCatalogEntry** entries) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetCatalogEntry(
    const CatalogEntryKey* entry_key, 
    ICatalogEntry** entry) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetCatalogProperty(
    CatalogPropertyID id,
    SDKAny* property) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetCatalogEntryCount(
    SDKUInt32& count) const throw() = 0;
 
  template< typename T >
  GDBResult GetCatalogPropertyT(CatalogPropertyID id, T& out) const throw() {
    sdk::ScopedAny value;
    GDBResult res = GetCatalogProperty(id, &value);
    if (SDK_FAILED(res))
      return res;
    if (ANY_IS_EMPTY(&value))
      return sdk::Err_NotExist;
    return value.GetAs< T >(out) ? sdk::Ok : sdk::Err_InvalidArg;
  }
  
  SDK_IMPLEMENT_IID(ICatalog)
  SDK_END_INTERFACE(ICatalog)
};
SDK_DECLARE_IID(ICatalog)
 
class ICatalogEdit : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE StartEditing() throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE StopEditing(
    bool save_edits,
    sdk::base::ISDKResource* resource) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE IsBeingEdited() const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE CreateCatalogEntry(
    ICatalogEntry** entry) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE AddCatalogEntry(
    const CatalogEntryKey* entry_key,
    ICatalogEntry* entry) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE DeleteEntry(
    const CatalogEntryKey* entry_key) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE SetCatalogProperty(
    CatalogPropertyID id,
    const SDKAny* value) throw() = 0;
 
  SDK_IMPLEMENT_IID(ICatalogEdit)
  SDK_END_INTERFACE(ICatalogEdit)
};
SDK_DECLARE_IID(ICatalogEdit)
 
class IRootCatalog : public ICatalog {
public:
  virtual GDBResult SDK_CALLTYPE GetCatalog(
    CatalogType type,
    ICatalog** catalog) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE CreateCatalog(
    CatalogType type, 
    ICatalogEdit** catalog) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetGeodatabaseProperty(
    RootCatalogGeodatabaseProperty property_id, 
    SDKAny& property_value) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetResourceStorage(
    base::ISDKResourceStorage** resource_storage) const throw() = 0;
 
  template< typename T >
  GDBResult GetGeodatabasePropertyT(RootCatalogGeodatabaseProperty id, 
    T& out) throw() {
    sdk::ScopedAny value;
    GDBResult res = GetGeodatabaseProperty(id, value);
    if (SDK_FAILED(res))
      return res;
    if (ANY_IS_EMPTY(&value))
      return sdk::Err_NotExist;
    return value.GetAs< T >(out) ? sdk::Ok : sdk::Err_InvalidArg;
  }
  
  SDK_IMPLEMENT_IID(IRootCatalog)
  SDK_END_INTERFACE(IRootCatalog)
};
SDK_DECLARE_IID(IRootCatalog)
 
class IRootCatalogEdit : public ICatalogEdit {
public:
  virtual GDBResult SDK_CALLTYPE SetGeodatabaseProperty(
    RootCatalogGeodatabaseProperty property_id, 
    const SDKAny& property_value) throw() = 0;
  
  SDK_IMPLEMENT_IID(IRootCatalogEdit)
  SDK_END_INTERFACE(IRootCatalogEdit)
};  
SDK_DECLARE_IID(IRootCatalogEdit)
 
class IDatasetCatalog : public ICatalog {
public:
  virtual GDBResult SDK_CALLTYPE GetDatasetIDs(
    const geometry::IGeometry* geometric_filter,
    const IQueryParameters* parameter_filter,
    IEnumDatasetID** datasets_ids) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetDatasetName(const DatasetID& did, 
    SDKString& dataset_name) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetDatasetID(const SDKString& dataset_name,
    DatasetID& did) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IDatasetCatalog)
  SDK_END_INTERFACE(IDatasetCatalog)
};
SDK_DECLARE_IID(IDatasetCatalog)
 
class IDatasetCoverageCatalog : public ICatalog {
public:
  virtual GDBResult SDK_CALLTYPE GetDatasetCoverage(
    const CatalogEntryKey* entry_key, 
    geometry::IGeometry** coverage) throw() = 0;
 
  SDK_IMPLEMENT_IID(IDatasetCoverageCatalog)
  SDK_END_INTERFACE(IDatasetCoverageCatalog)
};
SDK_DECLARE_IID(IDatasetCoverageCatalog)
 
class ICatalogEntry : public ISDKComponent {
public:
  virtual GDBResult SDK_CALLTYPE GetProperty(
    CatalogEntryPropertyID id,
    SDKAny& value) const throw() = 0;
 
  // \brief Sets the value of the specified Property.
  virtual GDBResult SDK_CALLTYPE SetProperty(
    CatalogEntryPropertyID id,
    const SDKAny& value) throw() = 0;
 
  template< typename T >
  GDBResult GetPropertyT(CatalogEntryPropertyID id, T& out) const throw() {
    sdk::ScopedAny value;
    GDBResult res = GetProperty(id, value);
    if (SDK_FAILED(res))
      return res;
    if (ANY_IS_EMPTY(&value))
      return sdk::Err_NotExist;
    return value.GetAs< T >(out) ? sdk::Ok : sdk::Err_InvalidArg;
  }
 
  SDK_IMPLEMENT_IID(ICatalogEntry)
  SDK_END_INTERFACE(ICatalogEntry)
};
SDK_DECLARE_IID(ICatalogEntry)
 
class IEnumCatalogEntry : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE Next(
    ICatalogEntry** entry) const throw() = 0;
  virtual GDBResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(IEnumCatalogEntry)
  SDK_END_INTERFACE(IEnumCatalogEntry)
};
SDK_DECLARE_IID(IEnumCatalogEntry)
 
class IChartCatalogUtil : public IGDBObject {
public:
  virtual SDKResult SDK_CALLTYPE GetFilterByGeometry(
      IWorkspace* wks,
      SDK_GEOMETRY_NAMESPACE::IGeometry* geometry_filter,
      IQueryParameters** filter) throw() = 0;
 
  SDK_IMPLEMENT_IID(IChartCatalogUtil)
  SDK_END_INTERFACE(IChartCatalogUtil)
};
SDK_DECLARE_IID(IChartCatalogUtil)
 
SDK_GDB_END_NAMESPACE
 
#endif // SDK_GDB_CATALOG_INTERFACE_H_