Syndication::AbstractParser

Syndication::AbstractParser Class Referenceabstract

#include <abstractparser.h>

Inheritance diagram for Syndication::AbstractParser:

Public Member Functions

virtual ~AbstractParser ()
 
virtual bool accept (const DocumentSource &source) const =0
 
virtual QString format () const =0
 
virtual SpecificDocumentPtr parse (const DocumentSource &source) const =0
 

Detailed Description

Interface for all parsers.

The parsers for the various formats must implement this interface and register themselves at the ParserRegistry.

Author
Frank Osterfeld

Definition at line 43 of file abstractparser.h.

Constructor & Destructor Documentation

Syndication::AbstractParser::~AbstractParser ( )
virtual

virtual destructor

Definition at line 28 of file abstractparser.cpp.

Member Function Documentation

virtual bool Syndication::AbstractParser::accept ( const DocumentSource source) const
pure virtual

Lets the parser check if it can parse the passed source.

Parser implementations should do a quick check for the file format (i.e. check for feed format and version number in the root element) to find out if the source is in a supported format. They should not completely parse the document to test for full compliance to the format specification.

Parameters
sourcethe document source to be checked
Returns
whether source seems to be in a format supported by the parser

Implemented in Syndication::Atom::Parser, Syndication::RSS2::Parser, and Syndication::RDF::Parser.

virtual QString Syndication::AbstractParser::format ( ) const
pure virtual

Returns the name of the format supported by this parser.

Returns
a string like "rss2", "atom" or "rdf"

Implemented in Syndication::RSS2::Parser, Syndication::Atom::Parser, and Syndication::RDF::Parser.

virtual SpecificDocumentPtr Syndication::AbstractParser::parse ( const DocumentSource source) const
pure virtual

Lets the parser parse a document source.

The parser returns a valid document instance if successful, or an invalid one if not.

See also
SpecificDocument::isValid()
Parameters
sourceThe document source to be parsed
Returns
a newly created document parsed from source

Implemented in Syndication::RSS2::Parser, Syndication::Atom::Parser, and Syndication::RDF::Parser.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Jul 5 2020 23:02:49 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.