org.basex.query.func
Class FNConvert
java.lang.Object
org.basex.data.ExprInfo
org.basex.query.expr.Expr
org.basex.query.expr.ParseExpr
org.basex.query.expr.Arr
org.basex.query.func.StandardFunc
org.basex.query.func.FNConvert
public final class FNConvert
- extends StandardFunc
Functions for converting data to other formats.
- Author:
- BaseX Team 2005-12, BSD License, Christian Gruen
Nested classes/interfaces inherited from class org.basex.query.expr.Expr |
Expr.Flag |
Fields inherited from class org.basex.query.expr.Arr |
expr |
Method Summary |
Item |
item(QueryContext ctx,
InputInfo ii)
Evaluates the expression and returns the resulting item or
a null reference, if the expression yields an empty sequence. |
Iter |
iter(QueryContext ctx)
Evaluates the expression and returns an iterator on the resulting items. |
static byte[] |
toString(java.io.InputStream is,
java.lang.String enc,
QueryContext ctx)
Converts the specified input to a string in the specified encoding. |
Value |
value(QueryContext ctx)
Evaluates the expression and returns the resulting value. |
Methods inherited from class org.basex.query.func.StandardFunc |
atom, bindings, cache, checkData, checkFile, compile, copy, dataLock, dateTimeToMs, description, encoding, has, isFunction, isVacuous, oneOf, opt, optimize, plan, toString |
Methods inherited from class org.basex.query.expr.Arr |
accept, allAreValues, checkNoUp, checkUp, copyAll, count, exprSize, indexEquivalent, inline, removable, toString |
Methods inherited from class org.basex.query.expr.ParseExpr |
checkAdmin, checkAllUp, checkBinary, checkBln, checkColl, checkCreate, checkCtx, checkDbl, checkDBNode, checkEStr, checkEStr, checkFunc, checkItem, checkItr, checkItr, checkMap, checkNode, checkNode, checkNode, checkNoEmpty, checkNoneUp, checkNoUp, checkQNm, checkStr, checkStr, checkStrBin, checkType, checkWrite, compBln, copyType, ebv, optPre, preEval, size, test, type |
Methods inherited from class org.basex.query.expr.Expr |
addText, compEbv, copy, hasFreeVars, indexAccessible, inlineAll, isEmpty, isItem, isValue, iterable, markTailCalls, sameAs, uses, visitAll |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
FNConvert
public FNConvert(InputInfo ii,
Function f,
Expr... e)
- Constructor.
- Parameters:
ii
- input infof
- function definitione
- arguments
iter
public Iter iter(QueryContext ctx)
throws QueryException
- Description copied from class:
Expr
- Evaluates the expression and returns an iterator on the resulting items.
If this method is not overwritten,
Expr.item(org.basex.query.QueryContext, org.basex.util.InputInfo)
must be implemented
by an expression, as it may be called by this method.
- Overrides:
iter
in class ParseExpr
- Parameters:
ctx
- query context
- Returns:
- resulting item
- Throws:
QueryException
- query exception
value
public Value value(QueryContext ctx)
throws QueryException
- Description copied from class:
Expr
- Evaluates the expression and returns the resulting value.
- Overrides:
value
in class ParseExpr
- Parameters:
ctx
- query context
- Returns:
- iterator
- Throws:
QueryException
- query exception
item
public Item item(QueryContext ctx,
InputInfo ii)
throws QueryException
- Description copied from class:
Expr
- Evaluates the expression and returns the resulting item or
a
null
reference, if the expression yields an empty sequence.
If this method is not overwritten, Expr.iter(org.basex.query.QueryContext)
must be implemented
by an expression, as it may be called by this method.
- Overrides:
item
in class ParseExpr
- Parameters:
ctx
- query contextii
- input info
- Returns:
- iterator
- Throws:
QueryException
- query exception
toString
public static byte[] toString(java.io.InputStream is,
java.lang.String enc,
QueryContext ctx)
throws java.io.IOException
- Converts the specified input to a string in the specified encoding.
- Parameters:
is
- input streamenc
- encodingctx
- query context
- Returns:
- resulting value
- Throws:
java.io.IOException
- I/O exception