graph.h

Go to the documentation of this file.

#ifndef VOLK_GRAPH_H
#define VOLK_GRAPH_H
 
#include "volksdata/store.h"
#include "volksdata/term.h"
 


typedef struct graph_t VOLK_Graph;

typedef struct graph_iter_t VOLK_GraphIterator;
 

VOLK_Graph *
VOLK_graph_new (VOLK_Store *store, const char *uri_str);
 

inline VOLK_Graph *
VOLK_graph_new_ns (VOLK_Store *store, const char *ns_str) {
    if (!ns_str) {
        log_error ("Cannot pass NULL as namespace-prefixed URI.");
        return NULL;
    }
    char *uri_str;
    RCNL (VOLK_nsmap_normalize_uri (ns_str, &uri_str));
 
    VOLK_Graph *gr = VOLK_graph_new (store, uri_str);
    free (uri_str);
 
    return gr;
};
 

VOLK_Graph *
VOLK_graph_get_txn (
        void *txn, VOLK_Store *store, const VOLK_Term *uri, size_t *ct);

#define VOLK_graph_get(...) VOLK_graph_get_txn (NULL, __VA_ARGS__)
 

VOLK_rc
VOLK_graph_copy_contents_txn (
        void *txn, const VOLK_Graph *src, VOLK_Graph *dest,
        const VOLK_Term *s, const VOLK_Term *p, const VOLK_Term *o);
 
/* @brief Copy all triples from a graph (non-transactional).
 *
 * This is a shortcut for #VOLK_graph_copy_contents_txn(). If you need to
 * specify a transaction handle for the copy, use that.
 *
 * @param[in] src Source graph.
 *
 * @param[in] dest Destination graph.
 *
 * @param[in] s, p, o Terms to look up for filtering. Any and all terms can be
 * NULL, which indicate unbound terms.
 *
 * @return VOLK_OK on success; VOLK_NOACTION if no triples were copied; <0
 *  if an error occurred.
 */
#define VOLK_graph_copy_contents(...) \
    VOLK_graph_copy_contents_txn (NULL, __VA_ARGS__)
 
 
/* @brief Copy all triples from a graph.
 *
 * This is a shortcut for #VOLK_graph_copy_contents_txn(). If you need to
 * specify a transaction handle and/or a filter for the copy, use that.
 *
 * @param[in] src Source graph.
 *
 * @param[in] dest Destination graph.
 *
 * @return VOLK_OK on success; VOLK_NOACTION if no triples were copied; <0
 *  if an error occurred.
 */
#define VOLK_graph_copy(src, dest) \
    VOLK_graph_copy_contents_txn (NULL, src, dest, NULL, NULL, NULL)
 

VOLK_rc
VOLK_graph_bool_op_txn (
        void *txn, const VOLK_bool_op op,
        const VOLK_Graph *gr1, const VOLK_Graph *gr2, VOLK_Graph *res);

#define VOLK_graph_bool_op(...) VOLK_graph_bool_op_txn (NULL, __VA_ARGS__)
 

void
VOLK_graph_free (VOLK_Graph *gr);
 

bool
VOLK_graph_equals_txn (void *txn, const VOLK_Graph *gr1, const VOLK_Graph *gr2);

#define VOLK_graph_equals(...) VOLK_graph_equals_txn (NULL, __VA_ARGS__)
 

const VOLK_Term *
VOLK_graph_uri (const VOLK_Graph *gr);
 

VOLK_Store *
VOLK_graph_store (const VOLK_Graph *gr);
 

VOLK_rc
VOLK_graph_set_uri_txn (void *txn, VOLK_Graph *gr, const char *uri_str);

#define VOLK_graph_set_uri(...) VOLK_graph_set_uri_txn (NULL, __VA_ARGS__)
 

size_t
VOLK_graph_size_txn (void *txn, const VOLK_Graph *gr);

#define VOLK_graph_size(...) VOLK_graph_size_txn (NULL, __VA_ARGS__)
 

bool
VOLK_graph_contains_txn (
        void *txn, const VOLK_Graph *gr, const VOLK_Triple *spo);

#define VOLK_graph_contains(...) VOLK_graph_contains_txn (NULL, __VA_ARGS__)
 

VOLK_GraphIterator *
VOLK_graph_add_init_txn (void *txn, VOLK_Graph *gr);

#define VOLK_graph_add_init(...) VOLK_graph_add_init_txn (NULL, __VA_ARGS__)
 

VOLK_rc
VOLK_graph_add_iter (VOLK_GraphIterator *it, const VOLK_Triple *spo);
 

VOLK_rc
VOLK_graph_add_txn (
        void *txn, VOLK_Graph *gr, VOLK_Triple *const *trp, size_t *ct);

#define VOLK_graph_add(...) VOLK_graph_add_txn (NULL, __VA_ARGS__)
 

VOLK_rc
VOLK_graph_remove_txn (
        void *txn, VOLK_Graph *gr, const VOLK_Term *s, const VOLK_Term *p,
        const VOLK_Term *o, size_t *ct);

#define VOLK_graph_remove(...) VOLK_graph_remove_txn (NULL, __VA_ARGS__)
 

VOLK_GraphIterator *
VOLK_graph_lookup_txn (void *txn, const VOLK_Graph *gr, const VOLK_Term *s,
        const VOLK_Term *p, const VOLK_Term *o, size_t *ct);

#define VOLK_graph_lookup(...) VOLK_graph_lookup_txn (NULL, __VA_ARGS__)
 

VOLK_rc
VOLK_graph_iter_next (VOLK_GraphIterator *it, VOLK_Triple **spo);
 

const VOLK_Graph *
VOLK_graph_iter_graph (VOLK_GraphIterator *it);
 

void
VOLK_graph_iter_free (VOLK_GraphIterator *it);
 

void
VOLK_graph_print (const VOLK_Graph *gr);
 

VOLK_LinkMap *
VOLK_graph_connections_txn (
    void *txn, const VOLK_Graph *gr, const VOLK_Term *t,
    const VOLK_LinkType type
);

#define VOLK_graph_connections(...) \
    VOLK_graph_connections_txn (NULL, __VA_ARGS__)
 

VOLK_TermSet *
VOLK_graph_term_set_txn (
        void *txn, const VOLK_Graph *gr,
        const VOLK_Term *t1, const VOLK_TriplePos t1_pos,
        const VOLK_Term *t2, const VOLK_TriplePos t2_pos);

#define VOLK_graph_term_set(...) VOLK_graph_term_set_txn (NULL, __VA_ARGS__)
 

VOLK_TermSet *
VOLK_graph_unique_terms_txn (
        void *txn, const VOLK_Graph *gr, VOLK_TriplePos pos);

#define VOLK_graph_unique_terms(...) \
    VOLK_graph_unique_terms_txn (NULL, __VA_ARGS__)
 

size_t
VOLK_graph_add_link_map ( VOLK_GraphIterator *it, VOLK_LinkMap *lm);
 

VOLK_Term *
VOLK_bnode_add_collection (VOLK_GraphIterator *it, VOLK_TermSet *ts);

 
#endif  // VOLK_GRAPH_H