#include <qgsofflineediting.h>

Classes
struct	AttributeValueChange
struct	GeometryChange
Public Types
enum	ProgressMode { CopyFeatures = 0, ProcessFeatures, AddFields, AddFeatures, RemoveFeatures, UpdateFeatures, UpdateGeometries }
Signals
void	layerProgressUpdated (int layer, int numLayers)
	emit a signal that the next layer of numLayers has started processing
void	progressModeSet (QgsOfflineEditing::ProgressMode mode, int maximum)
	emit a signal that sets the mode for the progress of the current operation
void	progressStarted ()
	emit a signal that processing has started
void	progressStopped ()
	emit a signal that processing of all layers has finished
void	progressUpdated (int progress)
	emit a signal with the progress of the current mode
Public Member Functions
	QgsOfflineEditing ()
	~QgsOfflineEditing ()
bool	convertToOfflineProject (const QString &offlineDataPath, const QString &offlineDbFile, const QStringList &layerIds)
	convert current project for offline editing
bool	isOfflineProject ()
	return true if current project is offline
void	synchronize ()
	synchronize to remote layers
Private Types
typedef QList < AttributeValueChange >	AttributeValueChanges
typedef QList< GeometryChange >	GeometryChanges
Private Slots
void	committedAttributesAdded (const QString &qgisLayerId, const QList< QgsField > &addedAttributes)
void	committedAttributeValuesChanges (const QString &qgisLayerId, const QgsChangedAttributesMap &changedAttrsMap)
void	committedFeaturesAdded (const QString &qgisLayerId, const QgsFeatureList &addedFeatures)
void	committedFeaturesRemoved (const QString &qgisLayerId, const QgsFeatureIds &deletedFeatureIds)
void	committedGeometriesChanges (const QString &qgisLayerId, const QgsGeometryMap &changedGeometries)
void	layerAdded (QgsMapLayer *layer)
Private Member Functions
void	addFidLookup (sqlite3 *db, int layerId, QgsFeatureId offlineFid, QgsFeatureId remoteFid)
void	applyAttributesAdded (QgsVectorLayer remoteLayer, sqlite3 db, int layerId, int commitNo)
void	applyAttributeValueChanges (QgsVectorLayer offlineLayer, QgsVectorLayer remoteLayer, sqlite3 *db, int layerId, int commitNo)
void	applyFeaturesAdded (QgsVectorLayer offlineLayer, QgsVectorLayer remoteLayer, sqlite3 *db, int layerId)
void	applyFeaturesRemoved (QgsVectorLayer remoteLayer, sqlite3 db, int layerId)
void	applyGeometryChanges (QgsVectorLayer remoteLayer, sqlite3 db, int layerId, int commitNo)
QMap< int, int >	attributeLookup (QgsVectorLayer offlineLayer, QgsVectorLayer remoteLayer)
void	copySymbology (const QgsVectorLayer sourceLayer, QgsVectorLayer targetLayer)
void	copyVectorLayer (QgsVectorLayer layer, sqlite3 db, const QString &offlineDbPath)
void	createLoggingTables (sqlite3 *db)
bool	createSpatialiteDB (const QString &offlineDbPath)
int	getCommitNo (sqlite3 *db)
int	getOrCreateLayerId (sqlite3 *db, const QString &qgisLayerId)
void	increaseCommitNo (sqlite3 *db)
void	initializeSpatialMetadata (sqlite3 *sqlite_handle)
bool	isAddedFeature (sqlite3 *db, int layerId, QgsFeatureId fid)
QgsFeatureId	offlineFid (sqlite3 *db, int layerId, QgsFeatureId remoteFid)
sqlite3 *	openLoggingDb ()
QgsFeatureId	remoteFid (sqlite3 *db, int layerId, QgsFeatureId offlineFid)
void	showWarning (const QString &message)
int	sqlExec (sqlite3 *db, const QString &sql)
QList< QgsField >	sqlQueryAttributesAdded (sqlite3 *db, const QString &sql)
AttributeValueChanges	sqlQueryAttributeValueChanges (sqlite3 *db, const QString &sql)
QgsFeatureIds	sqlQueryFeaturesRemoved (sqlite3 *db, const QString &sql)
GeometryChanges	sqlQueryGeometryChanges (sqlite3 *db, const QString &sql)
int	sqlQueryInt (sqlite3 *db, const QString &sql, int defaultValue)
QList< int >	sqlQueryInts (sqlite3 *db, const QString &sql)
void	updateFidLookup (QgsVectorLayer remoteLayer, sqlite3 db, int layerId)

