• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.9.1 API Reference
  • KDE Home
  • Contact Us
 

Syndication Library

  • Syndication
  • AbstractParser
Public Member Functions
Syndication::AbstractParser Class Reference

#include <abstractparser.h>

List of all members.

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 42 of file abstractparser.h.


Constructor & Destructor Documentation

Syndication::AbstractParser::~AbstractParser ( )
virtual

virtual destructor

Definition at line 27 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
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"
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

The documentation for this class was generated from the following files:
  • abstractparser.h
  • abstractparser.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Sep 24 2012 09:04:17 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Syndication Library

Skip menu "Syndication Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.9.1 API Reference

Skip menu "kdepimlibs-4.9.1 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal