Syndication::DocumentVisitor Class Reference

#include <documentvisitor.h>

Public Member Functions
virtual	~DocumentVisitor ()
virtual bool	visit (SpecificDocument *document)
virtual bool	visitAtomEntryDocument (Syndication::Atom::EntryDocument *document)
virtual bool	visitAtomFeedDocument (Syndication::Atom::FeedDocument *document)
virtual bool	visitRDFDocument (Syndication::RDF::Document *document)
virtual bool	visitRSS2Document (Syndication::RSS2::Document *document)

Detailed Description

Visitor interface, following the Visitor design pattern.

Use this if you want to process documents and the way how to handle the document depends on it's concrete type (e.g. RSS2::Document, RDF::Document...).

TODO: insert code example

Author

Frank Osterfeld

Definition at line 42 of file documentvisitor.h.

Constructor & Destructor Documentation

~DocumentVisitor()

Syndication::DocumentVisitor::~DocumentVisitor ( )

virtual

destructor

Definition at line 13 of file documentvisitor.cpp.

Member Function Documentation

visit()

bool Syndication::DocumentVisitor::visit ( SpecificDocument * document )

virtual

call this method to handle a document.

Depending on the concrete type of the document, a specialized visit method is called.

Parameters

document

the document to process

Returns

whether this visitor handles the type of the document.

Definition at line 17 of file documentvisitor.cpp.

visitAtomEntryDocument()

bool Syndication::DocumentVisitor::visitAtomEntryDocument ( Syndication::Atom::EntryDocument * document )

virtual

reimplement this method to handle Atom entry documents.

Parameters

document

the atom entry document to visit

Returns

whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 37 of file documentvisitor.cpp.

visitAtomFeedDocument()

bool Syndication::DocumentVisitor::visitAtomFeedDocument ( Syndication::Atom::FeedDocument * document )

virtual

reimplement this method to handle Atom feed documents (most Atom feeds are of this type).

Parameters

document

the atom feed document to visit

Returns

whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 32 of file documentvisitor.cpp.

visitRDFDocument()

bool Syndication::DocumentVisitor::visitRDFDocument ( Syndication::RDF::Document * document )

virtual

reimplement this method to handle RDF (i.e.

RSS 1.0) documents.

Parameters

document

the RDF document to visit

Returns

whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 27 of file documentvisitor.cpp.

visitRSS2Document()

bool Syndication::DocumentVisitor::visitRSS2Document ( Syndication::RSS2::Document * document )

virtual

reimplement this method to handle RSS2-like (RSS 0.9x, 2.0) documents.

Parameters

document

the RSS2 document to visit

Returns

whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 22 of file documentvisitor.cpp.

---

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

• documentvisitor.h
• documentvisitor.cpp