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