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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XDocumentRepository.idl,v $
* $Revision: 1.2 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_rdf_XDocumentRepository_idl__
#define __com_sun_star_rdf_XDocumentRepository_idl__
#ifndef __com_sun_star_text_XTextRange_idl__
#include <com/sun/star/text/XTextRange.idl>
#endif
#ifndef __com_sun_star_rdf_XMetadatable_idl__
#include <com/sun/star/rdf/XMetadatable.idl>
#endif
#ifndef __com_sun_star_rdf_XRepository_idl__
#include <com/sun/star/rdf/XRepository.idl>
#endif
//=============================================================================
module com { module sun { module star { module rdf {
//=============================================================================
/** extends <type>XRepository</type> with document-specific functionality.
<p>
This subclass of <type>XRepository</type> provides some methods which
only make sense for repositories that are attached to a document.
For example, the methods allow for manipulating in-content metadata,
which is stored as RDFa.
</p>
@since OOo 3.0
@see XRepositorySupplier
@see XDocumentMetadataAccess
*/
interface XDocumentRepository : XRepository
{
//-------------------------------------------------------------------------
/** update the RDFa statement(s) that correspond to an ODF element in the
repository.
<p>
This method will do the following steps:
<ol>
<li>Remove all RDFa statements that involve the Object parameter from
the repository</li>
<li>If the RDFaContent parameter is the empty <atom>string</atom>,
add the following RDF statement to an unspecified named graph:
<ul>
<li><code>Subject Predicate XLiteral(Object->getText())</code></li>
</ul>
</li>
<li>If the RDFaContent parameter is not the empty <atom>string</atom>,
add the following RDF statements to an unspecified named graph:
<ul>
<li>
<code>Subject Predicate XLiteral(RDFaContent^^RDFaDatatype)</code>
</li>
<li>
<code>Subject rdfs:label XLiteral(Object->getText())</code></li>
</ul>
</li>
</ol>
</p>
<p>
RDFa statements are handled specially because they are not logically
part of any named graph in the repository.
Also, they have rather unusual semantics.
Also, just using <method>XNamedGraph::addStatement</method>
for this would be ambiguous:
if the object is a XMetadatable, do we insert the object itself (URI)
or its literal content (RDFa)?
</p>
//FIXME: updates???
@param Subject
the subject of the RDF triple.
@param Predicate
the predicate of the RDF triple.
@param Object
the object of the RDF triple is the text content of this parameter.
@param RDFaContent
the <code>rdfa:content</code> attribute (may be the empty
<atom>string</atom>).
@param RDFaDatatype
the <code>rdfa:datatype</code> attribute (may be <NULL/>)
@throws com::sun::star::lang::IllegalArgumentException
if any parameter is <NULL/>,
or Object is of a type that can not have RDFa metadata attached.
@throws RepositoryException
if an error occurs when accessing the repository.
*/
void setStatementRDFa(
[in] XURI Subject,
[in] XURI Predicate,
[in] com::sun::star::text::XTextRange Object,
[in] string RDFaContent,
[in] XURI RDFaDatatype)
raises( com::sun::star::lang::IllegalArgumentException,
RepositoryException );
//-------------------------------------------------------------------------
/** remove the RDFa statement(s) that correspond to an ODF element from the
repository.
<p>
RDFa statements are handled specially because they are not logically
part of any graph.
</p>
@param Object
the element whose RDFa statement(s) should be removed
@throws com::sun::star::lang::IllegalArgumentException
if the given Element is <NULL/>, or of a type that can not have
RDFa metadata attached.
@throws RepositoryException
if an error occurs when accessing the repository.
*/
void removeStatementRDFa([in] com::sun::star::text::XTextRange Object)
raises( com::sun::star::lang::IllegalArgumentException,
RepositoryException );
//-------------------------------------------------------------------------
/** find the RDFa statement(s) associated with an ODF element.
@param Element
the ODF element for which RDFa statements should be found
@returns
<ul>
<li>if the element has no RDFa meta-data attributes:
the empty sequence.</li>
<li>if the element has RDFa meta-data attributes,
and no <code>rdfa:content</code> attached:
a sequence with a single element: the RDFa-statement</li>
<li>if the element has RDFa meta-data attributes,
and also <code>rdfa:content</code> attached:
a sequence with 2 elements: first the RDFa-statement,
then the RDFa-labels-statement</li>
</ul>
@throws com::sun::star::lang::IllegalArgumentException
if the given Element is <NULL/>, or of a type that can not have
RDFa metadata attached.
@throws RepositoryException
if an error occurs when accessing the repository.
@see Statement
*/
sequence<Statement> getStatementRDFa([in] XMetadatable Element)
raises( com::sun::star::lang::IllegalArgumentException,
RepositoryException );
//-------------------------------------------------------------------------
/** gets matching RDFa statements from the repository.
<p>
This method exists because RDFa statements are not part of any named
graph, and thus they cannot be enumerated with
<method>XNamedGraph::getStatements</method>.
</p>
<p>
Any parameter may be <NULL/>, which acts as a wildcard.
For example, to get all statements about myURI:
<code>getStatementsRDFa(myURI, null, null)</code>
</p>
@param Subject
the subject of the RDF triple.
@param Predicate
the predicate of the RDF triple.
@param Object
the object of the RDF triple.
@returns
an iterator over all RDFa statements in the repository that match
the parameters, represented as an
enumeration of <type>Statement</type>
@throws RepositoryException
if an error occurs when accessing the repository.
@see Statement
@see XRepository::getStatements
@see XNamedGraph::getStatements
*/
com::sun::star::container::XEnumeration/*<Statement>*/ getStatementsRDFa(
[in] XResource Subject,
[in] XResource Predicate,
[in] XNode Object)
raises( RepositoryException );
};
//=============================================================================
}; }; }; };
#endif
|
