IDefinitionParser Class Reference

The IDefinitionParser interface provides easy-to-use interface to read and parse component description information. More...

#include <IDefinitionParser.h>

Inherited by XmlDefinitionParser.

Public Types
typedef QMap< QString, QString >	ParentsList

Public Member Functions
virtual const QString &	componentLocation () const =0
virtual const QString &	componentName () const =0
virtual const QString &	componentShortName () const =0
virtual const QString &	description () const =0
virtual const QString &	error () const =0
virtual const ParentsList &	parents () const =0
virtual const QString &	productName () const =0
virtual const QString &	provider () const =0
virtual bool	read (const QString &text)=0
virtual bool	read (const QByteArray &data)=0
virtual bool	read (QIODevice *dev)=0
virtual const QString &	version () const =0

Detailed Description

The IDefinitionParser interface provides easy-to-use interface to read and parse component description information.

This interface is used by the ProxyComponent to obtain meta information about the loaded component. If read() returns true you can use parsed information through the accessor methods.

Known realizations: XmlDefinitionParser. Further realizations: JsonDefinitionParser.

Todo:

write about <>Provider, who instantiates IDefinitionParser using service locator.

Member Function Documentation

virtual const QString& IDefinitionParser::error ( ) const

pure virtual

Gets the error occurred during reading (method read()). Returns empty string if error was not occurred.

Implemented in XmlDefinitionParser.

virtual const QString& IDefinitionParser::componentShortName ( ) const

pure virtual

Gets the component Id.

Implemented in XmlDefinitionParser.

virtual const QString& IDefinitionParser::componentName ( ) const

pure virtual

Gets the parsed component name.

Implemented in XmlDefinitionParser.

virtual const QString& IDefinitionParser::componentLocation ( ) const

pure virtual

Gets the parsed component location (relative or absolyte) without library extension.

Implemented in XmlDefinitionParser.

virtual const QString& IDefinitionParser::description ( ) const

pure virtual

Gets the parsed component description. Optional, can be empty string.

Implemented in XmlDefinitionParser.

virtual const ParentsList& IDefinitionParser::parents ( ) const

pure virtual

Gets the parsed component parents names and versions. Optional, can be empty list.

Implemented in XmlDefinitionParser.

virtual const QString& IDefinitionParser::productName ( ) const

pure virtual

Gets the parsed product name. Optional, can be empty string.

Implemented in XmlDefinitionParser.

virtual const QString& IDefinitionParser::provider ( ) const

pure virtual

Gets the the name of component's provider, the person or company, who creates this component.

Implemented in XmlDefinitionParser.

virtual const QString& IDefinitionParser::version ( ) const

pure virtual

Gets the string representation of version of a component.

Implemented in XmlDefinitionParser.

virtual bool IDefinitionParser::read ( const QString &  text )

pure virtual

This function parses the string text and sets component meta information.

If a parse error occurs (incorrect format, required information is missed, etc), this function returns false. The error message could be got through error() method.

Implemented in XmlDefinitionParser.

virtual bool IDefinitionParser::read ( const QByteArray &  data )

pure virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual bool IDefinitionParser::read ( QIODevice *  dev )

pure virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Implemented in XmlDefinitionParser.