Click or drag to resize

DBConfigurationBase Class

Base class for classes that interact with the database.
Inheritance Hierarchy

Namespace:  Cadcorp.Configuration.Connectors
Assembly:  Cadcorp.Configuration (in Cadcorp.Configuration.dll) Version: 9.0.2618.0 (9.0.2618.0)
Syntax
public class DBConfigurationBase : DbDatabase, 
	IDBConfigReader, IDBConfigWriter, IDBUpdater

The DBConfigurationBase type exposes the following members.

Constructors
  NameDescription
Public methodDBConfigurationBase
Creates new instance of DBConfigurationBase
Top
Properties
  NameDescription
Public propertyConnectionString
Database connection string to use
Public propertyProvider
Database provider.
Top
Methods
  NameDescription
Public methodAddDeleteWMSLayerLookup
Add or delete a wms layer lookup
Public methodAddIcon
Adds a new icon to the site.
Public methodAddNewMap
Adds a new map to the site.
Public methodAddOSOpenNamesSearch
Adds OS Searches to Search_OS_Places tables
Public methodAddOSPlacesSearch
Adds OS Searches to Search_OS_Places tables
Public methodAddProxy
Adds a proxy to the admin database.
Public methodAddResolution
Adds a resolution to the database for specified map.
Public methodAddUpdateAccessConnection
Adds or updates an Access Connection String.
Public methodAddUpdateAdditionalGeognoSIS8Layer
Add an AdditionalGeognoSIS8Layer to the system, or update an existing one.
Public methodAddUpdateAdditionalWMSLayer
Add an additional WMS Layer, or update an existing WMS additional layer.
Public methodAddUpdateBingLayer
Adds a Bing layer to the system, or updates an existing one.
Public methodAddUpdateCRS
Adds or updates a CRS Values in the database.
Public methodAddUpdateGeognoSIS8Layer
Adds a new GeognoSIS 8 layer to the site, or updates an existing layer.
Public methodAddUpdateGeognoSISTileServiceLayer
Add a new GeognoSIS Tile Service Layer to the system. or update an existing one.
Public methodAddUpdateGoogleLayer
Adds a new Google Layer to the system, or updates an existing one.
Public methodAddUpdateLocalKnowledge
Adds a new local knowledge entry to the site, or updates an existsing entry.
Public methodAddUpdateNoticeBoard
Adds a notice board to the system or updates an existing notice board.
Public methodAddUpdateNoticeBoardColumn
Adds a column to a notice board, or updates an existing column.
Public methodAddUpdateNoticeBoardLayer
Adds a layer to a notice, or updates an existing notice.
Public methodAddUpdateNoticeBoardNotice
Adds a notice to a notice board, or updates an existing notice.
Public methodAddUpdateOracleConnection
Adds or updates an Oracle Connection String.
Public methodAddUpdateOSMLayer
Adds a new OSM layer to the system, or updates an existing layer.
Public methodAddUpdatePostGisConnection
Adds or updates an PostGIS Connection String.
Public methodAddUpdateReportIt
Adds or Updates a ReportIt record in the database.
Public methodAddUpdateSingleSearch
Public methodAddUpdateSQLiteConnection
Adds or updates an SQLite Connection String.
Public methodAddUpdateSQLServerConnection
Adds or updates an SQL Server Connection String.
Public methodAddUpdateTemplate
Adds or updates a template within the system.
Public methodAddUpdateTileCacheLayer
Add a tile cache to the system, or update an existing layer.
Public methodAddUpdateWebServiceConnection
Adds or updates an Web Service String.
Public methodAddUpdateWFSLayer
Add a WFS Layer to the system, or update an existing layer.
Public methodAddUpdateWMSFromCapabilitiesLayer
Add a WMS From Capabilities Layer, or update an existing layer.
Public methodAddUpdateWMSFromCapabilitiesUrls
Add URL for WMS From Capabilities Layer, or update exisitng URL
Public methodAddUpdateWMSLayer
Add a WMS Layer, or update an existing WMS additional layer.
Public methodAddUpdateWMSOverlayUrls
Add or delete a wms url
Public methodAddUpdateWMTSLayer
Add a new WMTS layer to the site, or update an existing layer.
Public methodAddUpdateXYZLayer
Add an XYZ layer to the site, or update an existing xyz layer.
Public methodAddWatermark
Method to add watermark to the database.
Public methodCheckAddConnectorInfo
Updates the database with connector information.
Public methodCheckAddCredential
Check or add a credential to the database.
Public methodCheckAddGeognoSISTileServiceLayerLookup
Check to see if a GeognoSISTileServiceLayerLookup value exists, if not, add it.
Public methodCheckAddIn
Check to see if an AddIn exists in the database.
Public methodCheckAddKnownProjection
Check or add a known projection to the database.
Public methodCheckAddLayer
Check to see if a layer exists, if not, add it.
Public methodCheckIfLocalKnowledgeIsInUse
Performs an operation to see if the local knowledge entry is in use by a map.
Protected methodCreateReturnParameter
Adds a return parameter to non query.
(Inherited from DbDatabase.)
Public methodDeleteIcon
Deletes an icon from the site.
Public methodDeleteResolution
Delete a resolution from the database.
Public methodDeleteWatermark
Deletes a watermark from the site.
Public methodDuplicateSearch
Copies a search
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetAdapter (Inherited from DbDatabase.)
Public methodGetAddIns
Gets available add ins.
Public methodGetAddInsForMap
Gets available Add Ins for a specified map.
Public methodGetAllBingOverlayTypes
Returns a list of available bing map overlay types.
Public methodGetAllExtents
Gets all available map extents.
Public methodGetAllGoogleLayerTypes
Gets all available Google Layer Types
Public methodGetAllIcons
Gets all available Icons.
Public methodGetAllImageFormats
Gets all available Image Formats
Public methodGetAllNoticeBoards
Gets array of NoticeBoard data.
Public methodGetAllOSSearchDataByMapName
Returns OS APIs searches configured for a map
Public methodGetAllPhotometricInterpretations
Gets all available Photometric Interpretations
Public methodGetAllProblemTypes
Get Problem Types.
Public methodGetAllProjections
Gets a list of available projections from the database.
Public methodGetAllReportItConfigurations
Gets All ReportIt data.
Public methodGetAllSingleSearchData
Gets all the single search data.
Public methodGetAllSingleSearchDataByMapName
Gets all the single search data.
Public methodGetAllStyleMapNames
Gets the names of all available Style Maps.
Public methodGetAllStyleMaps
Gets all available Style Maps
Public methodGetAllStyles
Gets available styles.
Public methodGetAllStylesByMapNameAndIntent
Gets all styles for a map name and intent.
Public methodGetAllTemplates
Gets available templates.
Public methodGetAllTransitionEffects
Gets all available Transition Effects.
Public methodGetAllUrls
Gets all available URLs as DataTable.
Public methodGetAllWatermarks
Gets available Watermarks.
Public methodGetAppSettings
Gets the app settings for the site.
Public methodGetBookmarks
Gets available bookmarks for requested Map.
Public methodGetConnectionStrings
Get available Connection Strings.
Public methodGetControls
Gets available controls for supplied map name.
Public methodGetCredentialByLayerId
Gets credentials based on layer id, for use with authenticated proxy layers.
Public methodGetCRSValues
Get Array of CRS values.
Protected methodGetDbCommand
Creates a new command object.
(Inherited from DbDatabase.)
Public methodGetDbConnection
Creates a new connection object.
(Inherited from DbDatabase.)
Protected methodGetDbDataAdapter
Creates a new adapter object.
(Inherited from DbDatabase.)
Public methodGetDBParameterString
Returns the correct parameter string for the database platform in use.
(Inherited from DbDatabase.)
Public methodGetDBSearchConfiguration
Get the configuration dataset for a noticeboard database search
Public methodGetDBUppercaseFunction
Returns the correct parameter string for the database platform in use.
(Inherited from DbDatabase.)
Public methodGetDBWildcardString
Returns the correct parameter string for the database platform in use.
(Inherited from DbDatabase.)
Public methodGetDefaultMap
Get Map Settings for default map.
Public methodGetDefaultMapName
Get Name of default map.
Public methodGetDistinctResolutionsNoMap
Gets available distinct resolutions.
Public methodGetDrawingStyles
Gets drawing styles for supplied map name.
Public methodGetEditingStyles
Gets editing styles for supplied map name.
Public methodGetEmbeddableMapConfiguration
Gets the map configuration for an embeddable map.
Public methodGetFrontTemplate
Gets the front template table entries for supplied map name.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHighestGoogleOverlayIndex
Gets the index of the highest Google Overlay
Public methodGetHighestTileCacheOverlayIndex
Gets the highest z index available for Tile Cache Overlays for specified map.
Public methodGetHighestWFSOverlayIndex
Gets the highest z index available for WFS Overlays for specified map.
Public methodGetHighestXYZOverlayIndex
Gets the higest Z index for XYZ Overlays in the specified map
Public methodGetImageFormat
Gets the Image Format name based on the supplied ImageFormatID
Public methodGetImageFormatIDFromName
Gets the Image Format ID from the name provided.
Public methodGetKnownProjections
Gets Known Projections for supplied map name.
Public methodGetLastCreatedRowID
Get Last Created Row ID
Public methodGetLayer
Gets a layer name based on the supplied LayerID.
Public methodGetLayers
Gets layers associated with a WMS.
Public methodGetLocalknowledgeConfiguration
Gets Local Knowledge Configuration DataSet.
Public methodGetLocalknowledgeConfiguration(Int32)
Public methodGetLocalKnowledgeData
Gets Local Knowledge data.
Public methodGetLocalKnowledgeLayerTemplates
Gets layer templates for local knowledge id.
Public methodGetMap
Get Map Settings for requested Map Name
Public methodGetMapDescriptions
Gets map summaries for the requested maps
Public methodGetMapExtent
Gets Map Extent string for specified map.
Public methodGetMapFontSizes
Gets available Map Font Sizes for map name.
Public methodGetMapIcons
Gets map Icons for supplied map name.
Public methodGetMapIDFromMapName
Gets the map ID from the supplied map name.
Public methodGetMaps
Gets available maps.
Public methodGetMeasuringStyles
Gets measuring styles for supplied map name.
Public methodGetNoticeBoardConfiguration
Get the configuration dataset for a noticeboard
Public methodGetOsOpenNameFilterTypes
Returns a list with all available filter types from Search_OS_Open_Name_Filter_Type
Public methodGetOverlayIcons
Get all available overlay icons for requested map.
Public methodGetOverlays
Gets overlays available for specified map.
Public methodGetParameter(String, Object, String)
Returns a new parameter.
(Inherited from DbDatabase.)
Public methodGetParameter(String, Object, String, Boolean) (Inherited from DbDatabase.)
Public methodGetPhotometricInterpretationIDFromName
Gets the Photometric Interpretation ID from the name provided.
Public methodGetPrintTemplatesForMap
Gets print templates for the map.
Public methodGetProblemTypes
Get Problem Types for a specified report ID.
Public methodGetProjectionIDFromName
Gets the Projection ID from the name provided.
Public methodGetProjections
Gets all available Projections.
Public methodGetProjectionsByMapName
Gets all available Projections based on map name.
Public methodGetProxyConfiguration
Gets available Proxy Configurations.
Public methodGetReport
Gets a report for the report name specified.
Public methodGetReportItConfiguration
Gets ReportIt data for the admin system.
Public methodGetResolutions
Gets available resolutions for requested Map.
Public methodGetScales
Gets available scales for requested Map.
Public methodGetSearches
Get available Searches.
Public methodGetSearchesForMap
Public methodGetSearchPermissionsForMap
Gets search permissions for the map.
Public methodGetStyleMapIDFromName
Gets the Style Map ID from the name provided.
Public methodGetStylesByStyleMapID
Gets available styles for requested Style Map ID.
Public methodGetTemplates
Gets DataSet of available Templates.
Public methodGetTransitionEffect
Gets a Transition Effect name based on the supplied TransitionEffectID.
Public methodGetTransitionEffectIDFromName
Gets the transition effect ID from the name provided.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUrlIDFromUrl
Gets the URL ID from a specified URL
Public methodGetWatermark
Gets available Watermarks for requested map.
Public methodGetWatermarkImages
Gets all available Watermarks.
Public methodGetWMSFromCapabilitiesOverlayIndex
Gets the highest z index available for WMS From Capabilities Overlays for specified map.
Public methodGetWMSOverlayIndex
Gets the highest z index available for WMS Overlays for specified map.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveAdditionalWMSLayer
Remove specified Additional WMS Layer from the system.
Public methodRemoveBingLayer
Removes a bing layer from the system.
Public methodRemoveBookmark
Remove a bookmark from the site.
Public methodRemoveCRS
Removes a CRS from the site.
Public methodRemoveDatabaseConnection
Removes a database connection from the database.
Public methodRemoveGeognoSIS8AdditionalLayer
Remove an additional GeognoSIS Layer.
Public methodRemoveGeognoSIS8Layer
Remove a GeognoSIS 8 Layer from the site.
Public methodRemoveGeognoSISTileServiceLayer
Removes a GegnoSIS Tile Service Layer from the system
Public methodRemoveGeognoSISTileServiceLayerLookup
Removes a GeognoSISTileService layer lookup
Public methodRemoveGoogleLayer
Removes a Google Layer from the system/
Public methodRemoveLocalKnowledge
Removes a local knowledge entry from the site.
Public methodRemoveMap
Remove a map from the site.
Public methodRemoveNoticeBoard
Removes a notice board from the system.
Public methodRemoveNoticeBoardColumn
Removes a column from the system.
Public methodRemoveNoticeBoardLayer
Removes a layer from the system.
Public methodRemoveNoticeBoardNotice
Removes a notice from the system.
Public methodRemoveOSMLayer
Remove an OSM layer from the site
Public methodRemoveOSPlaces
Removes a single OSPlaces search from the database.
Public methodRemoveOSSearch
Removes a single OSOpenNames searchc from the database.
Public methodRemoveProxy
Removes a proxy based on supplied ID.
Public methodRemoveReportIt
Removes a ReportIt record from the system.
Public methodRemoveSingleSearch
Removes a single singleSearch from the database.
Public methodRemoveTemplate
Removes a template from the site.
Public methodRemoveTileCacheLayer
Remove specified Tile Cache Layer from the system.
Public methodRemoveWFSLayer
Remove specified WFS Layer from the system.
Public methodRemoveWMSFromCapabilitiesLayer
Remove specified WMS From Capabilties Layer from the system.
Public methodRemoveWMSLayer
Remove specified WMS Layer from the system.
Public methodRemoveWMTSLayer
Remove specified WMTS Layer from the system.
Public methodRemoveXYZLayer
Remove a XYZ Layer from the specified map.
Public methodReplaceResolutions
Replace resolutions for specified map.
Public methodRequiresUpdate
Determines if the current DB requires updating
Protected methodRunProcedure(String, String, IDataParameter, String)
Runs a stored procedure, returning an SqlResultSet containing the result of the stored procedure.
(Inherited from DbDatabase.)
Protected methodRunProcedure(DbConnection, String, IDataParameter, Int32, String)
Runs a stored procedure, returning an integer indicating the return value of the stored procedure. Also returns the value of the RowsAffected aspect of the stored procedure that is returned by the ExecuteNonQuery method.
(Inherited from DbDatabase.)
Protected methodRunProcedure(DbConnection, String, String, IDataParameter, String)
Runs a stored procedure, returning an SqlResultSet containing the result of the stored procedure.
(Inherited from DbDatabase.)
Protected methodRunProcedure(String, String, IDataParameter, Int32, String)
Runs a stored procedure, returning an integer indicating the return value of the stored procedure. Also returns the value of the RowsAffected aspect of the stored procedure that is returned by the ExecuteNonQuery method.
(Inherited from DbDatabase.)
Protected methodRunProcedure(String, String, IDataParameter, String, String)
Runs a stored procedure, returning a DataSet that contains the results of the stored procedure in a named table.
(Inherited from DbDatabase.)
Protected methodRunProcedure(String, String, IDataParameter, String, String)
Runs a stored procedure, returning an ArrayList containing the specified fields from the result of the stored procedure. N.B. This method has been retained for backward compatibility. It is recommended that a strongly typed generic list is used instead of an ArrayList.
(Inherited from DbDatabase.)
Protected methodRunProcedure(DbConnection, String, String, IDataParameter, String, String)
Runs a stored procedure, returning a DataSet that contains the results of the stored procedure in a named table.
(Inherited from DbDatabase.)
Protected methodRunProcedure(DbConnection, String, String, IDataParameter, String, String)
Runs a stored procedure, returning an ArrayList containing the specified fields from the result of the stored procedure. N.B. This method has been retained for backward compatibility. It is recommended that a strongly typed generic list is used instead of an ArrayList.
(Inherited from DbDatabase.)
Protected methodRunProcedure(String, String, IDataParameter, DataSet, String, String)
Takes an existing DataSet and fills the given table name with the results of the stored procedure.
(Inherited from DbDatabase.)
Protected methodRunProcedure(String, String, IDataParameter, Int32, Int32, String)
Returns a populated DataTable from the stored procedure provided.
(Inherited from DbDatabase.)
Protected methodRunProcedure(String, String, IDataParameter, String, String, String)
Runs a stored procedure, returning a DataView that contains the results of the stored procedure in a named table within a DataSet.
(Inherited from DbDatabase.)
Protected methodRunProcedure(DbConnection, String, String, IDataParameter, DataSet, String, String)
Takes an existing DataSet and fills the given table name with the results of the stored procedure.
(Inherited from DbDatabase.)
Protected methodRunProcedure(DbConnection, String, String, IDataParameter, Int32, Int32, String)
Returns a populated DataTable from the stored procedure provided.
(Inherited from DbDatabase.)
Protected methodRunProcedure(DbConnection, String, String, IDataParameter, String, String, String)
Runs a stored procedure, returning a DataView that contains the results of the stored procedure in a named table within a DataSet.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, String)
Runs a query, returning an SqlResultSet containing the result of the query.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, IDataParameter, Int32, String)
Runs a query, returning an integer indicating the return value of the stored procedure. Also returns the value of the RowsAffected aspect of the stored procedure that is returned by the ExecuteNonQuery method.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, String, IDataParameter, String)
Runs a query, returning an SqlResultSet containing the result of the query.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, DataTable, String)
Takes an existing DataTable and fills it with the results of the query.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, Int32, String)
Runs a query, returning an integer indicating the return value of the stored procedure. Also returns the value of the RowsAffected aspect of the stored procedure that is returned by the ExecuteNonQuery method.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, String, String)
Runs a query, returning a DataSet that contains the results of the query in a named table.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, String, String)
Runs a stored procedure, returning an ArrayList containing the specified fields from the result of the query. N.B. This method has been retained for backward compatibility. It is recommended that a strongly typed generic list is used instead of an ArrayList.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, String, IDataParameter, DataTable, String)
Takes an existing DataTable and fills it with the results of the query.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, String, IDataParameter, String, String)
Runs a query, returning a DataSet that contains the results of the query in a named table.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, String, IDataParameter, String, String)
Runs a stored procedure, returning an ArrayList containing the specified fields from the result of the query. N.B. This method has been retained for backward compatibility. It is recommended that a strongly typed generic list is used instead of an ArrayList.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, DataSet, String, String)
Takes an existing DataSet and fills the given table name with the results of the query.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, Int32, Int32, String)
Returns a populated DataTable from the query provided.
(Inherited from DbDatabase.)
Protected methodRunQuery(String, String, IDataParameter, String, String, String)
Runs a query, returning a DataView that contains the results of the query in a named table within a DataSet.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, String, IDataParameter, DataSet, String, String)
Takes an existing DataSet and fills the given table name with the results of the query.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, String, IDataParameter, Int32, Int32, String)
Returns a populated DataTable from the query provided.
(Inherited from DbDatabase.)
Protected methodRunQuery(DbConnection, String, String, IDataParameter, String, String, String)
Runs a query, returning a DataView that contains the results of the query in a named table within a DataSet.
(Inherited from DbDatabase.)
Protected methodRunScalarQuery
Runs a scalar query.
(Inherited from DbDatabase.)
Public methodSetOverlayIndex
Sets the value of OverlayIndex column for a particular layer
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTruncateString (Inherited from DbDatabase.)
Public methodTypeToDbType
Returns a DbType to go along with a parameter.
(Inherited from DbDatabase.)
Public methodUpdate
Updates the database
Public methodUpdateAppSettings
Updates an app setting in the database.
Public methodUpdateBookmark
Update a bookmark in the site.
Public methodUpdateFrontPageContent
Updates the Front Page Content for the specified map.
Public methodUpdateIcon
Update details for icon.
Public methodUpdateInitialLocation
Update Initial Location for specified map.
Public methodUpdateMapSettings
Updates map settings for specified map.
Public methodUpdateMaxExtent
Update the map's maxium extent
Public methodUpdateOSOpenNamesSearch
Updates OS Searches to Search_OS_Places tables
Public methodUpdateOSPlacesSearch
Updates OS Searches to Search_OS_Places tables
Public methodUpdateOverlayTypeStatus
Updates the overlay type status
Public methodUpdateStyle
Update a style.
Public methodUpdateWatermark
Update details for watermark.
Top
Fields
See Also