Detailed Description

Definition at line 32 of file qgsofflineediting.h.

Member Typedef Documentation

typedef QList<AttributeValueChange> QgsOfflineEditing::AttributeValueChanges [private]

Definition at line 127 of file qgsofflineediting.h.

typedef QList<GeometryChange> QgsOfflineEditing::GeometryChanges [private]

Definition at line 135 of file qgsofflineediting.h.

Member Enumeration Documentation

enum QgsOfflineEditing::ProgressMode

Enumerator:

CopyFeatures
ProcessFeatures
AddFields
AddFeatures
RemoveFeatures
UpdateFeatures
UpdateGeometries

Definition at line 37 of file qgsofflineediting.h.

Constructor & Destructor Documentation

QgsOfflineEditing::QgsOfflineEditing ( )

Definition at line 51 of file qgsofflineediting.cpp.

References QgsMapLayerRegistry::instance(), and layerAdded().

QgsOfflineEditing::~QgsOfflineEditing ( )

Definition at line 56 of file qgsofflineediting.cpp.

Member Function Documentation

void QgsOfflineEditing::addFidLookup	(	sqlite3 *	db,
		int	layerId,
		QgsFeatureId	offlineFid,
		QgsFeatureId	remoteFid
	)		`[private]`

Definition at line 844 of file qgsofflineediting.cpp.

References sqlExec().

Referenced by copyVectorLayer(), and updateFidLookup().

void QgsOfflineEditing::applyAttributesAdded	(	QgsVectorLayer *	remoteLayer,
		sqlite3 *	db,
		int	layerId,
		int	commitNo
	)		`[private]`

Definition at line 574 of file qgsofflineediting.cpp.

References QgsVectorLayer::addAttribute(), AddFields, QgsVectorLayer::dataProvider(), QgsVectorDataProvider::NativeType::mType, QgsVectorDataProvider::NativeType::mTypeName, QgsField::name(), QgsVectorDataProvider::nativeTypes(), progressModeSet(), progressUpdated(), QgsField::setTypeName(), showWarning(), sqlQueryAttributesAdded(), and QgsField::type().

Referenced by synchronize().

void QgsOfflineEditing::applyAttributeValueChanges	(	QgsVectorLayer *	offlineLayer,
		QgsVectorLayer *	remoteLayer,
		sqlite3 *	db,
		int	layerId,
		int	commitNo
	)		`[private]`

Definition at line 670 of file qgsofflineediting.cpp.

References attributeLookup(), QgsVectorLayer::changeAttributeValue(), progressModeSet(), progressUpdated(), remoteFid(), sqlQueryAttributeValueChanges(), and UpdateFeatures.

Referenced by synchronize().

void QgsOfflineEditing::applyFeaturesAdded	(	QgsVectorLayer *	offlineLayer,
		QgsVectorLayer *	remoteLayer,
		sqlite3 *	db,
		int	layerId
	)		`[private]`

Definition at line 611 of file qgsofflineediting.cpp.

References QgsVectorLayer::addFeature(), AddFeatures, attributeLookup(), QgsFeature::attributes(), QgsFields::count(), QgsVectorLayer::getFeatures(), QgsFeatureIterator::nextFeature(), QgsVectorLayer::pendingFields(), progressModeSet(), progressUpdated(), QgsFeature::setAttributes(), and sqlQueryInts().

Referenced by synchronize().

void QgsOfflineEditing::applyFeaturesRemoved	(	QgsVectorLayer *	remoteLayer,
		sqlite3 *	db,
		int	layerId
	)		`[private]`

