com.xpn.xwiki.store
Class XWikiCacheStore

java.lang.Object
  extended by com.xpn.xwiki.store.XWikiCacheStore
All Implemented Interfaces:
XWikiCacheStoreInterface, XWikiStoreInterface

public class XWikiCacheStore
extends java.lang.Object
implements XWikiCacheStoreInterface


Field Summary
private  XWikiCache cache
           
private  int cacheCapacity
           
private  XWikiCache classCache
           
private static org.apache.commons.logging.Log log
           
private  XWikiCache pageExistCache
           
private  int pageExistCacheCapacity
           
private  XWikiCache prefsCache
           
private  int prefsCacheCapacity
           
private  XWikiStoreInterface store
           
 
Constructor Summary
XWikiCacheStore(XWikiStoreInterface store, XWikiContext context)
           
 
Method Summary
 void cleanUp(XWikiContext context)
           
 void createWiki(java.lang.String wikiName, XWikiContext context)
           
 void deleteLinks(long docId, XWikiContext context, boolean bTransaction)
           
 void deleteLock(XWikiLock lock, XWikiContext context, boolean bTransaction)
           
 void deleteXWikiDoc(XWikiDocument doc, XWikiContext context)
           
 boolean exists(XWikiDocument doc, XWikiContext context)
           
 void flushCache()
           
 XWikiCache getCache()
           
 java.util.List getClassList(XWikiContext context)
           
 java.util.List getCustomMappingPropertyList(BaseClass bclass)
           
 java.lang.String getKey(java.lang.String fullName, java.lang.String language, XWikiContext context)
           
 java.lang.String getKey(XWikiDocument doc, XWikiContext context)
           
 XWikiCache getPageExistCache()
           
 XWikiCache getPrefsCache()
           
 int getPrefsCacheCapacity()
           
 XWikiStoreInterface getStore()
           
 org.apache.commons.jrcs.rcs.Version[] getXWikiDocVersions(XWikiDocument doc, XWikiContext context)
           
 void initCache(int capacity, int pageExistCacheCapacity, int prefsCacheCapacity, XWikiContext context)
           
 boolean injectCustomMapping(BaseClass doc1class, XWikiContext context)
           
 void injectCustomMappings(XWikiContext context)
           
 boolean injectCustomMappings(XWikiDocument doc, XWikiContext context)
           
 void injectUpdatedCustomMappings(XWikiContext context)
           
 boolean isCustomMappingValid(BaseClass bclass, java.lang.String custommapping1, XWikiContext context)
           
 java.util.List loadBacklinks(java.lang.String fullName, XWikiContext context, boolean bTransaction)
           
 java.util.List loadLinks(long docId, XWikiContext context, boolean bTransaction)
           
 XWikiLock loadLock(long docId, XWikiContext context, boolean bTransaction)
           
 XWikiDocument loadXWikiDoc(XWikiDocument doc, java.lang.String version, XWikiContext context)
           
 XWikiDocument loadXWikiDoc(XWikiDocument doc, XWikiContext context)
           
 void saveLinks(XWikiDocument doc, XWikiContext context, boolean bTransaction)
           
 void saveLock(XWikiLock lock, XWikiContext context, boolean bTransaction)
           
 void saveXWikiDoc(XWikiDocument doc, XWikiContext context)
           
 void saveXWikiDoc(XWikiDocument doc, XWikiContext context, boolean bTransaction)
           
 java.util.List search(java.lang.String sql, int nb, int start, java.lang.Object[][] whereParams, XWikiContext context)
           
 java.util.List search(java.lang.String sql, int nb, int start, XWikiContext context)
           
 java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbyname, boolean customMapping, boolean checkRight, int nb, int start, XWikiContext context)
           
 java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbyname, boolean customMapping, int nb, int start, XWikiContext context)
           
 java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbyname, boolean customMapping, XWikiContext context)
           
 java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbyname, int nb, int start, XWikiContext context)
           
 java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbyname, XWikiContext context)
           
 java.util.List searchDocuments(java.lang.String wheresql, int nb, int start, XWikiContext context)
           
 java.util.List searchDocuments(java.lang.String wheresql, XWikiContext context)
           
 java.util.List searchDocumentsNames(java.lang.String wheresql, int nb, int start, java.lang.String selectColumns, XWikiContext context)
           
 java.util.List searchDocumentsNames(java.lang.String wheresql, int nb, int start, XWikiContext context)
           
 java.util.List searchDocumentsNames(java.lang.String wheresql, XWikiContext context)
           
 void setCache(XWikiCache cache)
           
 void setCacheCapacity(int capacity)
           
 void setPageExistCache(XWikiCache pageExistCache)
           
 void setPageExistCacheCapacity(int capacity)
           
 void setPrefsCache(XWikiCache prefsCache)
           
 void setPrefsCacheCapacity(int prefsCacheCapacity)
           
 void setStore(XWikiStoreInterface store)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static final org.apache.commons.logging.Log log

store

private XWikiStoreInterface store

cache

private XWikiCache cache

pageExistCache

private XWikiCache pageExistCache

classCache

private XWikiCache classCache

prefsCache

private XWikiCache prefsCache

cacheCapacity

private int cacheCapacity

prefsCacheCapacity

private int prefsCacheCapacity

pageExistCacheCapacity

private int pageExistCacheCapacity
Constructor Detail

XWikiCacheStore

public XWikiCacheStore(XWikiStoreInterface store,
                       XWikiContext context)
Method Detail

initCache

public void initCache(int capacity,
                      int pageExistCacheCapacity,
                      int prefsCacheCapacity,
                      XWikiContext context)
Specified by:
initCache in interface XWikiCacheStoreInterface

setCacheCapacity

public void setCacheCapacity(int capacity)
Specified by:
setCacheCapacity in interface XWikiCacheStoreInterface

setPageExistCacheCapacity

public void setPageExistCacheCapacity(int capacity)
Specified by:
setPageExistCacheCapacity in interface XWikiCacheStoreInterface

getStore

public XWikiStoreInterface getStore()
Specified by:
getStore in interface XWikiCacheStoreInterface

setStore

public void setStore(XWikiStoreInterface store)
Specified by:
setStore in interface XWikiCacheStoreInterface

saveXWikiDoc

public void saveXWikiDoc(XWikiDocument doc,
                         XWikiContext context)
                  throws XWikiException
Specified by:
saveXWikiDoc in interface XWikiStoreInterface
Throws:
XWikiException

saveXWikiDoc

public void saveXWikiDoc(XWikiDocument doc,
                         XWikiContext context,
                         boolean bTransaction)
                  throws XWikiException
Specified by:
saveXWikiDoc in interface XWikiStoreInterface
Throws:
XWikiException

flushCache

public void flushCache()
Specified by:
flushCache in interface XWikiCacheStoreInterface

getKey

public java.lang.String getKey(XWikiDocument doc,
                               XWikiContext context)

getKey

public java.lang.String getKey(java.lang.String fullName,
                               java.lang.String language,
                               XWikiContext context)

loadXWikiDoc

public XWikiDocument loadXWikiDoc(XWikiDocument doc,
                                  XWikiContext context)
                           throws XWikiException
Specified by:
loadXWikiDoc in interface XWikiStoreInterface
Throws:
XWikiException

loadXWikiDoc

public XWikiDocument loadXWikiDoc(XWikiDocument doc,
                                  java.lang.String version,
                                  XWikiContext context)
                           throws XWikiException
Specified by:
loadXWikiDoc in interface XWikiStoreInterface
Throws:
XWikiException

deleteXWikiDoc

public void deleteXWikiDoc(XWikiDocument doc,
                           XWikiContext context)
                    throws XWikiException
Specified by:
deleteXWikiDoc in interface XWikiStoreInterface
Throws:
XWikiException

getXWikiDocVersions

public org.apache.commons.jrcs.rcs.Version[] getXWikiDocVersions(XWikiDocument doc,
                                                                 XWikiContext context)
                                                          throws XWikiException
Specified by:
getXWikiDocVersions in interface XWikiStoreInterface
Throws:
XWikiException

getClassList

public java.util.List getClassList(XWikiContext context)
                            throws XWikiException
Specified by:
getClassList in interface XWikiStoreInterface
Throws:
XWikiException

searchDocumentsNames

public java.util.List searchDocumentsNames(java.lang.String wheresql,
                                           XWikiContext context)
                                    throws XWikiException
Specified by:
searchDocumentsNames in interface XWikiStoreInterface
Throws:
XWikiException

searchDocumentsNames

public java.util.List searchDocumentsNames(java.lang.String wheresql,
                                           int nb,
                                           int start,
                                           XWikiContext context)
                                    throws XWikiException
Specified by:
searchDocumentsNames in interface XWikiStoreInterface
Throws:
XWikiException

searchDocumentsNames

public java.util.List searchDocumentsNames(java.lang.String wheresql,
                                           int nb,
                                           int start,
                                           java.lang.String selectColumns,
                                           XWikiContext context)
                                    throws XWikiException
Specified by:
searchDocumentsNames in interface XWikiStoreInterface
Throws:
XWikiException

isCustomMappingValid

public boolean isCustomMappingValid(BaseClass bclass,
                                    java.lang.String custommapping1,
                                    XWikiContext context)
                             throws XWikiException
Specified by:
isCustomMappingValid in interface XWikiStoreInterface
Throws:
XWikiException

injectCustomMapping

public boolean injectCustomMapping(BaseClass doc1class,
                                   XWikiContext context)
                            throws XWikiException
Specified by:
injectCustomMapping in interface XWikiStoreInterface
Throws:
XWikiException

injectCustomMappings

public boolean injectCustomMappings(XWikiDocument doc,
                                    XWikiContext context)
                             throws XWikiException
Specified by:
injectCustomMappings in interface XWikiStoreInterface
Throws:
XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      boolean distinctbyname,
                                      XWikiContext context)
                               throws XWikiException
Specified by:
searchDocuments in interface XWikiStoreInterface
Throws:
XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      boolean distinctbyname,
                                      boolean customMapping,
                                      XWikiContext context)
                               throws XWikiException
Specified by:
searchDocuments in interface XWikiStoreInterface
Throws:
XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      boolean distinctbyname,
                                      int nb,
                                      int start,
                                      XWikiContext context)
                               throws XWikiException
Specified by:
searchDocuments in interface XWikiStoreInterface
Throws:
XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      boolean distinctbyname,
                                      boolean customMapping,
                                      int nb,
                                      int start,
                                      XWikiContext context)
                               throws XWikiException
Specified by:
searchDocuments in interface XWikiStoreInterface
Throws:
XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      XWikiContext context)
                               throws XWikiException
Specified by:
searchDocuments in interface XWikiStoreInterface
Throws:
XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      int nb,
                                      int start,
                                      XWikiContext context)
                               throws XWikiException
Specified by:
searchDocuments in interface XWikiStoreInterface
Throws:
XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      boolean distinctbyname,
                                      boolean customMapping,
                                      boolean checkRight,
                                      int nb,
                                      int start,
                                      XWikiContext context)
                               throws XWikiException
Specified by:
searchDocuments in interface XWikiStoreInterface
Throws:
XWikiException

loadLock

public XWikiLock loadLock(long docId,
                          XWikiContext context,
                          boolean bTransaction)
                   throws XWikiException
Specified by:
loadLock in interface XWikiStoreInterface
Throws:
XWikiException

saveLock

public void saveLock(XWikiLock lock,
                     XWikiContext context,
                     boolean bTransaction)
              throws XWikiException
Specified by:
saveLock in interface XWikiStoreInterface
Throws:
XWikiException

deleteLock

public void deleteLock(XWikiLock lock,
                       XWikiContext context,
                       boolean bTransaction)
                throws XWikiException
Specified by:
deleteLock in interface XWikiStoreInterface
Throws:
XWikiException

loadLinks

public java.util.List loadLinks(long docId,
                                XWikiContext context,
                                boolean bTransaction)
                         throws XWikiException
Specified by:
loadLinks in interface XWikiStoreInterface
Throws:
XWikiException

loadBacklinks

public java.util.List loadBacklinks(java.lang.String fullName,
                                    XWikiContext context,
                                    boolean bTransaction)
                             throws XWikiException
Specified by:
loadBacklinks in interface XWikiStoreInterface
Throws:
XWikiException

saveLinks

public void saveLinks(XWikiDocument doc,
                      XWikiContext context,
                      boolean bTransaction)
               throws XWikiException
Specified by:
saveLinks in interface XWikiStoreInterface
Throws:
XWikiException

deleteLinks

public void deleteLinks(long docId,
                        XWikiContext context,
                        boolean bTransaction)
                 throws XWikiException
Specified by:
deleteLinks in interface XWikiStoreInterface
Throws:
XWikiException

search

public java.util.List search(java.lang.String sql,
                             int nb,
                             int start,
                             XWikiContext context)
                      throws XWikiException
Specified by:
search in interface XWikiStoreInterface
Throws:
XWikiException

search

public java.util.List search(java.lang.String sql,
                             int nb,
                             int start,
                             java.lang.Object[][] whereParams,
                             XWikiContext context)
                      throws XWikiException
Specified by:
search in interface XWikiStoreInterface
Throws:
XWikiException

cleanUp

public void cleanUp(XWikiContext context)
Specified by:
cleanUp in interface XWikiStoreInterface

createWiki

public void createWiki(java.lang.String wikiName,
                       XWikiContext context)
                throws XWikiException
Specified by:
createWiki in interface XWikiStoreInterface
Throws:
XWikiException

exists

public boolean exists(XWikiDocument doc,
                      XWikiContext context)
               throws XWikiException
Specified by:
exists in interface XWikiStoreInterface
Throws:
XWikiException

getCache

public XWikiCache getCache()

setCache

public void setCache(XWikiCache cache)

getPageExistCache

public XWikiCache getPageExistCache()

setPageExistCache

public void setPageExistCache(XWikiCache pageExistCache)

getCustomMappingPropertyList

public java.util.List getCustomMappingPropertyList(BaseClass bclass)
Specified by:
getCustomMappingPropertyList in interface XWikiStoreInterface

injectCustomMappings

public void injectCustomMappings(XWikiContext context)
                          throws XWikiException
Specified by:
injectCustomMappings in interface XWikiStoreInterface
Throws:
XWikiException

injectUpdatedCustomMappings

public void injectUpdatedCustomMappings(XWikiContext context)
                                 throws XWikiException
Specified by:
injectUpdatedCustomMappings in interface XWikiStoreInterface
Throws:
XWikiException

getPrefsCache

public XWikiCache getPrefsCache()

setPrefsCache

public void setPrefsCache(XWikiCache prefsCache)

getPrefsCacheCapacity

public int getPrefsCacheCapacity()

setPrefsCacheCapacity

public void setPrefsCacheCapacity(int prefsCacheCapacity)
Specified by:
setPrefsCacheCapacity in interface XWikiCacheStoreInterface


Copyright 2003 Ludovic Dubost