paludis::QueryDelegate Class Reference
[Query]

#include <query_delegate.hh>

List of all members.

Basic operations

 QueryDelegate ()
virtual ~QueryDelegate ()

Public Member Functions

virtual tr1::shared_ptr
< RepositoryNameSequence
repositories (const Environment &) const
virtual tr1::shared_ptr
< CategoryNamePartSet
categories (const Environment &, tr1::shared_ptr< const RepositoryNameSequence >) const
virtual tr1::shared_ptr
< QualifiedPackageNameSet
packages (const Environment &, tr1::shared_ptr< const RepositoryNameSequence >, tr1::shared_ptr< const CategoryNamePartSet >) const
virtual tr1::shared_ptr
< PackageIDSequence
ids (const Environment &, tr1::shared_ptr< const RepositoryNameSequence >, tr1::shared_ptr< const QualifiedPackageNameSet >) const
virtual std::string as_human_readable_string () const =0


Detailed Description

A QueryDelegate subclass is used by Query to provide the information needed by PackageDatabase::query.

See also:
Query
Examples:

example_query_delegate.cc.


Member Function Documentation

virtual tr1::shared_ptr<RepositoryNameSequence> paludis::QueryDelegate::repositories ( const Environment  )  const [virtual]

Fetch the names of repositories potentially containing matches. All returned repositories must exist.

Default behaviour: return all repositories.

virtual tr1::shared_ptr<CategoryNamePartSet> paludis::QueryDelegate::categories ( const Environment ,
tr1::shared_ptr< const RepositoryNameSequence  
) const [virtual]

Fetch the names of categories potentially containing matches.

Default behaviour: return all categories in the provided repository collection.

virtual tr1::shared_ptr<QualifiedPackageNameSet> paludis::QueryDelegate::packages ( const Environment ,
tr1::shared_ptr< const RepositoryNameSequence ,
tr1::shared_ptr< const CategoryNamePartSet  
) const [virtual]

Fetch the names of packages potentially containing matches.

Default behaviour: return all packages in the provided repository in the provided categories.

Note that some entries in the categories collection (but not in the repositories collection) may not exist.

virtual tr1::shared_ptr<PackageIDSequence> paludis::QueryDelegate::ids ( const Environment ,
tr1::shared_ptr< const RepositoryNameSequence ,
tr1::shared_ptr< const QualifiedPackageNameSet  
) const [virtual]

Fetch the IDs of matching packages.

Default behaviour: return all IDs in the provided packages.

Note that some entries in the qualified package name collection (but not in the repositories collection) may not exist.

Examples:
example_query_delegate.cc.

virtual std::string paludis::QueryDelegate::as_human_readable_string (  )  const [pure virtual]

Fetch a string representation of our query.

Examples:
example_query_delegate.cc.


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

Generated on Thu May 29 15:53:44 2008 for paludis by  doxygen 1.5.5