[KLF Application][KLF Tools][KLF Backend][KLF Home]
KLatexFormula Project
Classes | Public Member Functions | Static Public Member Functions

KLFLibResourceSimpleEngine Class Reference

Provides a simple API for reading library resources. More...

#include <klflib.h>

Inheritance diagram for KLFLibResourceSimpleEngine:
Inheritance graph
[legend]
Collaboration diagram for KLFLibResourceSimpleEngine:
Collaboration graph
[legend]

List of all members.

Classes

class  QueryResultListSorter
 Helper class to sort entries into a KLFLibResourceEngine::QueryResult. More...

Public Member Functions

 KLFLibResourceSimpleEngine (const QUrl &url, uint supportedfeatureflags, QObject *parent=NULL)
virtual ~KLFLibResourceSimpleEngine ()
virtual QList< KLFLib::entryIdallIds (const QString &subResource)
virtual bool hasEntry (const QString &, entryId id)
virtual QList< KLFLibEntryWithIdentries (const QString &, const QList< KLFLib::entryId > &idList, const QList< int > &wantedEntryProperties=QList< int >())
virtual int query (const QString &subResource, const Query &query, QueryResult *result)
virtual QList< QVariantqueryValues (const QString &subResource, int entryPropId)

Static Public Member Functions

static int queryImpl (KLFLibResourceEngine *resource, const QString &subResource, const Query &query, QueryResult *result)
static QList< QVariantqueryValuesImpl (KLFLibResourceEngine *resource, const QString &subResource, int entryPropId)
static bool testEntryMatchConditionImpl (const KLFLib::EntryMatchCondition &condition, const KLFLibEntry &libentry)

Detailed Description

Provides a simple API for reading library resources.

This class provides default implementations of some pure virtual methods of KLFLibResourceEngine, which call other member functions. The goal is to make life simpler to create a resource engine, where access speed is not a major concern.

For example, KLFLibResourceEngine::allIds() is pure virtual. Normally it can be implemented to be faster than allEntries(), depending on the engine backend. However the functionality can as well easily be achieved by calling KLFLibResourceEngine::allEntries() and returning just a list with all the IDs, at the price of losing optimization.

This class provides non-optimized default implementations for allIds() (as given above), hasEntry(), entries(), and query(), based on the data returned by allEntries() and entry()

Bear in mind that optimizing one or more of those functions is still possible, by reimplementing them (!)

Definition at line 1588 of file klflib.h.


Constructor & Destructor Documentation

KLFLibResourceSimpleEngine::KLFLibResourceSimpleEngine ( const QUrl url,
uint  supportedfeatureflags,
QObject parent = NULL 
) [inline]

Definition at line 1592 of file klflib.h.

virtual KLFLibResourceSimpleEngine::~KLFLibResourceSimpleEngine ( ) [inline, virtual]

Definition at line 1596 of file klflib.h.


Member Function Documentation

QList< KLFLib::entryId > KLFLibResourceSimpleEngine::allIds ( const QString subResource) [virtual]

Implements KLFLibResourceEngine.

Definition at line 884 of file klflib.cpp.

References QList::size().

QList< KLFLibResourceEngine::KLFLibEntryWithId > KLFLibResourceSimpleEngine::entries ( const QString subResource,
const QList< KLFLib::entryId > &  idList,
const QList< int > &  wantedEntryProperties = QList<int>() 
) [virtual]

Implements KLFLibResourceEngine.

Definition at line 901 of file klflib.cpp.

References QList::size().

bool KLFLibResourceSimpleEngine::hasEntry ( const QString subResource,
entryId  id 
) [virtual]

Bug:
............... BUG/TODO .......... concept problem here

Implements KLFLibResourceEngine.

Definition at line 894 of file klflib.cpp.

int KLFLibResourceSimpleEngine::query ( const QString subResource,
const Query query,
QueryResult result 
) [virtual]

Implements KLFLibResourceEngine.

Definition at line 912 of file klflib.cpp.

int KLFLibResourceSimpleEngine::queryImpl ( KLFLibResourceEngine resource,
const QString subResource,
const Query query,
QueryResult result 
) [static]
QList< QVariant > KLFLibResourceSimpleEngine::queryValues ( const QString subResource,
int  entryPropId 
) [virtual]

Implements KLFLibResourceEngine.

Definition at line 919 of file klflib.cpp.

QList< QVariant > KLFLibResourceSimpleEngine::queryValuesImpl ( KLFLibResourceEngine resource,
const QString subResource,
int  entryPropId 
) [static]

A basic implementation of queryValues() based on looking at the results of resource->allEntries()

Definition at line 995 of file klflib.cpp.

References KLFLibResourceEngine::allEntries(), QList::contains(), and QList::size().

bool KLFLibResourceSimpleEngine::testEntryMatchConditionImpl ( const KLFLib::EntryMatchCondition condition,
const KLFLibEntry libentry 
) [static]

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

Generated by doxygen 1.7.3