1/* -*- Mode: c; c-basic-offset: 2 -*-
2 *
3 * rdf_model.h - RDF Model definition
4 *
5 * Copyright (C) 2000-2008, David Beckett http://www.dajobe.org/
6 * Copyright (C) 2000-2005, University of Bristol, UK http://www.bristol.ac.uk/
7 *
8 * This package is Free Software and part of Redland http://librdf.org/
9 *
10 * It is licensed under the following three licenses as alternatives:
11 * 1. GNU Lesser General Public License (LGPL) V2.1 or any newer version
12 * 2. GNU General Public License (GPL) V2 or any newer version
13 * 3. Apache License, V2.0 or any newer version
14 *
15 * You may not use this file except in compliance with at least one of
16 * the above three licenses.
17 *
18 * See LICENSE.html or LICENSE.txt at the top of this package for the
19 * complete terms and further detail along with the license texts for
20 * the licenses in COPYING.LIB, COPYING and LICENSE-2.0.txt respectively.
21 *
22 *
23 */
24
25
26
27#ifndef LIBRDF_MODEL_H
28#define LIBRDF_MODEL_H
29
30#ifndef LIBRDF_OBJC_FRAMEWORK
31#include <rdf_uri.h>
32#else
33#include <Redland/rdf_uri.h>
34#endif
35
36#ifdef LIBRDF_INTERNAL
37#include <rdf_model_internal.h>
38#endif
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
44/* class methods */
45
46REDLAND_API
47int librdf_model_enumerate(librdf_world* world, const unsigned int counter, const char **name, const char **label);
48
49/* constructors */
50
51/* Create a new Model */
52REDLAND_API
53librdf_model* librdf_new_model(librdf_world *world, librdf_storage *storage, const char* options_string);
54REDLAND_API
55librdf_model* librdf_new_model_with_options(librdf_world *world, librdf_storage *storage, librdf_hash* options);
56
57/* Create a new Model from an existing Model - CLONE */
58REDLAND_API
59librdf_model* librdf_new_model_from_model(librdf_model* model);
60
61/* destructor */
62REDLAND_API
63void librdf_free_model(librdf_model *model);
64
65
66/* functions / methods */
67REDLAND_API
68int librdf_model_size(librdf_model* model);
69
70/* add statements */
71REDLAND_API
72int librdf_model_add(librdf_model* model, librdf_node* subject, librdf_node* predicate, librdf_node* object);
73REDLAND_API
74int librdf_model_add_string_literal_statement(librdf_model* model, librdf_node* subject, librdf_node* predicate, const unsigned char* literal, const char *xml_language, int is_wf_xml);
75REDLAND_API
76int librdf_model_add_typed_literal_statement(librdf_model* model, librdf_node* subject, librdf_node* predicate, const unsigned char* literal, const char *xml_language, librdf_uri *datatype_uri);
77REDLAND_API
78int librdf_model_add_statement(librdf_model* model, librdf_statement* statement);
79REDLAND_API
80int librdf_model_add_statements(librdf_model* model, librdf_stream* statement_stream);
81
82/* remove statements */
83REDLAND_API
84int librdf_model_remove_statement(librdf_model* model, librdf_statement* statement);
85
86/* containment */
87/* check for exact statement match */
88REDLAND_API
89int librdf_model_contains_statement(librdf_model* model, librdf_statement* statement);
90/* check for [node, property, ?] */
91REDLAND_API
92int librdf_model_has_arc_in(librdf_model *model, librdf_node *node, librdf_node *property);
93/* check for [?, property, node] */
94REDLAND_API
95int librdf_model_has_arc_out(librdf_model *model, librdf_node *node, librdf_node *property);
96
97
98/* list the entire model as a stream of statements */
99REDLAND_API
100librdf_stream* librdf_model_as_stream(librdf_model* model);
101/* DEPRECATED serialise the entire model */
102REDLAND_API REDLAND_DEPRECATED
103librdf_stream* librdf_model_serialise(librdf_model* model);
104
105/* queries */
106
107REDLAND_API
108librdf_stream* librdf_model_find_statements(librdf_model* model, librdf_statement* statement);
109
110/**
111 * LIBRDF_MODEL_FIND_OPTION_MATCH_SUBSTRING_LITERAL:
112 *
113 * Model find statement option.
114 *
115 * If set, the find statement uses substring matching.
116 */
117#define LIBRDF_MODEL_FIND_OPTION_MATCH_SUBSTRING_LITERAL "http://feature.librdf.org/model-find-match-substring-literal"
118
119REDLAND_API
120librdf_stream* librdf_model_find_statements_with_options(librdf_model* model, librdf_statement* statement, librdf_node* context_node, librdf_hash* options);
121REDLAND_API
122librdf_iterator* librdf_model_get_sources(librdf_model *model, librdf_node *arc, librdf_node *target);
123REDLAND_API
124librdf_iterator* librdf_model_get_arcs(librdf_model *model, librdf_node *source, librdf_node *target);
125REDLAND_API
126librdf_iterator* librdf_model_get_targets(librdf_model *model, librdf_node *source, librdf_node *arc);
127REDLAND_API
128librdf_node* librdf_model_get_source(librdf_model *model, librdf_node *arc, librdf_node *target);
129REDLAND_API
130librdf_node* librdf_model_get_arc(librdf_model *model, librdf_node *source, librdf_node *target);
131REDLAND_API
132librdf_node* librdf_model_get_target(librdf_model *model, librdf_node *source, librdf_node *arc);
133
134/* return list of properties to/from a node */
135REDLAND_API
136librdf_iterator* librdf_model_get_arcs_in(librdf_model *model, librdf_node *node);
137REDLAND_API
138librdf_iterator* librdf_model_get_arcs_out(librdf_model *model, librdf_node *node);
139
140
141
142/* submodels */
143REDLAND_API
144int librdf_model_add_submodel(librdf_model* model, librdf_model* sub_model);
145REDLAND_API
146int librdf_model_remove_submodel(librdf_model* model, librdf_model* sub_model);
147
148
149REDLAND_API REDLAND_DEPRECATED
150void librdf_model_print(librdf_model *model, FILE *fh);
151REDLAND_API
152int librdf_model_write(librdf_model *model, raptor_iostream* iostr);
153
154/* statement contexts */
155REDLAND_API
156int librdf_model_context_add_statement(librdf_model* model, librdf_node* context, librdf_statement* statement);
157REDLAND_API
158int librdf_model_context_add_statements(librdf_model* model, librdf_node* context, librdf_stream* stream);
159REDLAND_API
160int librdf_model_context_remove_statement(librdf_model* model, librdf_node* context, librdf_statement* statement);
161REDLAND_API
162int librdf_model_context_remove_statements(librdf_model* model, librdf_node* context);
163REDLAND_API
164librdf_stream* librdf_model_context_as_stream(librdf_model* model, librdf_node* context);
165REDLAND_API REDLAND_DEPRECATED
166librdf_stream* librdf_model_context_serialize(librdf_model* model, librdf_node* context);
167REDLAND_API
168int librdf_model_contains_context(librdf_model* model, librdf_node* context);
169REDLAND_API
170int librdf_model_supports_contexts(librdf_model* model);
171
172/* query language */
173REDLAND_API
174librdf_query_results* librdf_model_query_execute(librdf_model* model, librdf_query* query);
175
176REDLAND_API
177int librdf_model_sync(librdf_model* model);
178
179REDLAND_API
180librdf_storage* librdf_model_get_storage(librdf_model *model);
181
182REDLAND_API
183int librdf_model_load(librdf_model* model, librdf_uri *uri, const char *name, const char *mime_type, librdf_uri *type_uri);
184REDLAND_API
185unsigned char* librdf_model_to_counted_string(librdf_model* model, librdf_uri *uri, const char *name, const char *mime_type, librdf_uri *type_uri, size_t* string_length_p);
186REDLAND_API
187unsigned char* librdf_model_to_string(librdf_model* model, librdf_uri *uri, const char *name, const char *mime_type, librdf_uri *type_uri);
188
189/* find statements in a given context */
190REDLAND_API
191librdf_stream* librdf_model_find_statements_in_context(librdf_model* model, librdf_statement* statement, librdf_node* context_node);
192
193REDLAND_API
194librdf_iterator* librdf_model_get_contexts(librdf_model* model);
195
196REDLAND_API
197int librdf_model_transaction_start(librdf_model* model);
198REDLAND_API
199int librdf_model_transaction_start_with_handle(librdf_model* model, void* handle);
200REDLAND_API
201int librdf_model_transaction_commit(librdf_model* model);
202REDLAND_API
203int librdf_model_transaction_rollback(librdf_model* model);
204REDLAND_API
205void* librdf_model_transaction_get_handle(librdf_model* model);
206
207
208/**
209 * LIBRDF_MODEL_FEATURE_CONTEXTS:
210 *
211 * Model feature contexts.
212 *
213 * If set, the model has redland contexts.
214 */
215#define LIBRDF_MODEL_FEATURE_CONTEXTS "http://feature.librdf.org/model-contexts"
216
217/* features */
218REDLAND_API
219librdf_node* librdf_model_get_feature(librdf_model* model, librdf_uri* feature);
220REDLAND_API
221int librdf_model_set_feature(librdf_model* model, librdf_uri* feature, librdf_node* value);
222
223#ifdef __cplusplus
224}
225#endif
226
227#endif
228