KDE PIM / Developers / API Docs / kitchensync

KSync::SyncEntry Class Reference

An entry of a dataset which is to be synced. More...

#include <syncentry.h>

Inherited by KSync::AddressBookSyncEntry, KSync::BookmarkSyncEntry, KSync::CalendarSyncEntry, KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry.

List of all members.

Public Types

Public Member Functions

Protected Member Functions


Detailed Description

An entry of a dataset which is to be synced.

Author:
Cornelius Schumacher
See also:
Syncee, Syncer
The SyncEntry class represents the basic unit of syncing. It provides an interface for identifying and comparing entries, which has to be implemented by concrete subclasses. This makes it possible to operate with one synchronisation algorithm on different Syncees.

SyncEntry objects are collected by a

See also:
Syncee objects.


Constructor & Destructor Documentation

SyncEntry::SyncEntry Syncee parent  ) 
 

This is the basic constructor of a SyncEntry.

Every SyncEntry should have a parent Syncee where it belongs to.


Member Function Documentation

QString SyncEntry::type  )  const
 

Return a string describing the type of the entry.

Reimplemented in KSync::OpieDesktopSyncEntry.

virtual QString KSync::SyncEntry::name  )  [pure virtual]
 

Return a string describing this entry.

This is presented to the user as identifier for the entry, when user interaction is required.

Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry.

virtual QString KSync::SyncEntry::id  )  [pure virtual]
 

Return a unique id.

This is used to uniquely identify the entry. Two entries having the same id are considered to be two variants of the same entry. No two entries of the same

See also:
KSyncee data set must have the same id.

Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry.

void SyncEntry::setId const QString &  id  )  [virtual]
 

Set the ID of the underlying data.

This is needed for example if the UID is not trusted and could come from a device.

virtual QString KSync::SyncEntry::timestamp  )  [pure virtual]
 

Return a time stamp representing the time of the last change.

This is only used to compare, if an entry has changed or not. It is not used to define an order of changes. If an entry has been copied from one KSyncee data set to another KSyncee data set, the timestamp has to be the same on both entries. If the user has changed the entry in one data set the timestamp has to be different.

Return QString::null, if there is no timestamp available. This means that the user has to manually select which entry is the new one.

Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry.

virtual bool KSync::SyncEntry::equals SyncEntry  )  [pure virtual]
 

Return, if the two entries are equal.

Two entries are considered to be equal, if they contain exactly the same information, including the same id and timestamp.

Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry.

int SyncEntry::match SyncEntry entry  )  [virtual]
 

For future versions match should try to match one SyncEntry with another.

Parameters:
entry The entry to be matched
Returns:
Return -1 if entry is from a different type than this entry or the percentage of equality. Or -2 if not implemented

int SyncEntry::compareTo SyncEntry entry  )  [virtual]
 

Compares one SyncEntry to another.

This functions differs from equals and match in some ways. it returns 0 if both are equal, -1 if not equal at all, or the state of equalnes Equal or EqualModifiedThis, EqualModifiedOther, EqualModifiedBoth -2 if not implemented

int SyncEntry::state  )  const [virtual]
 

The status of this SyncEntry either Undefined, Added, Modified or Removed.

bool SyncEntry::wasAdded  )  const [virtual]
 

Convience functions for the state of an Entry.

bool SyncEntry::wasModified  )  const [virtual]
 

Convience function for the state of an Entry modified.

bool SyncEntry::wasRemoved  )  const [virtual]
 

Convience function for the state of an Entry.

void SyncEntry::setState int  state = Undefined  )  [virtual]
 

Sets the stae of this SyncEntry.

virtual SyncEntry* KSync::SyncEntry::clone  )  [pure virtual]
 

Creates an exact copy of the this SyncEntry deleting the original is save and does not influence the clone.

Syncee will be unset and SyncStates will be copied over as well.

Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry.

void SyncEntry::setSyncee Syncee  ) 
 

Set the.

See also:
Syncee data set, the entry belongs to.

Syncee * SyncEntry::syncee  )  const
 

Return the.

See also:
Syncee data set, the entry belongs to.

void SyncEntry::setDontSync bool   ) 
 

Set if the entry should be synced or not.

KPIM::DiffAlgo * SyncEntry::diffAlgo SyncEntry ,
SyncEntry
[virtual]
 

Returns the diffing algorithm which is used to present the differences between the two SyncEntries when a conflict occurs.


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