Definition at line 653 of file qgsofflineediting.cpp.

References QgsVectorLayer::deleteFeature(), progressModeSet(), progressUpdated(), remoteFid(), RemoveFeatures, and sqlQueryFeaturesRemoved().

Referenced by synchronize().

void QgsOfflineEditing::applyGeometryChanges	(	QgsVectorLayer *	remoteLayer,
		sqlite3 *	db,
		int	layerId,
		int	commitNo
	)		`[private]`

Definition at line 689 of file qgsofflineediting.cpp.

References QgsVectorLayer::changeGeometry(), QgsGeometry::fromWkt(), progressModeSet(), progressUpdated(), remoteFid(), sqlQueryGeometryChanges(), and UpdateGeometries.

Referenced by synchronize().

QMap< int, int > QgsOfflineEditing::attributeLookup	(	QgsVectorLayer *	offlineLayer,
		QgsVectorLayer *	remoteLayer
	)		`[private]`

Definition at line 770 of file qgsofflineediting.cpp.

References QgsVectorLayer::pendingAllAttributesList().

Referenced by applyAttributeValueChanges(), and applyFeaturesAdded().

void QgsOfflineEditing::committedAttributesAdded	(	const QString &	qgisLayerId,
		const QList< QgsField > &	addedAttributes
	)		`[private, slot]`

Definition at line 1046 of file qgsofflineediting.cpp.

References QgsField::comment(), getCommitNo(), getOrCreateLayerId(), increaseCommitNo(), QgsField::length(), QgsField::name(), openLoggingDb(), QgsField::precision(), sqlExec(), and QgsField::type().

Referenced by layerAdded().

void QgsOfflineEditing::committedAttributeValuesChanges	(	const QString &	qgisLayerId,
		const QgsChangedAttributesMap &	changedAttrsMap
	)		`[private, slot]`

Definition at line 1136 of file qgsofflineediting.cpp.

References getCommitNo(), getOrCreateLayerId(), increaseCommitNo(), isAddedFeature(), openLoggingDb(), and sqlExec().

Referenced by layerAdded().

void QgsOfflineEditing::committedFeaturesAdded	(	const QString &	qgisLayerId,
		const QgsFeatureList &	addedFeatures
	)		`[private, slot]`

Definition at line 1076 of file qgsofflineediting.cpp.

References getOrCreateLayerId(), QgsMapLayerRegistry::instance(), QgsMapLayerRegistry::mapLayer(), openLoggingDb(), QgsMapLayer::source(), sqlExec(), sqlQueryInts(), and QgsDataSourceURI::table().

Referenced by layerAdded().

void QgsOfflineEditing::committedFeaturesRemoved	(	const QString &	qgisLayerId,
		const QgsFeatureIds &	deletedFeatureIds
	)		`[private, slot]`

Definition at line 1105 of file qgsofflineediting.cpp.

References getOrCreateLayerId(), isAddedFeature(), openLoggingDb(), and sqlExec().

Referenced by layerAdded().

void QgsOfflineEditing::committedGeometriesChanges	(	const QString &	qgisLayerId,
		const QgsGeometryMap &	changedGeometries
	)		`[private, slot]`

Definition at line 1173 of file qgsofflineediting.cpp.

References QgsGeometry::exportToWkt(), getCommitNo(), getOrCreateLayerId(), increaseCommitNo(), isAddedFeature(), openLoggingDb(), and sqlExec().

Referenced by layerAdded().

bool QgsOfflineEditing::convertToOfflineProject	(	const QString &	offlineDataPath,
		const QString &	offlineDbFile,
		const QStringList &	layerIds
	)

convert current project for offline editing

convert current project to offline project returns offline project file path

Parameters:

offlineDataPath	path to offline db file
offlineDbFile	offline db file name
layerIds	list of layer names to convert

Definition at line 64 of file qgsofflineediting.cpp.

