Nepomuk::Types::Entity Class Reference

Abstract base class for Class and Property;. More...

#include <entity.h>

Inheritance diagram for Nepomuk::Types::Entity:

List of all members.

Public Member Functions
	Entity (const Entity &)
virtual	~Entity ()
QString	comment (const QString &language=KGlobal::locale()->language())
QString	comment (const QString &language=KGlobal::locale()->language()) const
QIcon	icon ()
QIcon	icon () const
bool	isAvailable ()
bool	isAvailable () const
bool	isValid () const
QString	label (const QString &language=KGlobal::locale()->language())
QString	label (const QString &language=KGlobal::locale()->language()) const
QString	name () const
	operator QUrl () const
bool	operator!= (const QUrl &other) const
bool	operator!= (const Entity &other) const
Entity &	operator= (const Entity &)
bool	operator== (const Entity &other) const
bool	operator== (const QUrl &other) const
void	reset (bool recursive=false)
QUrl	uri () const
bool	userVisible () const
Protected Member Functions
	Entity ()
Protected Attributes
QExplicitlySharedDataPointer < EntityPrivate >	d

---

Detailed Description

Abstract base class for Class and Property;.

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.

Author:

Sebastian Trueg <trueg@kde.org>

Definition at line 54 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.

QString Nepomuk::Types::Entity::comment

(

const QString &

language = KGlobal::locale()->language()

)

const

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.

Const version

Since:

4.4

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

QIcon Nepomuk::Types::Entity::icon

(

)

const

Retrieve the icon stored for the entity (nao:hasSymbol)

If no symbol is defined for the entity a null icon will be returned.

Const version.

Since:

4.4

bool Nepomuk::Types::Entity::isAvailable

(

)

Is this Entity available locally, i.e.

could its properties be loaded from the Nepomuk store.

bool Nepomuk::Types::Entity::isAvailable

(

)

const

Is this Entity available locally, i.e.

could its properties be loaded from the Nepomuk store.

Const version.

Since:

4.4

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()

)

const

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.

Const version

Since:

4.4

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]

An Entity can be used as a QUrl automagically.

Definition at line 216 of file entity.h.

bool Nepomuk::Types::Entity::operator!=

(

const Entity &

other

)

const

Compares two Entity instances.

This is faster than simply comparing the URIs.

bool Nepomuk::Types::Entity::operator!=

(

const QUrl &

other

)

const

Compares the Entity with a URI.

Since:

4.5

Entity& Nepomuk::Types::Entity::operator=

(

const Entity &

)

Copy operator.

bool Nepomuk::Types::Entity::operator==

(

const QUrl &

other

)

const

Compares the Entity with a URI.

Since:

4.5

bool Nepomuk::Types::Entity::operator==

(

const Entity &

other

)

const

Compares two Entity instances.

This is faster than simply comparing the URIs.

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.

bool Nepomuk::Types::Entity::userVisible

(

)

const

nao:userVisible can be used to hide certain properties and resources of a certain type from the user.

Returns:

true if this entity should be visible to the user.

Since:

4.6

---

Member Data Documentation

QExplicitlySharedDataPointer<EntityPrivate> Nepomuk::Types::Entity::d [protected]

Definition at line 250 of file entity.h.

---

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

• entity.h