autodoc/inc/ary/loc/loc_le.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: loc_le.hxx,v $
  10  * $Revision: 1.3 $
  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 ARY_LOC_LE_HXX
  32 #define ARY_LOC_LE_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include <ary/entity.hxx>
  37     // COMPONENTS
  38     // PARAMETERS
  39 #include <ary/loc/loc_types4loc.hxx>
  40 #include <ary/loc/loc_traits.hxx>
  41
  42
  43
  44 namespace ary
  45 {
  46 namespace loc
  47 {
  48
  49
  50 /** Base class for all file locations in the Autodoc repository.
  51 */
  52 class LocationEntity : public ::ary::Entity
  53 {
  54   public:
  55     typedef Le_Traits       traits_t;
  56
  57     virtual             ~LocationEntity() {}
  58
  59     Le_id               LeId() const;
  60     const String &      LocalName() const;
  61     Le_id               ParentDirectory() const;
  62
  63   private:
  64     virtual const String &
  65                         inq_LocalName() const = 0;
  66     virtual Le_id       inq_ParentDirectory() const = 0;
  67 };
  68
  69
  70
  71
  72 // IMPLEMENTATION
  73 inline Le_id
  74 LocationEntity::LeId() const
  75 {
  76     return TypedId<LocationEntity>(Id());
  77 }
  78
  79 inline const String &
  80 LocationEntity::LocalName() const
  81 {
  82     return inq_LocalName();
  83 }
  84
  85 inline Le_id
  86 LocationEntity::ParentDirectory() const
  87 {
  88     return inq_ParentDirectory();
  89 }
  90
  91
  92
  93
  94
  95 } // namespace loc
  96 } // namespace ary
  97 #endif