References copyVectorLayer(), createLoggingTables(), createSpatialiteDB(), QgsMapLayerRegistry::instance(), QgsProject::instance(), layerProgressUpdated(), QgsMapLayerRegistry::mapLayer(), progressStarted(), progressStopped(), PROJECT_ENTRY_KEY_OFFLINE_DB_PATH, PROJECT_ENTRY_SCOPE_OFFLINE, showWarning(), QgsProject::title(), tr, and QgsProject::writeEntry().

void QgsOfflineEditing::copySymbology	(	const QgsVectorLayer *	sourceLayer,
		QgsVectorLayer *	targetLayer
	)		`[private]`

Definition at line 751 of file qgsofflineediting.cpp.

References QgsVectorLayer::readSymbology(), showWarning(), and QgsVectorLayer::writeSymbology().

Referenced by copyVectorLayer(), and synchronize().

void QgsOfflineEditing::copyVectorLayer	(	QgsVectorLayer *	layer,
		sqlite3 *	db,
		const QString &	offlineDbPath
	)		`[private]`

Definition at line 388 of file qgsofflineediting.cpp.

Referenced by convertToOfflineProject().

void QgsOfflineEditing::createLoggingTables ( sqlite3 * db ) [private]

Definition at line 342 of file qgsofflineediting.cpp.

References sqlExec().

Referenced by convertToOfflineProject().

bool QgsOfflineEditing::createSpatialiteDB ( const QString & offlineDbPath ) [private]

Definition at line 293 of file qgsofflineediting.cpp.

References initializeSpatialMetadata(), showWarning(), and tr.

Referenced by convertToOfflineProject().

int QgsOfflineEditing::getCommitNo ( sqlite3 * db ) [private]

Definition at line 832 of file qgsofflineediting.cpp.

References sqlQueryInt().

Referenced by committedAttributesAdded(), committedAttributeValuesChanges(), committedGeometriesChanges(), increaseCommitNo(), and synchronize().

int QgsOfflineEditing::getOrCreateLayerId	(	sqlite3 *	db,
		const QString &	qgisLayerId
	)		`[private]`

Definition at line 807 of file qgsofflineediting.cpp.

References sqlExec(), and sqlQueryInt().

Referenced by committedAttributesAdded(), committedAttributeValuesChanges(), committedFeaturesAdded(), committedFeaturesRemoved(), committedGeometriesChanges(), and copyVectorLayer().

void QgsOfflineEditing::increaseCommitNo ( sqlite3 * db ) [private]

Definition at line 838 of file qgsofflineediting.cpp.

References getCommitNo(), and sqlExec().

Referenced by committedAttributesAdded(), committedAttributeValuesChanges(), and committedGeometriesChanges().

void QgsOfflineEditing::initializeSpatialMetadata ( sqlite3 * sqlite_handle ) [private]

Definition at line 248 of file qgsofflineediting.cpp.

References showWarning(), and tr.

Referenced by createSpatialiteDB().

bool QgsOfflineEditing::isAddedFeature	(	sqlite3 *	db,
		int	layerId,
		QgsFeatureId	fid
	)		`[private]`

Definition at line 862 of file qgsofflineediting.cpp.

References sqlQueryInt().

Referenced by committedAttributeValuesChanges(), committedFeaturesRemoved(), and committedGeometriesChanges().

bool QgsOfflineEditing::isOfflineProject ( )

return true if current project is offline

Definition at line 129 of file qgsofflineediting.cpp.

References QgsProject::instance(), PROJECT_ENTRY_KEY_OFFLINE_DB_PATH, PROJECT_ENTRY_SCOPE_OFFLINE, and QgsProject::readEntry().

void QgsOfflineEditing::layerAdded ( QgsMapLayer * layer ) [private, slot]

Definition at line 1027 of file qgsofflineediting.cpp.

References committedAttributesAdded(), committedAttributeValuesChanges(), committedFeaturesAdded(), committedFeaturesRemoved(), committedGeometriesChanges(), CUSTOM_PROPERTY_IS_OFFLINE_EDITABLE, and QgsMapLayer::customProperty().

Referenced by QgsOfflineEditing().

void QgsOfflineEditing::layerProgressUpdated	(	int	layer,
		int	numLayers
	)		`[signal]`

