offapi/com/sun/star/rdf/XNamedGraph.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {   module sun {   module star {   module rdf {
  23
  24 /** represents an RDF named graph that is stored in an RDF Repository.
  25
  26     <p>
  27     Note that this interface inherits from XResource: the
  28     name of the graph is the string value of the RDF node.
  29     This is so that you can easily make RDF statements about named graphs.
  30     </p>
  31
  32     <p>
  33     Note that instances may be destroyed via
  34     XRepository::destroyGraph().
  35     If a graph is destroyed, subsequent calls to addStatement(),
  36     removeStatements() will fail with an
  37     com::sun::star::container::NoSuchElementException.
  38     </p>
  39
  40     @since OOo 3.2
  41
  42     @see XRepository
  43  */
  44 interface XNamedGraph : XURI
  45 {
  46
  47     /** returns the name of the graph.
  48
  49         <p>
  50         The name is unique within the repository.
  51         </p>
  52
  53         @returns
  54             the name of the graph
  55      */
  56     XURI getName();
  57
  58     /** removes all statements from the graph.
  59
  60         @throws com::sun::star::container::NoSuchElementException
  61             if this graph does not exist in the repository any more
  62
  63         @throws RepositoryException
  64             if an error occurs when accessing the repository.
  65      */
  66     void clear()
  67         raises( com::sun::star::container::NoSuchElementException,
  68                 RepositoryException );
  69
  70     /** adds a RDF statement to the graph.
  71
  72         <p>
  73         Note that the ODF elements that can have metadata attached all
  74         implement the interface XMetadatable, which inherits
  75         from XResource, meaning that you can simply pass them
  76         in as arguments here, and it will magically work.
  77         </p>
  78
  79         @param Subject
  80             the subject of the RDF triple.
  81
  82         @param Predicate
  83             the predicate of the RDF triple.
  84
  85         @param Object
  86             the object of the RDF triple.
  87
  88         @throws com::sun::star::lang::IllegalArgumentException
  89             if any parameter is `NULL`
  90
  91         @throws com::sun::star::container::NoSuchElementException
  92             if this graph does not exist in the repository any more
  93
  94         @throws RepositoryException
  95             if an error occurs when accessing the repository.
  96      */
  97     void addStatement([in] XResource Subject,
  98             [in] XURI Predicate,
  99             [in] XNode Object)
 100         raises( com::sun::star::lang::IllegalArgumentException,
 101                 com::sun::star::container::NoSuchElementException,
 102                 RepositoryException );
 103
 104     /** removes matching RDF statements from the graph.
 105
 106         <p>
 107         Note that the ODF elements that can have metadata attached all
 108         implement the interface XMetadatable, which inherits
 109         from XResource, meaning that you can simply pass them
 110         in as arguments here, and it will magically work.
 111         </p>
 112
 113         <p>
 114         Any parameter may be `NULL`, which acts as a wildcard.
 115         For example, to remove all statements about myURI:
 116         <code>removeStatement(myURI, null, null)</code>
 117         </p>
 118
 119         @param Subject
 120             the subject of the RDF triple.
 121
 122         @param Predicate
 123             the predicate of the RDF triple.
 124
 125         @param Object
 126             the object of the RDF triple.
 127
 128         @throws com::sun::star::container::NoSuchElementException
 129             if this graph does not exist in the repository any more
 130
 131         @throws RepositoryException
 132             if an error occurs when accessing the repository.
 133      */
 134     void removeStatements([in] XResource Subject,
 135             [in] XURI Predicate,
 136             [in] XNode Object)
 137         raises( com::sun::star::container::NoSuchElementException,
 138                 RepositoryException );
 139
 140     /** gets matching RDF statements from a graph.
 141
 142         <p>
 143         Note that the ODF elements that can have metadata attached all
 144         implement the interface XMetadatable, which inherits
 145         from XResource, meaning that you can simply pass them
 146         in as arguments here, and it will magically work.
 147         </p>
 148
 149         <p>
 150         Any parameter may be `NULL`, which acts as a wildcard.
 151         For example, to get all statements about myURI:
 152         <code>getStatements(myURI, null, null)</code>
 153         </p>
 154
 155         @param Subject
 156             the subject of the RDF triple.
 157
 158         @param Predicate
 159             the predicate of the RDF triple.
 160
 161         @param Object
 162             the object of the RDF triple.
 163
 164         @returns
 165             an iterator over all RDF statements in the graph that match
 166             the parameters, represented as an
 167             enumeration of Statement
 168
 169         @throws com::sun::star::container::NoSuchElementException
 170             if this graph does not exist in the repository any more
 171
 172         @throws RepositoryException
 173             if an error occurs when accessing the repository.
 174
 175         @see Statement
 176      */
 177     com::sun::star::container::XEnumeration/*<Statement>*/ getStatements(
 178             [in] XResource Subject,
 179             [in] XURI Predicate,
 180             [in] XNode Object)
 181         raises( com::sun::star::container::NoSuchElementException,
 182                 RepositoryException );
 183
 184 //FIXME reification: addReifiedStatement(Statement)...
 185 };
 186
 187
 188 }; }; }; };
 189
 190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */