ucb/source/ucp/hierarchy/hierarchyuri.hxx

   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: hierarchyuri.hxx,v $
  10  * $Revision: 1.5 $
  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 _HIERARCHYURI_HXX
  32 #define _HIERARCHYURI_HXX
  33
  34 #include <rtl/ustring.hxx>
  35
  36 namespace hierarchy_ucp {
  37
  38 //=========================================================================
  39
  40 #define HIERARCHY_URL_SCHEME          "vnd.sun.star.hier"
  41 #define HIERARCHY_URL_SCHEME_LENGTH   17
  42
  43 //=========================================================================
  44
  45 class HierarchyUri
  46 {
  47     mutable ::rtl::OUString m_aUri;
  48     mutable ::rtl::OUString m_aParentUri;
  49     mutable ::rtl::OUString m_aService;
  50     mutable ::rtl::OUString m_aPath;
  51     mutable ::rtl::OUString m_aName;
  52     mutable bool            m_bValid;
  53
  54 private:
  55     void init() const;
  56
  57 public:
  58     HierarchyUri() : m_bValid( false ) {}
  59     HierarchyUri( const ::rtl::OUString & rUri )
  60     : m_aUri( rUri ), m_bValid( false ) {}
  61
  62     sal_Bool isValid() const
  63     { init(); return m_bValid; }
  64
  65     const ::rtl::OUString & getUri() const
  66     { init(); return m_aUri; }
  67
  68     void setUri( const ::rtl::OUString & rUri )
  69     { m_aPath = ::rtl::OUString(); m_aUri = rUri; m_bValid = false; }
  70
  71     const ::rtl::OUString & getParentUri() const
  72     { init(); return m_aParentUri; }
  73
  74     const ::rtl::OUString & getService() const
  75     { init(); return m_aService; }
  76
  77     const ::rtl::OUString & getPath() const
  78     { init(); return m_aPath; }
  79
  80     const ::rtl::OUString & getName() const
  81     { init(); return m_aName; }
  82
  83     inline sal_Bool isRootFolder() const;
  84 };
  85
  86 inline sal_Bool HierarchyUri::isRootFolder() const
  87 {
  88     init();
  89     return ( ( m_aPath.getLength() == 1 ) &&
  90              ( m_aPath.getStr()[ 0 ] == sal_Unicode( '/' ) ) );
  91 }
  92 }
  93
  94 #endif