|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.basex.core.Progress
org.basex.query.QueryContext
org.basex.query.xquery.XQContext
public final class XQContext
XQuery Context.
Field Summary | |
---|---|
Uri |
baseURI
Static Base URI. |
Uri |
collation
Default collation. |
boolean |
construct
Construction mode (currently ignored). |
Dat |
date
Current Date. |
Dtm |
dtm
Current DateTime. |
byte[] |
encoding
Default encoding (currently ignored). |
FTTokenizer |
ftitem
Current fulltext item. |
FTOpt |
ftopt
Current fulltext options. |
FTPos |
ftpos
Current fulltext position filter. |
Functions |
fun
Functions. |
Item |
item
Current context. |
NSLocal |
ns
Namespaces. |
byte[] |
nsElem
Default element namespace. |
byte[] |
nsFunc
Default function namespace. |
boolean |
nsInherit
Inherit Namespaces (currently ignored). |
boolean |
nsPreserve
Preserve Namespaces (currently ignored). |
boolean |
ordered
Ordering mode (currently ignored). |
boolean |
orderGreatest
Empty Order mode. |
int |
pos
Current context position. |
int |
size
Current context size. |
boolean |
spaces
Default boundary-space. |
Tim |
time
Current Time. |
Variables |
vars
Variables. |
Fields inherited from class org.basex.query.QueryContext |
---|
file, PLAN, query |
Constructor Summary | |
---|---|
XQContext()
|
Method Summary | |
---|---|
void |
addColl(NodIter nod,
byte[] name)
Adds a collection. |
Item |
atomic(Expr expr,
Expr call,
boolean empty)
Returns the specified expression as an item. |
NodIter |
coll(byte[] coll)
Adds a collection instance or returns an existing one. |
Expr |
comp(Expr e)
Evaluates the specified expression and returns an iterator. |
XQContext |
compile(Nodes nodes)
Optimizes the expression. |
DNode |
doc(byte[] db)
Adds a database instance or returns an existing one. |
XQResult |
eval(Nodes nodes)
Evaluates the expression with the specified context set. |
Iter |
iter()
Returns a result iterator. |
Iter |
iter(Expr e)
Evaluates the specified expression and returns an iterator. |
void |
plan(Serializer ser)
Recursively serializes the query plan. |
void |
serialize(Serializer ser,
Item i)
Serializes the specified item. |
java.lang.String |
toString()
|
Methods inherited from class org.basex.query.QueryContext |
---|
compInfo, det, evalInfo, info, planDot, planXML, prog, tit |
Methods inherited from class org.basex.core.Progress |
---|
checkStop, detail, progress, progress, stop, title |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public NSLocal ns
public Functions fun
public Variables vars
public Item item
public int pos
public int size
public FTTokenizer ftitem
public FTOpt ftopt
public FTPos ftpos
public Dat date
public Dtm dtm
public Tim time
public byte[] nsFunc
public Uri baseURI
public byte[] nsElem
public Uri collation
public boolean spaces
public boolean orderGreatest
public byte[] encoding
public boolean nsPreserve
public boolean nsInherit
public boolean ordered
public boolean construct
Constructor Detail |
---|
public XQContext()
Method Detail |
---|
public XQContext compile(Nodes nodes) throws XQException
QueryContext
nodes
- node context
XQException
public XQResult eval(Nodes nodes) throws XQException
QueryContext
nodes
- initial context set
XQException
public Iter iter() throws XQException
XQException
- query exceptionpublic void serialize(Serializer ser, Item i) throws java.io.IOException
ser
- serializeri
- item to serialize
java.io.IOException
- query exceptionpublic void plan(Serializer ser) throws java.io.IOException
QueryContext
ser
- serializer
java.io.IOException
public Expr comp(Expr e) throws XQException
e
- expression to be evaluated
XQException
- evaluation exceptionpublic Iter iter(Expr e) throws XQException
e
- expression to be evaluated
XQException
- evaluation exceptionpublic Item atomic(Expr expr, Expr call, boolean empty) throws XQException
expr
- expression to be evaluatedcall
- calling expressionempty
- if set to true, empty sequences are returned as null.
Otherwise, an error is thrown
XQException
- evaluation exceptionpublic DNode doc(byte[] db) throws XQException
db
- database name or file path
XQException
- evaluation exceptionpublic NodIter coll(byte[] coll) throws XQException
coll
- name of the collection to be returned.
XQException
- evaluation exceptionpublic void addColl(NodIter nod, byte[] name)
nod
- collection nodesname
- namepublic java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |