Search Toolkit Book for IEditsDBEngine

#include <objmgr/edits_db_engine.hpp>

Inheritance diagram for IEditsDBEngine:

Collaboration diagram for IEditsDBEngine:

Public Types
typedef list< CRef< CSeqEdit_Cmd > >	TCommands

typedef map< CSeq_id_Handle, string >	TChangedIds

Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
virtual	~IEditsDBEngine ()

virtual bool	HasBlob (const string &blobid) const =0

virtual bool	FindSeqId (const CSeq_id_Handle &id, string &blobid) const =0

virtual void	NotifyIdChanged (const CSeq_id_Handle &id, const string &newblobid)=0

virtual void	SaveCommand (const CSeqEdit_Cmd &cmd)=0

virtual void	BeginTransaction ()=0

virtual void	CommitTransaction ()=0

virtual void	RollbackTransaction ()=0

virtual void	GetCommands (const string &blobid, TCommands &cmds) const =0

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Additional Inherited Members
Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Detailed Description

Definition at line 48 of file edits_db_engine.hpp.

Member Typedef Documentation

◆ TChangedIds

typedef map<CSeq_id_Handle, string > IEditsDBEngine::TChangedIds

Definition at line 52 of file edits_db_engine.hpp.

◆ TCommands

typedef list<CRef<CSeqEdit_Cmd> > IEditsDBEngine::TCommands

Definition at line 51 of file edits_db_engine.hpp.

Constructor & Destructor Documentation

◆ ~IEditsDBEngine()

IEditsDBEngine::~IEditsDBEngine ( )

virtual

Definition at line 41 of file edits_db_engine.cpp.

Member Function Documentation

◆ BeginTransaction()

virtual void IEditsDBEngine::BeginTransaction ( )

pure virtual

Implemented in CFileDBEngine.

Referenced by CEditsSaver::BeginTransaction().

◆ CommitTransaction()

virtual void IEditsDBEngine::CommitTransaction ( )

pure virtual

Implemented in CFileDBEngine.

Referenced by CEditsSaver::CommitTransaction().

◆ FindSeqId()

virtual bool IEditsDBEngine::FindSeqId	(	const CSeq_id_Handle &	id,
		string &	blobid
	)		const

pure virtual

Implemented in CFileDBEngine.

Referenced by CDataLoaderPatcher::GetBlobId(), CDataLoaderPatcher::GetDetailedRecords(), and CDataLoaderPatcher::GetRecords().

◆ GetCommands()

virtual void IEditsDBEngine::GetCommands	(	const string &	blobid,
		TCommands &	cmds
	)		const

pure virtual

Implemented in CFileDBEngine.

Referenced by CDataLoaderPatcher::x_ApplyPatches().

◆ HasBlob()

virtual bool IEditsDBEngine::HasBlob ( const string & blobid ) const

pure virtual

Implemented in CFileDBEngine.

Referenced by CDataLoaderPatcher::x_IsPatchNeeded().

◆ NotifyIdChanged()

virtual void IEditsDBEngine::NotifyIdChanged	(	const CSeq_id_Handle &	id,
		const string &	newblobid
	)

pure virtual

Implemented in CFileDBEngine.

Referenced by CEditsSaver::AddId(), CEditsSaver::Attach(), CEditsSaver::Detach(), CEditsSaver::Remove(), CEditsSaver::RemoveId(), and CEditsSaver::ResetIds().

◆ RollbackTransaction()

virtual void IEditsDBEngine::RollbackTransaction ( )

pure virtual

Implemented in CFileDBEngine.

Referenced by CEditsSaver::RollbackTransaction().

◆ SaveCommand()

virtual void IEditsDBEngine::SaveCommand ( const CSeqEdit_Cmd & cmd )

pure virtual

Implemented in CFileDBEngine.

Referenced by CEditsSaver::AddId(), CEditsSaver::Attach(), CEditsSaver::Detach(), CEditsSaver::Remove(), CEditsSaver::RemoveId(), CEditsSaver::Replace(), CEditsSaver::ResetIds(), s_AddAnnot(), s_AddDesc(), s_AddDescr(), s_RemoveAnnot(), s_RemoveDesc(), s_ResetDescr(), s_ResetSeqAttr(), s_ResetSetAttr(), and s_SetDescr().

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

include/objmgr/edits_db_engine.hpp
src/objmgr/edits_db_engine.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TChangedIds

◆ TCommands

Constructor & Destructor Documentation

◆ ~IEditsDBEngine()

Member Function Documentation

◆ BeginTransaction()

◆ CommitTransaction()

◆ FindSeqId()

◆ GetCommands()

◆ HasBlob()

◆ NotifyIdChanged()

◆ RollbackTransaction()

◆ SaveCommand()