emit a signal that the next layer of numLayers has started processing

Parameters:

layer	current layer index
numLayers	total number of layers

Referenced by convertToOfflineProject(), and synchronize().

QgsFeatureId QgsOfflineEditing::offlineFid	(	sqlite3 *	db,
		int	layerId,
		QgsFeatureId	remoteFid
	)		`[private]`

Definition at line 856 of file qgsofflineediting.cpp.

References sqlQueryInt().

Referenced by updateFidLookup().

sqlite3 * QgsOfflineEditing::openLoggingDb ( ) [private]

Definition at line 790 of file qgsofflineediting.cpp.

References QgsProject::instance(), PROJECT_ENTRY_KEY_OFFLINE_DB_PATH, PROJECT_ENTRY_SCOPE_OFFLINE, QgsProject::readEntry(), showWarning(), and tr.

Referenced by committedAttributesAdded(), committedAttributeValuesChanges(), committedFeaturesAdded(), committedFeaturesRemoved(), committedGeometriesChanges(), and synchronize().

void QgsOfflineEditing::progressModeSet	(	QgsOfflineEditing::ProgressMode	mode,
		int	maximum
	)		`[signal]`

emit a signal that sets the mode for the progress of the current operation

Parameters:

mode	progress mode
maximum	total number of entities to process in the current operation

Referenced by applyAttributesAdded(), applyAttributeValueChanges(), applyFeaturesAdded(), applyFeaturesRemoved(), applyGeometryChanges(), copyVectorLayer(), and updateFidLookup().

void QgsOfflineEditing::progressStarted ( ) [signal]

emit a signal that processing has started

Referenced by convertToOfflineProject(), and synchronize().

void QgsOfflineEditing::progressStopped ( ) [signal]

emit a signal that processing of all layers has finished

Referenced by convertToOfflineProject(), and synchronize().

void QgsOfflineEditing::progressUpdated ( int progress ) [signal]

emit a signal with the progress of the current mode

Parameters:

progress current index of processed entities

Referenced by applyAttributesAdded(), applyAttributeValueChanges(), applyFeaturesAdded(), applyFeaturesRemoved(), applyGeometryChanges(), copyVectorLayer(), and updateFidLookup().

QgsFeatureId QgsOfflineEditing::remoteFid	(	sqlite3 *	db,
		int	layerId,
		QgsFeatureId	offlineFid
	)		`[private]`

Definition at line 850 of file qgsofflineediting.cpp.

References sqlQueryInt().

Referenced by applyAttributeValueChanges(), applyFeaturesRemoved(), and applyGeometryChanges().

void QgsOfflineEditing::showWarning ( const QString & message ) [private]

Definition at line 785 of file qgsofflineediting.cpp.

References tr.

Referenced by applyAttributesAdded(), convertToOfflineProject(), copySymbology(), copyVectorLayer(), createSpatialiteDB(), initializeSpatialMetadata(), openLoggingDb(), sqlExec(), sqlQueryAttributesAdded(), sqlQueryAttributeValueChanges(), sqlQueryFeaturesRemoved(), sqlQueryGeometryChanges(), sqlQueryInt(), sqlQueryInts(), and synchronize().

int QgsOfflineEditing::sqlExec	(	sqlite3 *	db,
		const QString &	sql
	)		`[private]`

Definition at line 868 of file qgsofflineediting.cpp.

References showWarning().

Referenced by addFidLookup(), committedAttributesAdded(), committedAttributeValuesChanges(), committedFeaturesAdded(), committedFeaturesRemoved(), committedGeometriesChanges(), copyVectorLayer(), createLoggingTables(), getOrCreateLayerId(), increaseCommitNo(), synchronize(), and updateFidLookup().

QList< QgsField > QgsOfflineEditing::sqlQueryAttributesAdded	(	sqlite3 *	db,
		const QString &	sql
	)		`[private]`

Definition at line 922 of file qgsofflineediting.cpp.

References showWarning().

Referenced by applyAttributesAdded().

