com.xpn.xwiki.store

Class XWikiDefaultStore

java.lang.Object

com.xpn.xwiki.store.XWikiDefaultStore

All Implemented Interfaces:

XWikiStoreInterface

public abstract class XWikiDefaultStore
extends Object
implements XWikiStoreInterface

Constructor Summary

Constructors

Constructor and Description
XWikiDefaultStore()

Method Summary

Modifier and Type	Method and Description
List	getCustomMappingPropertyList(BaseClass bclass)
boolean	injectCustomMapping(BaseClass doc1class, XWikiContext xWikiContext)
void	injectCustomMappings(XWikiContext context)
boolean	injectCustomMappings(XWikiDocument doc, XWikiContext xWikiContext)
void	injectUpdatedCustomMappings(XWikiContext context)
List<XWikiDocument>	searchDocuments(String wheresql, boolean distinctbyname, boolean customMapping, int nb, int start, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	searchDocuments(String wheresql, boolean distinctbyname, int nb, int start, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	searchDocuments(String wheresql, boolean distinctbylanguage, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	searchDocuments(String wheresql, int nb, int start, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	searchDocuments(String wheresql, XWikiContext context) Search documents in the storing system.
List	searchDocumentsNames(String wheresql, int nb, int start, XWikiContext context)
List	searchDocumentsNames(String wheresql, XWikiContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.xpn.xwiki.store.XWikiStoreInterface

cleanUp, countDocuments, countDocuments, createWiki, deleteLinks, deleteLock, deleteWiki, deleteXWikiDoc, exists, getClassList, getLimitSize, getQueryManager, getTranslationList, injectCustomMapping, isCustomMappingValid, isCustomMappingValid, isWikiNameAvailable, loadBacklinks, loadBacklinks, loadLinks, loadLock, loadXWikiDoc, renameXWikiDoc, saveLinks, saveLock, saveXWikiDoc, saveXWikiDoc, search, search, search, search, searchDocumentReferences, searchDocumentReferences, searchDocumentReferences, searchDocumentReferences, searchDocumentReferences, searchDocuments, searchDocuments, searchDocuments, searchDocuments, searchDocuments, searchDocuments, searchDocumentsNames, searchDocumentsNames, searchDocumentsNames

Constructor Detail

XWikiDefaultStore

public XWikiDefaultStore()

Method Detail

searchDocumentsNames

public List searchDocumentsNames(String wheresql,
                                 XWikiContext context)
                          throws XWikiException

Specified by:

searchDocumentsNames in interface XWikiStoreInterface

Throws:

XWikiException

searchDocumentsNames

public List searchDocumentsNames(String wheresql,
                                 int nb,
                                 int start,
                                 XWikiContext context)
                          throws XWikiException

Specified by:

searchDocumentsNames in interface XWikiStoreInterface

Throws:

XWikiException

searchDocuments

public List<XWikiDocument> searchDocuments(String wheresql,
                                           XWikiContext context)
                                    throws XWikiException

Description copied from interface: XWikiStoreInterface

Search documents in the storing system.

Specified by:

searchDocuments in interface XWikiStoreInterface

Parameters:

wheresql - the HQL where clause. For example: where doc.fullName <> ?1 and (doc.parent = ?2 or (doc.parent = ?3 and doc.space = ?4))

context - the XWiki context required for getting information about the execution context.

Returns:

a list of XWikiDocument.

Throws:

XWikiException - in case of error while performing the query.

searchDocuments

public List<XWikiDocument> searchDocuments(String wheresql,
                                           boolean distinctbylanguage,
                                           XWikiContext context)
                                    throws XWikiException

Description copied from interface: XWikiStoreInterface

Search documents in the storing system.

Specified by:

searchDocuments in interface XWikiStoreInterface

Parameters:

wheresql - the HQL where clause. For example: where doc.fullName <> ?1 and (doc.parent = ?2 or (doc.parent = ?3 and doc.space = ?4))

distinctbylanguage - when a document has multiple version for each language it is returned as one document a language.

context - the XWiki context required for getting information about the execution context.

Returns:

a list of XWikiDocument.

Throws:

XWikiException - in case of error while performing the query.

searchDocuments

public List<XWikiDocument> searchDocuments(String wheresql,
                                           boolean distinctbylanguage,
                                           boolean customMapping,
                                           XWikiContext context)
                                    throws XWikiException

Description copied from interface: XWikiStoreInterface

Search documents in the storing system.

Specified by:

searchDocuments in interface XWikiStoreInterface

Parameters:

wheresql - the HQL where clause. For example: where doc.fullName <> ?1 and (doc.parent = ?2 or (doc.parent = ?3 and doc.space = ?4))

distinctbylanguage - when a document has multiple version for each language it is returned as one document a language.

customMapping - inject custom mapping in session.

context - the XWiki context required for getting information about the execution context.

Returns:

a list of XWikiDocument.

Throws:

XWikiException - in case of error while performing the query.

searchDocuments

public List<XWikiDocument> searchDocuments(String wheresql,
                                           int nb,
                                           int start,
                                           XWikiContext context)
                                    throws XWikiException

Description copied from interface: XWikiStoreInterface

Search documents in the storing system.

Specified by:

searchDocuments in interface XWikiStoreInterface

Parameters:

wheresql - the HQL where clause. For example: where doc.fullName <> ?1 and (doc.parent = ?2 or (doc.parent = ?3 and doc.space = ?4))

nb - the number of rows to return. If 0 then all rows are returned.

start - the number of rows to skip. If 0 don't skip any row.

context - the XWiki context required for getting information about the execution context.

Returns:

a list of XWikiDocument.

Throws:

XWikiException - in case of error while performing the query.

searchDocuments

public List<XWikiDocument> searchDocuments(String wheresql,
                                           boolean distinctbyname,
                                           int nb,
                                           int start,
                                           XWikiContext context)
                                    throws XWikiException

Description copied from interface: XWikiStoreInterface

Search documents in the storing system.

Specified by:

searchDocuments in interface XWikiStoreInterface

Parameters:

wheresql - the HQL where clause. For example: where doc.fullName <> ?1 and (doc.parent = ?2 or (doc.parent = ?3 and doc.space = ?4))

distinctbyname - when a document has multiple version for each language it is returned as one document a language.

nb - the number of rows to return. If 0 then all rows are returned.

start - the number of rows to skip. If 0 don't skip any row.

context - the XWiki context required for getting information about the execution context.

Returns:

a list of XWikiDocument.

Throws:

XWikiException - in case of error while performing the query.

injectCustomMapping

public boolean injectCustomMapping(BaseClass doc1class,
                                   XWikiContext xWikiContext)
                            throws XWikiException

Specified by:

injectCustomMapping in interface XWikiStoreInterface

Throws:

XWikiException

injectCustomMappings

public boolean injectCustomMappings(XWikiDocument doc,
                                    XWikiContext xWikiContext)
                             throws XWikiException

Specified by:

injectCustomMappings in interface XWikiStoreInterface

Throws:

XWikiException

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

getCustomMappingPropertyList

public List getCustomMappingPropertyList(BaseClass bclass)

Specified by:

getCustomMappingPropertyList in interface XWikiStoreInterface

searchDocuments

public List<XWikiDocument> searchDocuments(String wheresql,
                                           boolean distinctbyname,
                                           boolean customMapping,
                                           int nb,
                                           int start,
                                           XWikiContext context)
                                    throws XWikiException

Description copied from interface: XWikiStoreInterface

Search documents in the storing system.

Specified by:

searchDocuments in interface XWikiStoreInterface

Parameters:

wheresql - the HQL where clause. For example: where doc.fullName <> ?1 and (doc.parent = ?2 or (doc.parent = ?3 and doc.space = ?4))

distinctbyname - when a document has multiple version for each language it is returned as one document a language.

customMapping - inject custom mapping in session.

nb - the number of rows to return. If 0 then all rows are returned.

start - the number of rows to skip. If 0 don't skip any row.

context - the XWiki context required for getting information about the execution context.

Returns:

a list of XWikiDocument.

Throws:

XWikiException - in case of error while performing the query.