#include <FocusNodeCollection.h>

Classes
struct	OperatorOptions

struct	Private

Public Member Functions
	FocusNodeCollection (const FocusNodeCollection &_rhs)

FocusNodeCollection	operator= (const FocusNodeCollection &_rhs)

bool	operator== (const FocusNodeCollection &_collection) const

bool	isValid () const

bool	isReadOnly () const

cres_qresult< knowCore::UriList >	containedTypes () const

cres_qresult< knowCore::Uri >	collectionType () const

knowCore::Uri	uri () const

kDB::Repository::Connection	connection () const

cres_qresult< std::size_t >	count () const

cres_qresult< std::size_t >	count (const knowCore::Uri &_type) const

cres_qresult< FocusNode >	focusNode (const knowCore::Uri &_focusNodeUri) const

cres_qresult< bool >	hasFocusNode (const knowCore::Uri &_focusNodeUri, const knowCore::Uri &_typeUri) const

cres_qresult< QList< FocusNode > >	all () const

cres_qresult< QList< FocusNode > >	all (const knowCore::Uri &_typeUri) const

cres_qresult< QList< FocusNode > >	focusNodes (const knowCore::UriList &_default_datatypes, const QList< QPair< knowCore::Uri, knowCore::ConstrainedValue > > &_constraints, const OperatorOptions &_operatorOptions=OperatorOptions()) const

cres_qresult< FocusNode >	createFocusNode (const knowCore::Uri &_typeUri, const knowCore::ValueHash &_properties, const knowCore::Uri &_focusNodeUri)

Static Public Member Functions
static cres_qresult< FocusNodeCollection >	get (const kDB::Repository::Connection &_connection, const knowCore::Uri &_collection_uri)

static cres_qresult< FocusNodeCollection >	create (const kDB::Repository::Connection &_connection, const knowCore::Uri &_graph, const knowCore::Uri &_collection_type, const knowCore::UriList &_contained_types)

static cres_qresult< FocusNodeCollection >	getOrCreate (const kDB::Repository::Connection &_connection, const knowCore::Uri &_graph, const knowCore::Uri &_collection_type, const knowCore::UriList &_contained_types)

static FocusNodeCollection	allCollections (const kDB::Repository::Connection &_connection)

static FocusNodeCollection	allFocusNodes (const kDB::Repository::Connection &_connection)

static cres_qresult< knowCore::UriList >	allCollectionUris (const kDB::Repository::QueryConnectionInfo &_connection, const knowCore::Uri &_focus_node_type)

static cres_qresult< knowCore::UriList >	allCollectionUrisWith (const kDB::Repository::QueryConnectionInfo &_connection, const knowCore::Uri &_focus_node)

static cres_qresult< void >	registerCollection (const kDB::Repository::QueryConnectionInfo &_connection, const knowCore::Uri &_view_graph, const knowCore::Uri &_collection_type, const knowCore::UriList &_contained_types)

Friends
class	kDB::Repository::Connection

Detailed Description

Interface a kDB::Repository::TripleStore that contains a set of focus nodes. For instance, datasets, agents, missions, salient regions...

Member Function Documentation

◆ all() [1/2]

cres_qresult< QList< FocusNode > > FocusNodeCollection::all ( ) const

Returns: all the focus node contained in this document.

◆ all() [2/2]

cres_qresult< QList< FocusNode > > FocusNodeCollection::all ( const knowCore::Uri & _typeUri ) const

Returns: all the focus node contained in this document.

◆ allCollections()

FocusNodeCollection FocusNodeCollection::allCollections ( const kDB::Repository::Connection & _connection )

static

Returns: the collection which all the documents.

◆ allCollectionUris()

cres_qresult< knowCore::UriList > FocusNodeCollection::allCollectionUris	(	const kDB::Repository::QueryConnectionInfo &	_connection,
		const knowCore::Uri &	_focus_node_type )

static

Returns: a list of the uris of all collection uris for a given type.

◆ allCollectionUrisWith()

cres_qresult< knowCore::UriList > FocusNodeCollection::allCollectionUrisWith	(	const kDB::Repository::QueryConnectionInfo &	_connection,
		const knowCore::Uri &	_focus_node )

static

Returns: a list of collection uri which includes a copy of the given focus node

◆ allFocusNodes()

FocusNodeCollection FocusNodeCollection::allFocusNodes ( const kDB::Repository::Connection & _connection )

static

Returns: a collection which is a view over all the focus nodes.

◆ collectionType()

cres_qresult< knowCore::Uri > FocusNodeCollection::collectionType ( ) const

Returns: type of the collection.

◆ connection()

kDB::Repository::Connection FocusNodeCollection::connection ( ) const

Returns: the connection

◆ containedTypes()

cres_qresult< knowCore::UriList > FocusNodeCollection::containedTypes ( ) const

Returns: types contained in the collection.

◆ count() [1/2]

cres_qresult< std::size_t > FocusNodeCollection::count ( ) const

Returns: the number of focus nodes in this collection.

◆ count() [2/2]

cres_qresult< std::size_t > FocusNodeCollection::count ( const knowCore::Uri & _type ) const

Returns: the number of focus nodes in this collection of a given type.

◆ create()

cres_qresult< FocusNodeCollection > FocusNodeCollection::create	(	const kDB::Repository::Connection &	_connection,
		const knowCore::Uri &	_graph,
		const knowCore::Uri &	_collection_type,
		const knowCore::UriList &	_contained_types )

static

Create a new kDB::Repository::TripleStore with uri _graph.

Returns: the collection or an error (in particular, if the collection already exists).

◆ createFocusNode()

cres_qresult< FocusNode > FocusNodeCollection::createFocusNode	(	const knowCore::Uri &	_typeUri,
		const knowCore::ValueHash &	_properties,
		const knowCore::Uri &	_focusNodeUri )

Create a new FocusNode of uri type _typeUri and add it to this collection.

◆ focusNode()

cres_qresult< FocusNode > FocusNodeCollection::focusNode ( const knowCore::Uri & _focusNodeUri ) const

Returns: the focus node with the Uri _focusNodeUri

◆ focusNodes()

cres_qresult< QList< FocusNode > > FocusNodeCollection::focusNodes	(	const knowCore::UriList &	_default_datatypes,
		const QList< QPair< knowCore::Uri, knowCore::ConstrainedValue > > &	_constraints,
		const OperatorOptions &	_operatorOptions = OperatorOptions() ) const

Parameters

_constraints	a list of pair of list of uris representing the property uri and a constraint.
_operatorOptions	set the precision used by operators

Returns: the list of agents that satisfies the constraints

◆ get()

cres_qresult< FocusNodeCollection > FocusNodeCollection::get	(	const kDB::Repository::Connection &	_connection,
		const knowCore::Uri &	_collection_uri )

static

Return an unique instance of the focus nodes stored in _collection_uri for a given _connection

Returns: the collection or an error (in particular, if the collection does not exists).

◆ getOrCreate()

cres_qresult< FocusNodeCollection > FocusNodeCollection::getOrCreate	(	const kDB::Repository::Connection &	_connection,
		const knowCore::Uri &	_graph,
		const knowCore::Uri &	_collection_type,
		const knowCore::UriList &	_contained_types )

static

Create or access the focus node collection specified in _graph

Returns: the collection or an error (in particular, if the collection already exists with a different type).

◆ hasFocusNode()

cres_qresult< bool > FocusNodeCollection::hasFocusNode	(	const knowCore::Uri &	_focusNodeUri,
		const knowCore::Uri &	_typeUri ) const

Returns: true if the focus node already exists.

◆ isReadOnly()

bool FocusNodeCollection::isReadOnly ( ) const

Returns: true if it can only be used to access focus nodes and not insert one.

◆ isValid()

bool FocusNodeCollection::isValid ( ) const

Returns: true if it is a valid set of focus nodes

◆ uri()

knowCore::Uri FocusNodeCollection::uri ( ) const

Returns: the uri for the graph

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

kdb/kDB/Repository/RDF/FocusNodeCollection.h
kdb/kDB/Repository/RDF/FocusNodeCollection.cpp

Classes

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ all() [1/2]

◆ all() [2/2]

◆ allCollections()

◆ allCollectionUris()

◆ allCollectionUrisWith()

◆ allFocusNodes()

◆ collectionType()

◆ connection()

◆ containedTypes()

◆ count() [1/2]

◆ count() [2/2]

◆ create()

◆ createFocusNode()

◆ focusNode()

◆ focusNodes()

◆ get()

◆ getOrCreate()

◆ hasFocusNode()

◆ isReadOnly()

◆ isValid()

◆ uri()