ontologos-ql 1.0.1

OWL QL query answering for OntoLogos
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! OWL QL conjunctive query answering and taxonomy hierarchy navigation.

#![warn(missing_docs)]

pub mod hierarchy;
mod parse;
mod query;
pub mod rewrite;

use ontologos_core::{Ontology, Taxonomy};
use thiserror::Error;

pub use hierarchy::TaxonomyHierarchy;
pub use parse::{MAX_QUERY_ATOMS, MAX_QUERY_LEN, parse_conjunctive_query};
pub use query::{ConjunctiveQuery, QueryAnswer, QueryAtom};
pub use rewrite::rewrite_query;

/// Result type for QL operations.
pub type Result<T> = std::result::Result<T, Error>;

/// QL query errors.
#[derive(Debug, Error)]
pub enum Error {
    /// Unknown class in query.
    #[error("unknown class in query: {0}")]
    UnknownClass(String),
    /// Parse error.
    #[error("query parse error: {0}")]
    Parse(String),
    /// Query engine error.
    #[error(transparent)]
    Query(#[from] hierarchy::Error),
}

/// Answer a conjunctive query over a classified ontology.
pub fn answer_query<'a>(
    ontology: &'a Ontology,
    taxonomy: &'a Taxonomy,
    query: &ConjunctiveQuery,
) -> Result<Vec<QueryAnswer>> {
    let engine = hierarchy::TaxonomyHierarchy::new(ontology, taxonomy);
    query::evaluate(&engine, ontology, query)
}