|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.criteria.impl.Scope
public class Scope
Immutable scope for retrieving statistics. A scope is associated with a single document but it can match any number of documents. Here, a document can be a page, a space, a wiki or the entire application as a unit. For instance, a scope associated with a space can match all the pages within that space.
Field Summary | |
---|---|
static int |
GLOBAL_SCOPE
The scope that is associated with the entire application as a unit |
static int |
PAGE_SCOPE
Any scope that is associated with a page |
static int |
SPACE_SCOPE
Any scope that is associated with a space |
static int |
WIKI_SCOPE
Any scope that is associated with a wiki |
Constructor Summary | |
---|---|
Scope(int type,
String name,
boolean deep)
Creates a new Scope instance with the specified field values. |
Method Summary | |
---|---|
String |
getName()
|
String |
getPattern()
|
int |
getType()
|
boolean |
isDeep()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int PAGE_SCOPE
public static final int SPACE_SCOPE
public static final int WIKI_SCOPE
public static final int GLOBAL_SCOPE
Constructor Detail |
---|
public Scope(int type, String name, boolean deep)
type
- The type of the scopename
- The name of the document associated with this scopedeep
- true
for matching all sub documents; false
for matching the associated
document as a unitMethod Detail |
---|
public int getType()
type
public String getName()
name
public boolean isDeep()
deep
public String getPattern()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |