org.basex.query.func.archive

Class ArchiveCreate

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.archive.ArchiveCreate

Direct Known Subclasses:

ArchiveCreateFrom, ArchiveUpdate

public class ArchiveCreate
extends StandardFunc

Function implementation.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.func.StandardFunc

definition, sc

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 and Description
ArchiveCreate()

Method Summary

Modifier and Type	Method and Description
protected void	add(Item[] entry, org.basex.query.func.archive.ArchiveOut out, int level, String root, QueryContext qc) Adds the specified entry to the output stream.
Item	item(QueryContext qc, InputInfo ii) Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence.
protected int	level(CreateOptions options) Returns the compression level.

Methods inherited from class org.basex.query.func.StandardFunc

checkAdmin, checkArity, checkArity, checkCreate, checkData, checkPath, checkPath, coerceFunc, compileData, copy, data, data, dataLock, dateTimeToMs, description, equals, has, opt, optFirst, optFirst, optimize, plan, plan, serialize, simplifyArgs, toBaseUri, toBindings, toCollation, toDate, toDBNode, toEncodingOrNull, toNodeOrAtomItem, toOptions, toPath, toPath, toQuery, toQuery, vacuous

Methods inherited from class org.basex.query.expr.Arr

accept, allAreValues, args, checkUp, compile, copyAll, count, exprSize, flatten, inline, inline, inlineable, mayBePositional, simplifyAll

Methods inherited from class org.basex.query.expr.ParseExpr

adoptType, atomValue, checkAllUp, checkNoEmpty, checkNoEmpty, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, ebv, iter, refineType, seqType, size, test, toArray, toArray, toAtomItem, toB64, toB64, toBin, toBin, toBoolean, toBoolean, toBytes, toBytes, toDouble, toDouble, toElem, toFloat, toFunc, toItem, toItem, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumberOrNull, toQNm, toQNm, toToken, toToken, toTokenOrNull, toZeroToken, value

Methods inherited from class org.basex.query.expr.Expr

arg, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, 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

ArchiveCreate

public ArchiveCreate()

Method Detail

item

public Item item(QueryContext qc,
                 InputInfo ii)
          throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence. If this method is not implemented, Expr.value(QueryContext) must be implemented instead.

Overrides:

item in class ParseExpr

Parameters:

qc - query context

ii - input info (only required by Seq instances, which have no input info)

Returns:

item or Empty.VALUE

Throws:

QueryException - query exception

level

protected int level(CreateOptions options)
             throws QueryException

Returns the compression level.

Parameters:

options - options

Returns:

level

Throws:

QueryException - query exception

add

protected final void add(Item[] entry,
                         org.basex.query.func.archive.ArchiveOut out,
                         int level,
                         String root,
                         QueryContext qc)
                  throws QueryException,
                         IOException

Adds the specified entry to the output stream.

Parameters:

entry - archive entry

out - output archive

level - default compression level

root - root path (empty, or ending with slash)

qc - query context

Throws:

QueryException - query exception

IOException - I/O exception