Struct PrefixMap

Source

pub struct PrefixMap {
    pub map: IndexMap<String, IriS>,
    /* private fields */
}

Expand description

Contains declarations of prefix maps which are used in TURTLE, SPARQL and ShEx

Fields§

§map: IndexMap<String, IriS>

Proper prefix map associations of an alias String to an IriS

Implementations§

Source §

impl PrefixMap

Source

pub fn new() -> PrefixMap

Creates an empty (“map

Source

pub fn len(&self) -> usize

Returns the number of prefix associations in the prefixmap

Source

pub fn is_empty(&self) -> bool

Returns true if the prefixmap is empty

Source

pub fn with_qualify_prefix_color(self, color: Option<Color>) -> Self

Change color when qualifying a IRI

Source

pub fn with_qualify_localname_color(self, color: Option<Color>) -> Self

Change color of localname when qualifying a IRI

Source

pub fn with_qualify_semicolon_color(self, color: Option<Color>) -> Self

Change color of semicolon when qualifying a IRI

Source

pub fn without_rich_qualifying(self) -> Self

Disable all rich qualifying (colors and hyperlinks)

Source

pub fn add_prefix( &mut self, prefix: String, iri: String, ) -> Result<(), PrefixMapError>

Source

pub fn insert(&mut self, alias: &str, iri: &IriS) -> Result<(), PrefixMapError>

Inserts an alias association to an IRI

Source

pub fn find(&self, str: &str) -> Option<&IriS>

Finds an IRI associated with an alias

Source

pub fn from_hashmap( hm: &HashMap<&str, &str>, ) -> Result<PrefixMap, PrefixMapError>

Creates a prefix map from a hashmap of &str to &str

Source

pub fn iter(&self) -> Iter<'_, String, IriS>

Return an iterator over the key-value pairs of the (“map, in their order

Source

pub fn resolve(&self, str: &str) -> Result<IriS, PrefixMapError>

Resolves a string against a prefix map Example: Given a string like “ex:a” and a prefixmap that has alias “ex” with value “http://example.org/”, the result will be “http://example.org/a”

use std::collections::HashMap;
use prefixmap::PrefixMap;
use prefixmap::PrefixMapError;
use iri_s::*;
use std::str::FromStr;


let pm: PrefixMap = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = pm.resolve(":a")?;
let a_resolved = IriS::from_str("http://example.org/a")?;
assert_eq!(a, a_resolved);
Ok::<(), PrefixMapError>(());

let knows = pm.resolve("schema:knows")?;
let knows_resolved = IriS::from_str("http://schema.org/knows")?;
assert_eq!(knows, knows_resolved);
Ok::<(), PrefixMapError>(())

Source

pub fn resolve_iriref(&self, iri_ref: &IriRef) -> Result<IriS, PrefixMapError>

Resolves an IriRef against a prefix map

Source

pub fn resolve_prefix_local( &self, prefix: &str, local: &str, ) -> Result<IriS, PrefixMapError>

Resolves a prefixed alias and a local name in a prefix map to obtain the full IRI

use std::collections::HashMap;
use prefixmap::PrefixMap;


let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/"),
    ("xsd", "http://www.w3.org/2001/XMLSchema#")
]))?;

let a = pm.resolve_prefix_local("", "a")?;
let a_resolved = IriS::from_str("http://example.org/a")?;
assert_eq!(a, a_resolved);

let knows = pm.resolve_prefix_local("schema","knows")?;
let knows_resolved = IriS::from_str("http://schema.org/knows")?;
assert_eq!(knows, knows_resolved);

let xsd_string = pm.resolve_prefix_local("xsd","string")?;
let xsd_string_resolved = IriS::from_str("http://www.w3.org/2001/XMLSchema#string")?;
assert_eq!(xsd_string, xsd_string_resolved);

Source

pub fn qualify(&self, iri: &IriS) -> String

Qualifies an IRI against a prefix map

If it can’t qualify the IRI, it returns the iri between < and >

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify(&a), ":a");

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify(&knows), "schema:knows");

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify(&other), "<http://other.org/foo>");

Source

pub fn qualify_optional(&self, iri: &IriS) -> Option<String>

Qualifies an IRI against a prefix map

If it can’t qualify the IRI, returns None

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify_optional(&a), Some(":a".to_string()));

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify_optional(&knows), Some("schema:knows".to_string()));

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify_optional(&other), None);

Source

pub fn qualify_and_length(&self, iri: &IriS) -> (String, usize)

Qualifies an IRI against a prefix map returning the length of the qualified string

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify_and_length(&a), (":a".to_string(), 2));

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify_and_length(&knows), ("schema:knows".to_string(),12));

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify_and_length(&other), ("<http://other.org/foo>".to_string(), 22));

Source

pub fn qualify_local(&self, iri: &IriS) -> Option<String>

Qualify an IRI against a prefix map and obtains the local name

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify_local(&a), Some("a".to_string()));

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify_local(&knows), Some("knows".to_string()));

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify_local(&other), None);