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

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