knowrob::PrefixRegistry Class Reference

#include <PrefixRegistry.h>

Public Types
using	Iterator = std::map< std::string, std::string >::iterator
using	Iterator = std::map< std::string, std::string >::iterator

Public Member Functions
Iterator	begin ()
Iterator	end ()
Iterator	begin ()
Iterator	end ()

Static Public Member Functions
static PrefixRegistry &	get ()
static void	registerPrefix (std::string_view prefix, std::string_view uri)
static OptionalStringRef	uriToAlias (std::string_view uri)
static OptionalStringRef	aliasToUri (std::string_view alias)
static std::optional< std::string >	createIRI (std::string_view alias, std::string_view entityName)
static std::vector< std::string_view >	getAliasesWithPrefix (std::string_view prefix)
static PrefixRegistry &	get ()
static void	registerPrefix (std::string_view prefix, std::string_view uri)
static OptionalStringRef	uriToAlias (std::string_view uri)
static OptionalStringRef	aliasToUri (std::string_view alias)
static std::optional< std::string >	createIRI (std::string_view alias, std::string_view entityName)
static std::vector< std::string_view >	getAliasesWithPrefix (std::string_view prefix)

Detailed Description

Stores short names of IRI prefixes.

Definition at line 20 of file PrefixRegistry.h.

Member Typedef Documentation

Iterator [1/2]

using knowrob::PrefixRegistry::Iterator = std::map<std::string, std::string>::iterator

An iterator of the registry map.

Definition at line 66 of file PrefixRegistry.h.

Iterator [2/2]

using knowrob::PrefixRegistry::Iterator = std::map<std::string, std::string>::iterator

An iterator of the registry map.

Definition at line 66 of file PrefixRegistry.h.

Member Function Documentation

aliasToUri() [1/2]

OptionalStringRef PrefixRegistry::aliasToUri ( std::string_view  alias )

static

Maps alias to URI.

Parameters

alias

a URI alias

Returns

the corresponding URI, or nullopt if alias is unknown.

Definition at line 61 of file PrefixRegistry.cpp.

                                                                 {
    if (alias.empty()) {
        return std::nullopt;
    } else {
        auto it = get().aliasToURI_.find(alias);
        return it == get().aliasToURI_.end() ? std::nullopt : OptionalStringRef(it->second);
    }
}

aliasToUri() [2/2]

static OptionalStringRef knowrob::PrefixRegistry::aliasToUri ( std::string_view  alias )

static

Maps alias to URI.

Parameters

alias

a URI alias

Returns

the corresponding URI, or nullopt if alias is unknown.

begin() [1/2]

Iterator knowrob::PrefixRegistry::begin ( )

inline

Returns

begin iterator over the registry map.

Definition at line 71 of file PrefixRegistry.h.

{ return uriToAlias_.begin(); }

begin() [2/2]

Iterator knowrob::PrefixRegistry::begin ( )

inline

Returns

begin iterator over the registry map.

Definition at line 71 of file PrefixRegistry.h.

{ return uriToAlias_.begin(); }

createIRI() [1/2]

std::optional< std::string > PrefixRegistry::createIRI ( std::string_view  alias, std::string_view  entityName  )

static

Construct a full IRI from alias and entity name.

Parameters

alias	namespace alias
entityName	the name of an entity in the namespace identified by alias

Returns

a full IRI if namespace alias is known

Definition at line 70 of file PrefixRegistry.cpp.

                                                                                                {
    auto uri = aliasToUri(alias);
    if (uri.has_value()) {
        std::stringstream os;
        os << uri.value().get() << entityName;
        return os.str();
    } else {
        return std::nullopt;
    }
}

createIRI() [2/2]

static std::optional<std::string> knowrob::PrefixRegistry::createIRI ( std::string_view  alias, std::string_view  entityName  )

static

Construct a full IRI from alias and entity name.

Parameters

alias	namespace alias
entityName	the name of an entity in the namespace identified by alias

Returns

a full IRI if namespace alias is known

end() [1/2]

Iterator knowrob::PrefixRegistry::end ( )

inline

Returns

end iterator over the registry map.

Definition at line 76 of file PrefixRegistry.h.

{ return uriToAlias_.end(); }

end() [2/2]

Iterator knowrob::PrefixRegistry::end ( )

inline

Returns

end iterator over the registry map.

Definition at line 76 of file PrefixRegistry.h.

{ return uriToAlias_.end(); }

get() [1/2]

PrefixRegistry & PrefixRegistry::get ( )

static

Returns

the singleton instance of the registry.

Definition at line 23 of file PrefixRegistry.cpp.

                                    {
    static PrefixRegistry singleton;
    return singleton;
}

get() [2/2]

static PrefixRegistry& knowrob::PrefixRegistry::get ( )

static

Returns

the singleton instance of the registry.

getAliasesWithPrefix() [1/2]

std::vector< std::string_view > PrefixRegistry::getAliasesWithPrefix ( std::string_view  prefix )

static

Parameters

prefix

a alias prefix

Returns

all aliases with matching prefix

Definition at line 81 of file PrefixRegistry.cpp.

                                                                                    {
    auto range_it = get().aliasToURI_.equal_range(PrefixProbe{prefix});
    std::vector<std::string_view> result;
    for (auto it = range_it.first; it != range_it.second; ++it) {
        result.emplace_back(it->first.c_str());
    }
    return result;
}

getAliasesWithPrefix() [2/2]

static std::vector<std::string_view> knowrob::PrefixRegistry::getAliasesWithPrefix ( std::string_view  prefix )

static

Parameters

prefix

a alias prefix

Returns

all aliases with matching prefix

registerPrefix() [1/2]

void PrefixRegistry::registerPrefix ( std::string_view  prefix, std::string_view  uri  )

static

Register a namespace prefix. This will overwrite any existing prefix registered for given URI.

Parameters

prefix	a short name for the URI.
uri	a full URI.

Definition at line 44 of file PrefixRegistry.cpp.

                                                                             {
    get().registerPrefix_(prefix, uri);
}

registerPrefix() [2/2]

static void knowrob::PrefixRegistry::registerPrefix ( std::string_view  prefix, std::string_view  uri  )

static

Register a namespace prefix. This will overwrite any existing prefix registered for given URI.

Parameters

prefix	a short name for the URI.
uri	a full URI.

uriToAlias() [1/2]

OptionalStringRef PrefixRegistry::uriToAlias ( std::string_view  uri )

static

Maps URI to alias.

Parameters

uri

a URI

Returns

an alias, or nullopt if no alias is known.

Definition at line 48 of file PrefixRegistry.cpp.

                                                               {
    if (uri.empty()) {
        return std::nullopt;
    } else if (isDelimiter(uri[uri.size() - 1])) {
        auto it = get().uriToAlias_.find(uri);
        return it == get().uriToAlias_.end() ? std::nullopt : OptionalStringRef(it->second);
    } else {
        auto withDelimiter = std::string(uri) + '#';
        auto it = get().uriToAlias_.find(withDelimiter);
        return it == get().uriToAlias_.end() ? std::nullopt : OptionalStringRef(it->second);
    }
}

uriToAlias() [2/2]

static OptionalStringRef knowrob::PrefixRegistry::uriToAlias ( std::string_view  uri )

static

Maps URI to alias.

Parameters

uri

a URI

Returns

an alias, or nullopt if no alias is known.

---

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

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/semweb/PrefixRegistry.h
• src/semweb/PrefixRegistry.cpp