offapi/com/sun/star/rdf/XQuerySelectResult.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 #ifndef __com_sun_star_rdf_XQuerySelectResult_idl__
  21 #define __com_sun_star_rdf_XQuerySelectResult_idl__
  22
  23 #include <com/sun/star/container/XEnumeration.idl>
  24
  25
  26
  27 module com {   module sun {   module star {   module rdf {
  28
  29 /** represents the result of a SPARQL "SELECT" query.
  30
  31     <p>
  32     The result consists of:
  33     <ol>
  34     <li>a list of query variable names (column labels)</li>
  35     <li>an iterator of query results (rows),
  36         each being a list of bindings for the above variables</li>
  37     </ol>
  38     Note that each query result retrieved via
  39     com::sun::star::container::XEnumeration::nextElement()
  40     has the type XNode[],
  41     the length of the sequence being the same as the number of query variables.
  42     </p>
  43
  44     @since OOo 3.0
  45
  46     @see XRepository::querySelect
  47     @see XNode
  48  */
  49 interface XQuerySelectResult : com::sun::star::container::XEnumeration
  50 {
  51     /** get the names of the query variables.
  52
  53         <p>
  54         </p>
  55      */
  56      sequence<string> getBindingNames();
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */