offapi/com/sun/star/rdf/XURI.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_XURI_idl__
  29 #define __com_sun_star_rdf_XURI_idl__
  30
  31 #ifndef __com_sun_star_rdf_XResource_idl__
  32 #include <com/sun/star/rdf/XResource.idl>
  33 #endif
  34
  35
  36 //=============================================================================
  37
  38 module com {   module sun {   module star {   module rdf {
  39
  40 //=============================================================================
  41 /** represents an URI node that may occur in a RDF graph.
  42
  43     <p>
  44     Note that this is actually an IRI, but the RDF literature speaks of URIs
  45     only, so we chose to use established terminology.
  46     </p>
  47
  48     <p>
  49     The URI is split into a Namespace and a LocalName,
  50     using the first applicable of the following criteria:
  51     <ol>
  52     <li>after the first occurrence of the fragment separator: "#"</li>
  53     <li>after the last occurrence of the path separator: "/"</li>
  54     <li>after the last occurrence of the scheme separator: ":"</li>
  55     </ol>
  56     An URI without a ":" is invalid.
  57     This implies that the Namespace part of an URI must not be empty, while
  58     the LocalName part may be empty.
  59     </p>
  60
  61     @since OOo 3.0
  62
  63     @see XRepository
  64  */
  65 interface XURI : XResource
  66 {
  67     /// prefix
  68     [readonly, attribute] string Namespace;
  69     /// suffix
  70     [readonly, attribute] string LocalName;
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif