Cache.cs

Go to the documentation of this file.

// 
//  Copyright 2010-2015 Deveel
// 
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
// 
//        http://www.apache.org/licenses/LICENSE-2.0
// 
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
//

using System;

using Deveel.Data.Configuration;

namespace Deveel.Data.Caching {
    public abstract class Cache : ICache {
        private int currentCacheSize;

        private readonly int wipeTo;

        protected Cache() {
        }


        ~Cache() {
            Dispose(false);
        }

        protected virtual void CheckClean() {
        }

        protected virtual bool WipeMoreNodes() {
            return (currentCacheSize >= wipeTo);
        }

        protected virtual void OnWipingNode(object value) {
        }

        protected virtual void OnObjectAdded(object key, object value) {
            ++currentCacheSize;
        }

        protected virtual void OnObjectRemoved(object key, Object value) {
            --currentCacheSize;
        }

        protected virtual void OnAllCleared() {
            currentCacheSize = 0;
        }

        protected virtual void OnGetWalks(long totalWalks, long totalGetOps) {
        }


        // ---------- Public cache methods ----------

        public virtual int NodeCount {
            get { return currentCacheSize; }
        }

        protected abstract bool SetObject(object key, object value);

        protected abstract bool TryGetObject(object key, out object value);

        protected abstract object RemoveObject(object key);

        public bool Set(object key, object value) {

            // Do we need to clean any cache elements out?
            CheckClean();

            bool newValue = SetObject(key, value);
            if (newValue) 
                OnObjectAdded(key, value);

            return newValue;
        }

        public bool TryGet(object key, out object value) {
            return TryGetObject(key, out value);
        }

        public object Remove(Object key) {
            object obj = RemoveObject(key);
            
            if (obj != null)
                OnObjectRemoved(key, obj);

            return obj;
        }

        public virtual void Clear() {
            OnAllCleared();
        }

        protected virtual int Clean() {
            return 0;
        }
        
        public static int ClosestPrime(int value) {
            for (int i = 0; i < PrimeList.Length; ++i) {
                if (PrimeList[i] >= value) {
                    return PrimeList[i];
                }
            }
            // Return the last prime
            return PrimeList[PrimeList.Length - 1];
        }

        private static readonly int[] PrimeList = new int[] {
                                                                3001, 4799, 13999, 15377, 21803, 24247, 35083, 40531, 43669,
                                                                44263, 47387, 50377, 57059, 57773, 59399, 59999, 75913, 96821,
                                                                140551, 149011, 175633, 176389, 183299, 205507, 209771, 223099,
                                                                240259, 258551, 263909, 270761, 274679, 286129, 290531, 296269,
                                                                298021, 300961, 306407, 327493, 338851, 351037, 365489, 366811,
                                                                376769, 385069, 410623, 430709, 433729, 434509, 441913, 458531,
                                                                464351, 470531, 475207, 479629, 501703, 510709, 516017, 522211,
                                                                528527, 536311, 539723, 557567, 593587, 596209, 597451, 608897,
                                                                611069, 642547, 670511, 677827, 679051, 688477, 696743, 717683,
                                                                745931, 757109, 760813, 763957, 766261, 781559, 785597, 788353,
                                                                804493, 813559, 836917, 854257, 859973, 883217, 884789, 891493,
                                                                902281, 910199, 915199, 930847, 939749, 940483, 958609, 963847,
                                                                974887, 983849, 984299, 996211, 999217, 1007519, 1013329,
                                                                1014287, 1032959, 1035829, 1043593, 1046459, 1076171, 1078109,
                                                                1081027, 1090303, 1095613, 1098847, 1114037, 1124429, 1125017,
                                                                1130191, 1159393, 1170311, 1180631, 1198609, 1200809, 1212943,
                                                                1213087, 1226581, 1232851, 1287109, 1289867, 1297123, 1304987,
                                                                1318661, 1331107, 1343161, 1345471, 1377793, 1385117, 1394681,
                                                                1410803, 1411987, 1445261, 1460497, 1463981, 1464391, 1481173,
                                                                1488943, 1491547, 1492807, 1528993, 1539961, 1545001, 1548247,
                                                                1549843, 1551001, 1553023, 1571417, 1579099, 1600259, 1606153,
                                                                1606541, 1639751, 1649587, 1657661, 1662653, 1667051, 1675273,
                                                                1678837, 1715537, 1718489, 1726343, 1746281, 1749107, 1775489,
                                                                1781881, 1800157, 1806859, 1809149, 1826753, 1834607, 1846561,
                                                                1849241, 1851991, 1855033, 1879931, 1891133, 1893737, 1899137,
                                                                1909513, 1916599, 1917749, 1918549, 1919347, 1925557, 1946489,
                                                                1961551, 1965389, 2011073, 2033077, 2039761, 2054047, 2060171,
                                                                2082503, 2084107, 2095099, 2096011, 2112193, 2125601, 2144977,
                                                                2150831, 2157401, 2170141, 2221829, 2233019, 2269027, 2270771,
                                                                2292449, 2299397, 2303867, 2309891, 2312407, 2344301, 2348573,
                                                                2377007, 2385113, 2386661, 2390051, 2395763, 2422999, 2448367,
                                                                2500529, 2508203, 2509841, 2513677, 2516197, 2518151, 2518177,
                                                                2542091, 2547469, 2549951, 2556991, 2563601, 2575543, 2597629,
                                                                2599577, 2612249, 2620003, 2626363, 2626781, 2636773, 2661557,
                                                                2674297, 2691571, 2718269, 2725691, 2729381, 2772199, 2774953,
                                                                2791363, 2792939, 2804293, 2843021, 2844911, 2851313, 2863519,
                                                                2880797, 2891821, 2897731, 2904887, 2910251, 2928943, 2958341,
                                                                2975389
                                                             };



        public void Dispose() {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        protected virtual void Dispose(bool disposing) {
            if (disposing) {
                Clear();
            }
        }
    }
}