Akregator::Backend::Storage Class Reference

#include <storage.h>

Inheritance diagram for Akregator::Backend::Storage:

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

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 43 of file storage.h.

Constructor & Destructor Documentation

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

inlinevirtual

Definition at line 47 of file storage.h.

Member Function Documentation

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.

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

pure virtual

Returns

Article archive for feed at given url.

Implemented in Akregator::Backend::StorageDummyImpl.

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

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

virtual bool Akregator::Backend::Storage::autoCommit ( ) const

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

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

pure virtual

deletes all feed storages in this archive

Implemented in Akregator::Backend::StorageDummyImpl.

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.

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.

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

pure virtual

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

Implemented in Akregator::Backend::StorageDummyImpl.

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

pure virtual

initializes the storage object with given parameters

Implemented in Akregator::Backend::StorageDummyImpl.

virtual int Akregator::Backend::Storage::lastFetchFor ( const QString &  url ) const

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

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.

virtual QString Akregator::Backend::Storage::restoreFeedList ( ) const

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

virtual QString Akregator::Backend::Storage::restoreTagSet ( ) const

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

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.

virtual void Akregator::Backend::Storage::setLastFetchFor ( const QString &  url, int  lastFetch  )

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

virtual void Akregator::Backend::Storage::setTotalCountFor ( const QString &  url, int  total  )

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

virtual void Akregator::Backend::Storage::setUnreadFor ( const QString &  url, int  unread  )

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

virtual void Akregator::Backend::Storage::storeFeedList ( const QString &  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.

virtual void Akregator::Backend::Storage::storeTagSet ( const QString &  xmlStr )

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

virtual int Akregator::Backend::Storage::totalCountFor ( const QString &  url ) const

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

virtual int Akregator::Backend::Storage::unreadFor ( const QString &  url ) const

pure virtual

Implemented in Akregator::Backend::StorageDummyImpl.

---

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

• storage.h