Nepomuk
Nepomuk::Types::Entity Class Reference
Base class for static ontology entities Class and Property. More...
#include <entity.h>

Public Member Functions | |
QString | comment (const QString &language=KGlobal::locale()->language()) |
Entity (const Entity &) | |
QIcon | icon () |
bool | isAvailable () |
bool | isValid () const |
QString | label (const QString &language=KGlobal::locale()->language()) |
QString | name () const |
operator QUrl () const | |
bool | operator!= (const Entity &other) const |
Entity & | operator= (const Entity &) |
bool | operator== (const Entity &other) const |
void | reset (bool recursive=false) |
QUrl | uri () const |
virtual | ~Entity () |
Protected Member Functions | |
Entity () | |
Protected Attributes | |
QExplicitlySharedDataPointer < EntityPrivate > | d |
Detailed Description
Base class for static ontology entities Class and Property.
It encapsulates the generic labels and comments that both types have.
Due to internal optimizations comparing two Entities is much faster than comparing two QUrl objects.
Definition at line 52 of file entity.h.
Constructor & Destructor Documentation
Nepomuk::Types::Entity::Entity | ( | const Entity & | ) |
Default copy constructor.
virtual Nepomuk::Types::Entity::~Entity | ( | ) | [virtual] |
Destructor.
Nepomuk::Types::Entity::Entity | ( | ) | [protected] |
Create an invalid Entity instance.
Member Function Documentation
QString Nepomuk::Types::Entity::comment | ( | const QString & | language = KGlobal::locale()->language() |
) |
Retrieve the comment of the entity (rdfs:comment).
- Parameters:
-
language The code of the language to use. Defaults to the session language configured in KDE. As of KDE 4.3 only the currently configured language is loaded to save memory.
- Returns:
- The comment translated into
language
or the default fallback comment if no translation is available or an empty string if no comment could be found at all.
QIcon Nepomuk::Types::Entity::icon | ( | ) |
Retrieve the icon stored for the entity (nao:hasSymbol).
If no symbol is defined for the entity a null icon will be returned.
- Since:
- 4.1
bool Nepomuk::Types::Entity::isAvailable | ( | ) |
bool Nepomuk::Types::Entity::isValid | ( | ) | const |
Is this a valid Entity, i.e.
has it a valid URI. A valid Entity does not necessarily have a label and a comment, it does not even have to exist in the Nepomuk store.
- See also:
- isAvailable
QString Nepomuk::Types::Entity::label | ( | const QString & | language = KGlobal::locale()->language() |
) |
Retrieve the label of the entity (rdfs:label).
- Parameters:
-
language The code of the language to use. Defaults to the session language configured in KDE. As of KDE 4.3 only the currently configured language is loaded to save memory.
- Returns:
- The label translated into
language
or the default fallback label if no translation is available or the name() if no label could be found at all.
QString Nepomuk::Types::Entity::name | ( | ) | const |
The name of the resource.
The name equals the fragment of the URI.
Nepomuk::Types::Entity::operator QUrl | ( | ) | const [inline] |
bool Nepomuk::Types::Entity::operator!= | ( | const Entity & | other | ) | const |
Compares two Entity instances by simply comparing their URI.
Copy operator.
Reimplemented in Nepomuk::Types::Class, Nepomuk::Types::Ontology, and Nepomuk::Types::Property.
bool Nepomuk::Types::Entity::operator== | ( | const Entity & | other | ) | const |
Compares two Entity instances by simply comparing their URI.
void Nepomuk::Types::Entity::reset | ( | bool | recursive = false |
) |
The Types classes are optimized for performance under the aasumption that ontologies never change during the execution time of an application.
Since there might be situations where this does not apply the internal cache can be reset via this method.
- Parameters:
-
recursive If true
all related entities will be reset as well.
- Since:
- 4.1
QUrl Nepomuk::Types::Entity::uri | ( | ) | const |
The URI of the resource.
Member Data Documentation
QExplicitlySharedDataPointer<EntityPrivate> Nepomuk::Types::Entity::d [protected] |
The documentation for this class was generated from the following file: