|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.plugin.query.QueryPluginApi
public class QueryPluginApi
Api for QueryPlugin
Field Summary | |
---|---|
private static org.apache.commons.logging.Log |
log
|
(package private) QueryPlugin |
qp
|
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
QueryPluginApi(QueryPlugin qp)
|
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 |
IQuery |
getObjects(java.lang.String docname,
java.lang.String oclass,
java.lang.String prop,
java.lang.String order)
create query for objects |
XWikiStoreInterface |
getStore()
|
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.api.Api |
---|
checkProgrammingRights, hasAccessLevel, hasAdminRights, hasProgrammingRights |
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
QueryPlugin qp
Constructor Detail |
---|
public QueryPluginApi(QueryPlugin qp)
Method Detail |
---|
public IQuery getDocs(java.lang.String docname, java.lang.String prop, java.lang.String order) throws javax.jcr.query.InvalidQueryException
IQueryFactory
getDocs
in interface IQueryFactory
docname
- - full document name (web/name | web.name). name may consist xpath []-selection. if any (name|web) - *prop
- - return properties, separated by comma, 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
IQueryFactory
getChildDocs
in interface IQueryFactory
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
IQueryFactory
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
IQueryFactory
getObjects
in interface IQueryFactory
oclass
- - full name of object class (web/name | web.name). if any(name|web) - *
javax.jcr.query.InvalidQueryException
getDocs
public XWikiCache getCache()
getCache
in interface IQueryFactory
public XWikiContext getContext()
getContext
in interface IQueryFactory
public XWikiStoreInterface getStore()
getStore
in interface IQueryFactory
public IQuery xpath(java.lang.String q) throws javax.jcr.query.InvalidQueryException
IQueryFactory
xpath
in interface IQueryFactory
javax.jcr.query.InvalidQueryException
public IQuery ql(java.lang.String q) throws javax.jcr.query.InvalidQueryException
IQueryFactory
ql
in interface IQueryFactory
javax.jcr.query.InvalidQueryException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |