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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_rdf_XQuerySelectResult_idl__
  29 #define __com_sun_star_rdf_XQuerySelectResult_idl__
  30
  31 #ifndef __com_sun_star_container_XEnumeration_idl__
  32 #include <com/sun/star/container/XEnumeration.idl>
  33 #endif
  34
  35
  36 //=============================================================================
  37
  38 module com {   module sun {   module star {   module rdf {
  39
  40 //=============================================================================
  41 /** represents the result of a SPARQL "SELECT" query.
  42
  43     <p>
  44     The result consists of:
  45     <ol>
  46     <li>a list of query variable names (column labels)</li>
  47     <li>an iterator of query results (rows),
  48         each being a list of bindings for the above variables</li>
  49     </ol>
  50     Note that each query result retrieved via
  51     <member scope="com::sun::star::container">XEnumeration::nextElement</member>
  52     has the type <type dim="[]">XNode</type>,
  53     the length of the sequence being the same as the number of query variables.
  54     </p>
  55
  56     @since OOo 3.0
  57
  58     @see XRepository::querySelect
  59     @see XNode
  60  */
  61 interface XQuerySelectResult : com::sun::star::container::XEnumeration
  62 {
  63     //-------------------------------------------------------------------------
  64     /** get the names of the query variables.
  65
  66         <p>
  67         </p>
  68      */
  69      sequence<string> getBindingNames();
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif