Docs (BaseX Core 11.0 API)

java.lang.Object
- org.basex.query.expr.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.fn.DynamicFn
        
        org.basex.query.func.fn.Docs

Direct Known Subclasses:

FnCollection, FnDocAvailable
```
public abstract class Docs
extends DynamicFn
```
Document and collection functions.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Field Summary
- Fields inherited from class org.basex.query.func.StandardFunc
  definition
- Fields inherited from class org.basex.query.expr.Arr
  exprs
- Fields inherited from class org.basex.query.expr.ParseExpr
  exprType, info

Constructor Summary

Constructors
Constructor Description

Docs()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`accept(ASTVisitor visitor)`	Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.
`protected Expr`	`opt(CompileContext cc)`	Performs function-specific optimizations.

Methods inherited from class org.basex.query.func.StandardFunc
arity, checkPerm, coerce, coerce, compileData, copy, dataLock, defined, description, embed, equals, has, hasCTX, hasUPD, hofIndex, optFirst, optFirst, optimize, refineFunc, serialize, simplifyArgs, toBaseUri, toBindings, toBoolean, toCollation, toCollation, toContent, toContent, toData, toDate, toDBNode, toEncodingOrNull, toEncodingOrNull, toFunction, toFunction, toFunctionOrNull, toIO, toIO, toMs, toName, toNodeOrAtomItem, toOptions, toOptions, toPath, toPath, toStr, toString, toXml, toZeroStr, vacuous, variadic

Methods inherited from class org.basex.query.expr.Arr
allAreValues, arg, args, checkUp, compile, copyAll, count, exprSize, flatten, inline, inlineable, mayBePositional, removeEmpty, simplifyAll

Methods inherited from class org.basex.query.expr.ParseExpr
adoptType, atomValue, checkAllUp, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, data, info, item, iter, refineType, sc, seqType, size, test, toArray, toArray, toAtomItem, toBin, toBin, toBinOrNull, toBoolean, toBoolean, toBooleanOrFalse, toBytes, toBytes, toDouble, toDouble, toElem, toElem, toEnum, toFloat, toFunction, toLong, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumber, toNumberOrNull, toQNm, toQNmOrNull, toRecord, toString, toString, toStringOrNull, toToken, toToken, toTokenOrNull, toZeroToken, value

Methods inherited from class org.basex.query.expr.Expr
arg, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, info, isSimple, markTailCalls, mergeEbv, optimizePos, simplify, simplifyFor, typeCheck, uses, visitAll

Methods inherited from class org.basex.query.expr.ExprInfo
toErrorString, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Docs
```
public Docs()
```
- Method Detail
  - opt
```
protected Expr opt(CompileContext cc)
            throws QueryException
```
    Description copied from class: StandardFunc
    
    Performs function-specific optimizations.
    
    Overrides:
    
    opt in class DynamicFn
    
    Parameters:
    
    cc - compilation context
    
    Returns:
    
    optimized or original expression
    
    Throws:
    
    QueryException - query exception
  - accept
```
public final boolean accept(ASTVisitor visitor)
```
    Description copied from class: Expr
    
    Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.
    
    Overrides:
    
    accept in class Arr
    
    Parameters:
    
    visitor - visitor
    
    Returns:
    
    if the walk should be continued