File: rdf_model.h

package info (click to toggle)
redland 1.0.7-1
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 27,592 kB
  • ctags: 12,328
  • sloc: ansic: 79,017; xml: 25,115; sh: 10,162; yacc: 5,985; lex: 3,682; makefile: 3,260; perl: 2,814; cpp: 59
file content (225 lines) | stat: -rw-r--r-- 7,897 bytes parent folder | download
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/* -*- Mode: c; c-basic-offset: 2 -*-
 *
 * rdf_model.h - RDF Model definition
 *
 * $Id: rdf_model.h 11702 2006-12-05 04:16:55Z dajobe $
 *
 * Copyright (C) 2000-2006, David Beckett http://purl.org/net/dajobe/
 * Copyright (C) 2000-2005, University of Bristol, UK http://www.bristol.ac.uk/
 * 
 * This package is Free Software and part of Redland http://librdf.org/
 * 
 * It is licensed under the following three licenses as alternatives:
 *   1. GNU Lesser General Public License (LGPL) V2.1 or any newer version
 *   2. GNU General Public License (GPL) V2 or any newer version
 *   3. Apache License, V2.0 or any newer version
 * 
 * You may not use this file except in compliance with at least one of
 * the above three licenses.
 * 
 * See LICENSE.html or LICENSE.txt at the top of this package for the
 * complete terms and further detail along with the license texts for
 * the licenses in COPYING.LIB, COPYING and LICENSE-2.0.txt respectively.
 * 
 * 
 */



#ifndef LIBRDF_MODEL_H
#define LIBRDF_MODEL_H

#ifndef LIBRDF_OBJC_FRAMEWORK
#include <rdf_uri.h>
#else
#include <Redland/rdf_uri.h>
#endif

#ifdef LIBRDF_INTERNAL
#include <rdf_model_internal.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* class methods */

REDLAND_API
int librdf_model_enumerate(librdf_world* world, const unsigned int counter, const char **name, const char **label);

/* constructors */

/* Create a new Model */
REDLAND_API
librdf_model* librdf_new_model(librdf_world *world, librdf_storage *storage, const char* options_string);
REDLAND_API
librdf_model* librdf_new_model_with_options(librdf_world *world, librdf_storage *storage, librdf_hash* options);

/* Create a new Model from an existing Model - CLONE */
REDLAND_API
librdf_model* librdf_new_model_from_model(librdf_model* model);

/* destructor */
REDLAND_API
void librdf_free_model(librdf_model *model);


/* functions / methods */
REDLAND_API
int librdf_model_size(librdf_model* model);

/* add statements */
REDLAND_API
int librdf_model_add(librdf_model* model, librdf_node* subject, librdf_node* predicate, librdf_node* object);
REDLAND_API
int 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);
REDLAND_API
int 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);
REDLAND_API
int librdf_model_add_statement(librdf_model* model, librdf_statement* statement);
REDLAND_API
int librdf_model_add_statements(librdf_model* model, librdf_stream* statement_stream);

/* remove statements */
REDLAND_API
int librdf_model_remove_statement(librdf_model* model, librdf_statement* statement);

/* containment */
/* check for exact statement match */
REDLAND_API
int librdf_model_contains_statement(librdf_model* model, librdf_statement* statement);
/* check for [node, property, ?] */
REDLAND_API
int librdf_model_has_arc_in(librdf_model *model, librdf_node *node, librdf_node *property);
/* check for [?, property, node] */
REDLAND_API
int librdf_model_has_arc_out(librdf_model *model, librdf_node *node, librdf_node *property);


/* list the entire model as a stream of statements */
REDLAND_API
librdf_stream* librdf_model_as_stream(librdf_model* model);
/* DEPRECATED serialise the entire model */
REDLAND_API REDLAND_DEPRECATED
librdf_stream* librdf_model_serialise(librdf_model* model);

/* queries */

REDLAND_API
librdf_stream* librdf_model_find_statements(librdf_model* model, librdf_statement* statement);

/**
 * LIBRDF_MODEL_FIND_OPTION_MATCH_SUBSTRING_LITERAL:
 *
 * Model find statement option.
 *
 * If set, the find statement uses substring matching.
 */
#define LIBRDF_MODEL_FIND_OPTION_MATCH_SUBSTRING_LITERAL "http://feature.librdf.org/model-find-match-substring-literal"

REDLAND_API
librdf_stream* librdf_model_find_statements_with_options(librdf_model* model, librdf_statement* statement, librdf_node* context_node, librdf_hash* options);
REDLAND_API
librdf_iterator* librdf_model_get_sources(librdf_model *model, librdf_node *arc, librdf_node *target);
REDLAND_API
librdf_iterator* librdf_model_get_arcs(librdf_model *model, librdf_node *source, librdf_node *target);
REDLAND_API
librdf_iterator* librdf_model_get_targets(librdf_model *model, librdf_node *source, librdf_node *arc);
REDLAND_API
librdf_node* librdf_model_get_source(librdf_model *model, librdf_node *arc, librdf_node *target);
REDLAND_API
librdf_node* librdf_model_get_arc(librdf_model *model, librdf_node *source, librdf_node *target);
REDLAND_API
librdf_node* librdf_model_get_target(librdf_model *model, librdf_node *source, librdf_node *arc);

/* return list of properties to/from a node */
REDLAND_API
librdf_iterator* librdf_model_get_arcs_in(librdf_model *model, librdf_node *node);
REDLAND_API
librdf_iterator* librdf_model_get_arcs_out(librdf_model *model, librdf_node *node);



/* submodels */
REDLAND_API
int librdf_model_add_submodel(librdf_model* model, librdf_model* sub_model);
REDLAND_API
int librdf_model_remove_submodel(librdf_model* model, librdf_model* sub_model);


REDLAND_API
void librdf_model_print(librdf_model *model, FILE *fh);

/* statement contexts */
REDLAND_API
int librdf_model_context_add_statement(librdf_model* model, librdf_node* context, librdf_statement* statement);
REDLAND_API
int librdf_model_context_add_statements(librdf_model* model, librdf_node* context, librdf_stream* stream);
REDLAND_API
int librdf_model_context_remove_statement(librdf_model* model, librdf_node* context, librdf_statement* statement);
REDLAND_API
int librdf_model_context_remove_statements(librdf_model* model, librdf_node* context);
REDLAND_API
librdf_stream* librdf_model_context_as_stream(librdf_model* model, librdf_node* context);
REDLAND_API REDLAND_DEPRECATED
librdf_stream* librdf_model_context_serialize(librdf_model* model, librdf_node* context);
REDLAND_API
int librdf_model_contains_context(librdf_model* model, librdf_node* context);

/* query language */
REDLAND_API
librdf_query_results* librdf_model_query_execute(librdf_model* model, librdf_query* query);

REDLAND_API
int librdf_model_sync(librdf_model* model);

REDLAND_API
librdf_storage* librdf_model_get_storage(librdf_model *model);

REDLAND_API
int librdf_model_load(librdf_model* model, librdf_uri *uri, const char *name, const char *mime_type, librdf_uri *type_uri);
REDLAND_API
unsigned 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);
REDLAND_API
unsigned char* librdf_model_to_string(librdf_model* model, librdf_uri *uri, const char *name, const char *mime_type, librdf_uri *type_uri);

/* find statements in a given context */
REDLAND_API
librdf_stream* librdf_model_find_statements_in_context(librdf_model* model, librdf_statement* statement, librdf_node* context_node);

REDLAND_API
librdf_iterator* librdf_model_get_contexts(librdf_model* model);

REDLAND_API
int librdf_model_transaction_start(librdf_model* model);
REDLAND_API
int librdf_model_transaction_start_with_handle(librdf_model* model, void* handle);
REDLAND_API
int librdf_model_transaction_commit(librdf_model* model);
REDLAND_API
int librdf_model_transaction_rollback(librdf_model* model);
REDLAND_API
void* librdf_model_transaction_get_handle(librdf_model* model);


/**
 * LIBRDF_MODEL_FEATURE_CONTEXTS:
 *
 * Model feature contexts.
 *
 * If set, the model has redland contexts.
 */
#define LIBRDF_MODEL_FEATURE_CONTEXTS "http://feature.librdf.org/model-contexts"

/* features */
REDLAND_API
librdf_node* librdf_model_get_feature(librdf_model* model, librdf_uri* feature);
REDLAND_API
int librdf_model_set_feature(librdf_model* model, librdf_uri* feature, librdf_node* value);

#ifdef __cplusplus
}
#endif

#endif