|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.plugin.XWikiDefaultPlugin
com.xpn.xwiki.plugin.query.QueryPlugin
public class QueryPlugin
Plugin for Query API
Field Summary | |
---|---|
(package private) XWikiCache |
cache
|
(package private) XWikiContext |
context
|
private static org.apache.commons.logging.Log |
log
|
(package private) QueryPluginApi |
queryApi
|
Constructor Summary | |
---|---|
QueryPlugin(java.lang.String name,
java.lang.String className,
XWikiContext context)
|
Method Summary | |
---|---|
IQuery |
getAttachment(java.lang.String docname,
java.lang.String attachname,
java.lang.String order)
create query for attachments |
XWikiCache |
getCache()
|
IQuery |
getChildDocs(java.lang.String docname,
java.lang.String prop,
java.lang.String order)
create query for child documents |
XWikiContext |
getContext()
|
IQuery |
getDocs(java.lang.String docname,
java.lang.String prop,
java.lang.String order)
create query for docs |
java.lang.String |
getName()
|
IQuery |
getObjects(java.lang.String docname,
java.lang.String oclass,
java.lang.String prop,
java.lang.String order)
create query for objects |
protected java.lang.String |
getOrderXPath(java.lang.String order)
|
Api |
getPluginApi(XWikiPluginInterface plugin,
XWikiContext context)
|
protected java.lang.String |
getPropertyXPath(java.lang.String prop)
|
XWikiStoreInterface |
getStore()
|
protected java.lang.String |
getXPathName(java.lang.String name)
|
protected java.lang.String |
getXWikiName(java.lang.String name)
|
(package private) boolean |
isHibernate()
|
private java.lang.String |
n2e(java.lang.String s)
|
protected org.apache.jackrabbit.core.query.QueryRootNode |
parse(java.lang.String query,
java.lang.String language)
Translate query string to query tree |
IQuery |
ql(java.lang.String q)
create JCRSQL query unsupported for now |
IQuery |
xpath(java.lang.String q)
create xpath query |
Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin |
---|
beginRendering, commonTagsHandler, downloadAttachment, endRendering, endRenderingHandler, flushCache, getClassName, init, insidePREHandler, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final org.apache.commons.logging.Log log
XWikiCache cache
XWikiContext context
QueryPluginApi queryApi
Constructor Detail |
---|
public QueryPlugin(java.lang.String name, java.lang.String className, XWikiContext context)
Method Detail |
---|
public java.lang.String getName()
getName
in interface XWikiPluginInterface
getName
in class XWikiDefaultPlugin
public Api getPluginApi(XWikiPluginInterface plugin, XWikiContext context)
getPluginApi
in interface XWikiPluginInterface
getPluginApi
in class XWikiDefaultPlugin
public XWikiContext getContext()
getContext
in interface IQueryFactory
public XWikiStoreInterface getStore()
getStore
in interface IQueryFactory
public XWikiCache getCache()
getCache
in interface IQueryFactory
boolean isHibernate()
protected org.apache.jackrabbit.core.query.QueryRootNode parse(java.lang.String query, java.lang.String language) throws javax.jcr.query.InvalidQueryException
javax.jcr.query.InvalidQueryException
public IQuery xpath(java.lang.String q) throws javax.jcr.query.InvalidQueryException
xpath
in interface IQueryFactory
javax.jcr.query.InvalidQueryException
public IQuery ql(java.lang.String q) throws javax.jcr.query.InvalidQueryException
ql
in interface IQueryFactory
javax.jcr.query.InvalidQueryException
public IQuery getDocs(java.lang.String docname, java.lang.String prop, java.lang.String order) throws javax.jcr.query.InvalidQueryException
getDocs
in interface IQueryFactory
web,
- docname - document.web & .name. it may consist xpath []-selection. if any - *prop
- - return property, start with @, if null - return documentorder
- - properties for sort, separated by ','; order: ascending/descending after prop. name, or +/- before. if null - not sort
javax.jcr.query.InvalidQueryException
public IQuery getChildDocs(java.lang.String docname, java.lang.String prop, java.lang.String order) throws javax.jcr.query.InvalidQueryException
getChildDocs
in interface IQueryFactory
web,docname
- must be without templates & [] select
javax.jcr.query.InvalidQueryException
getDocs
public IQuery getAttachment(java.lang.String docname, java.lang.String attachname, java.lang.String order) throws javax.jcr.query.InvalidQueryException
getAttachment
in interface IQueryFactory
attachname
- - name of attachment, may be *, *[]
javax.jcr.query.InvalidQueryException
getDocs
public IQuery getObjects(java.lang.String docname, java.lang.String oclass, java.lang.String prop, java.lang.String order) throws javax.jcr.query.InvalidQueryException
getObjects
in interface IQueryFactory
oweb,
- oclass - object web & class. if any - *prop.
- for flex-attributes use f:flexname
javax.jcr.query.InvalidQueryException
getDocs
protected java.lang.String getXWikiName(java.lang.String name)
protected java.lang.String getXPathName(java.lang.String name)
protected java.lang.String getOrderXPath(java.lang.String order)
protected java.lang.String getPropertyXPath(java.lang.String prop)
private final java.lang.String n2e(java.lang.String s)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |