xref: /aoo42x/main/store/source/storcach.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _STORE_STORCACH_HXX
29*cdf0e10cSrcweir #define _STORE_STORCACH_HXX "$Revision: 1.6.8.2 $"
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "sal/types.h"
32*cdf0e10cSrcweir #include "rtl/ref.hxx"
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include "store/types.h"
35*cdf0e10cSrcweir #include "storbase.hxx"
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir namespace store
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir /*========================================================================
41*cdf0e10cSrcweir  *
42*cdf0e10cSrcweir  * PageCache interface.
43*cdf0e10cSrcweir  *
44*cdf0e10cSrcweir  *======================================================================*/
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir class PageCache : public rtl::IReference
47*cdf0e10cSrcweir {
48*cdf0e10cSrcweir public:
49*cdf0e10cSrcweir 	/** load.
50*cdf0e10cSrcweir      */
51*cdf0e10cSrcweir     storeError lookupPageAt (
52*cdf0e10cSrcweir         PageHolder & rxPage,
53*cdf0e10cSrcweir         sal_uInt32   nOffset);
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir 	/** insert.
56*cdf0e10cSrcweir      */
57*cdf0e10cSrcweir     storeError insertPageAt (
58*cdf0e10cSrcweir         PageHolder const & rxPage,
59*cdf0e10cSrcweir         sal_uInt32         nOffset);
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir 	/** update, or insert.
62*cdf0e10cSrcweir      */
63*cdf0e10cSrcweir     storeError updatePageAt (
64*cdf0e10cSrcweir         PageHolder const & rxPage,
65*cdf0e10cSrcweir         sal_uInt32         nOffset);
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir 	/** remove (invalidate).
68*cdf0e10cSrcweir      */
69*cdf0e10cSrcweir     storeError removePageAt (
70*cdf0e10cSrcweir         sal_uInt32 nOffset);
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir private:
73*cdf0e10cSrcweir     /** Implementation (abstract).
74*cdf0e10cSrcweir      */
75*cdf0e10cSrcweir     virtual storeError lookupPageAt_Impl (
76*cdf0e10cSrcweir         PageHolder & rxPage,
77*cdf0e10cSrcweir         sal_uInt32   nOffset) = 0;
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir     virtual storeError insertPageAt_Impl (
80*cdf0e10cSrcweir         PageHolder const & rxPage,
81*cdf0e10cSrcweir         sal_uInt32         nOffset) = 0;
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir     virtual storeError updatePageAt_Impl (
84*cdf0e10cSrcweir         PageHolder const & rxPage,
85*cdf0e10cSrcweir         sal_uInt32         nOffset) = 0;
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir     virtual storeError removePageAt_Impl (
88*cdf0e10cSrcweir         sal_uInt32 nOffset) = 0;
89*cdf0e10cSrcweir };
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir /*========================================================================
92*cdf0e10cSrcweir  *
93*cdf0e10cSrcweir  * PageCache factory.
94*cdf0e10cSrcweir  *
95*cdf0e10cSrcweir  *======================================================================*/
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir storeError
98*cdf0e10cSrcweir PageCache_createInstance (
99*cdf0e10cSrcweir     rtl::Reference< store::PageCache > & rxCache,
100*cdf0e10cSrcweir     sal_uInt16                           nPageSize
101*cdf0e10cSrcweir );
102*cdf0e10cSrcweir 
103*cdf0e10cSrcweir /*========================================================================
104*cdf0e10cSrcweir  *
105*cdf0e10cSrcweir  * The End.
106*cdf0e10cSrcweir  *
107*cdf0e10cSrcweir  *======================================================================*/
108*cdf0e10cSrcweir 
109*cdf0e10cSrcweir } // namespace store
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir #endif /* !_STORE_STORCACH_HXX */
112*cdf0e10cSrcweir 
113