Akregator::Backend::Storage Class Reference

#include <storage.h>

Inheritance diagram for Akregator::Backend::Storage:

Public Member Functions
virtual void	initialize (const TQStringList &params)=0
virtual bool	open (bool autoCommit=false)=0
virtual bool	commit ()=0
virtual bool	rollback ()=0
virtual bool	close ()=0
virtual FeedStorage *	archiveFor (const TQString &url)=0
virtual bool	autoCommit () const =0
virtual int	unreadFor (const TQString &url)=0
virtual void	setUnreadFor (const TQString &url, int unread)=0
virtual int	totalCountFor (const TQString &url)=0
virtual void	setTotalCountFor (const TQString &url, int total)=0
virtual int	lastFetchFor (const TQString &url)=0
virtual void	setLastFetchFor (const TQString &url, int lastFetch)=0
virtual void	storeFeedList (const TQString &opmlStr)=0
virtual TQString	restoreFeedList () const =0
virtual void	storeTagSet (const TQString &xmlStr)=0
virtual TQString	restoreTagSet () const =0
virtual TQStringList	feeds () const =0
virtual void	add (Storage *source)=0
virtual void	clear ()=0

Static Public Member Functions
static Storage *	getInstance ()
static void	setInstance (Storage *instance)

Detailed Description

Storage is the main interface to the article archive.

It creates and manages FeedStorage objects handling the article list for a feed.

An archive implementation must implement Storage, FeedStorage and StorageFactory. See mk4storage for an example.

Definition at line 44 of file storage.h.

Constructor & Destructor Documentation

~Storage()

virtual Akregator::Backend::Storage::~Storage ( )

inlinevirtual

Definition at line 51 of file storage.h.

Member Function Documentation

add()

virtual void Akregator::Backend::Storage::add ( Storage * source )

pure virtual

adds all feed storages from a source to this storage existing articles are replaced

Implemented in Akregator::Backend::StorageDummyImpl.

archiveFor()

virtual FeedStorage * Akregator::Backend::Storage::archiveFor ( const TQString & url )

pure virtual

Returns

Article archive for feed at given url.

Implemented in Akregator::Backend::StorageDummyImpl.

clear()

virtual void Akregator::Backend::Storage::clear ( )

pure virtual

deletes all feed storages in this archive

Implemented in Akregator::Backend::StorageDummyImpl.

close()

virtual bool Akregator::Backend::Storage::close ( )

pure virtual

Closes storage, freeing all allocated resources.

Called from destructor, so you don't need to call it directly.

Returns

true on success.

Implemented in Akregator::Backend::StorageDummyImpl.

commit()

virtual bool Akregator::Backend::Storage::commit ( )

pure virtual

Commit changes made in feeds and articles, making them persistent.

Returns

true on success.

Implemented in Akregator::Backend::StorageDummyImpl.

feeds()

virtual TQStringList Akregator::Backend::Storage::feeds ( ) const

pure virtual

returns a list of all feeds (URLs) stored in this archive

Implemented in Akregator::Backend::StorageDummyImpl.

getInstance()

Storage * Akregator::Backend::Storage::getInstance ( )

static

Definition at line 31 of file storage.cpp.

initialize()

virtual void Akregator::Backend::Storage::initialize ( const TQStringList & params )

pure virtual

initializes the storage object with given parameters

Implemented in Akregator::Backend::StorageDummyImpl.

open()

virtual bool Akregator::Backend::Storage::open ( bool autoCommit = false )

pure virtual

Open storage and prepare it for work.

Returns

true on success.

Implemented in Akregator::Backend::StorageDummyImpl.

rollback()

virtual bool Akregator::Backend::Storage::rollback ( )

pure virtual

Rollback changes made in feeds and articles, reverting to last committed values.

Returns

true on success.

Implemented in Akregator::Backend::StorageDummyImpl.

setInstance()

void Akregator::Backend::Storage::setInstance ( Storage * instance )

static

Definition at line 36 of file storage.cpp.

storeFeedList()

virtual void Akregator::Backend::Storage::storeFeedList ( const TQString & opmlStr )

pure virtual

stores the feed list in the storage backend.

This is a fallback for the case that the feeds.opml file gets corrupted

Parameters

opmlStr

the feed list in OPML format

Implemented in Akregator::Backend::StorageDummyImpl.

---

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

• storage.h
• storage.cpp