QgsOfflineEditing::AttributeValueChanges QgsOfflineEditing::sqlQueryAttributeValueChanges	(	sqlite3 *	db,
		const QString &	sql
	)		`[private]`

Definition at line 974 of file qgsofflineediting.cpp.

References QgsOfflineEditing::AttributeValueChange::attr, QgsOfflineEditing::AttributeValueChange::fid, showWarning(), and QgsOfflineEditing::AttributeValueChange::value.

Referenced by applyAttributeValueChanges().

QgsFeatureIds QgsOfflineEditing::sqlQueryFeaturesRemoved	(	sqlite3 *	db,
		const QString &	sql
	)		`[private]`

Definition at line 951 of file qgsofflineediting.cpp.

References showWarning().

Referenced by applyFeaturesRemoved().

QgsOfflineEditing::GeometryChanges QgsOfflineEditing::sqlQueryGeometryChanges	(	sqlite3 *	db,
		const QString &	sql
	)		`[private]`

Definition at line 1001 of file qgsofflineediting.cpp.

References QgsOfflineEditing::GeometryChange::fid, QgsOfflineEditing::GeometryChange::geom_wkt, and showWarning().

Referenced by applyGeometryChanges().

int QgsOfflineEditing::sqlQueryInt	(	sqlite3 *	db,
		const QString &	sql,
		int	defaultValue
	)		`[private]`

Definition at line 879 of file qgsofflineediting.cpp.

References showWarning().

Referenced by getCommitNo(), getOrCreateLayerId(), isAddedFeature(), offlineFid(), remoteFid(), and synchronize().

QList< int > QgsOfflineEditing::sqlQueryInts	(	sqlite3 *	db,
		const QString &	sql
	)		`[private]`

Definition at line 899 of file qgsofflineediting.cpp.

References showWarning().

Referenced by applyFeaturesAdded(), committedFeaturesAdded(), and updateFidLookup().

void QgsOfflineEditing::synchronize ( )

synchronize to remote layers

Definition at line 134 of file qgsofflineediting.cpp.

References QgsMapLayerRegistry::addMapLayers(), applyAttributesAdded(), applyAttributeValueChanges(), applyFeaturesAdded(), applyFeaturesRemoved(), applyGeometryChanges(), QgsVectorLayer::commitChanges(), QgsVectorLayer::commitErrors(), copySymbology(), CUSTOM_PROPERTY_IS_OFFLINE_EDITABLE, CUSTOM_PROPERTY_REMOTE_PROVIDER, CUSTOM_PROPERTY_REMOTE_SOURCE, QgsMapLayer::customProperty(), getCommitNo(), QgsMapLayer::id(), QgsMapLayerRegistry::instance(), QgsProject::instance(), QgsMapLayer::isValid(), layerProgressUpdated(), QgsMapLayerRegistry::mapLayers(), QgsMapLayer::name(), openLoggingDb(), progressStarted(), progressStopped(), PROJECT_ENTRY_KEY_OFFLINE_DB_PATH, PROJECT_ENTRY_SCOPE_OFFLINE, QgsVectorLayer::reload(), QgsProject::removeEntry(), QgsMapLayerRegistry::removeMapLayers(), showWarning(), sqlExec(), sqlQueryInt(), QgsVectorLayer::startEditing(), QgsProject::title(), and updateFidLookup().

void QgsOfflineEditing::updateFidLookup	(	QgsVectorLayer *	remoteLayer,
		sqlite3 *	db,
		int	layerId
	)		`[private]`

Definition at line 705 of file qgsofflineediting.cpp.

References addFidLookup(), QgsVectorLayer::featureCount(), QgsVectorLayer::getFeatures(), QgsFeature::id(), QgsFeatureIterator::nextFeature(), QgsFeatureRequest::NoGeometry, offlineFid(), ProcessFeatures, progressModeSet(), progressUpdated(), sqlExec(), and sqlQueryInts().

Referenced by synchronize().

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

src/core/qgsofflineediting.h
src/core/qgsofflineediting.cpp

Classes

Public Types

Signals

Public Member Functions

Private Types

Private Slots

Private Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation