Package org.basex.query.value.seq

Class DBNodes

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.value.Value

org.basex.query.value.seq.Seq

org.basex.query.value.seq.DBNodeSeq

org.basex.query.value.seq.DBNodes

All Implemented Interfaces:

Iterable<Item>

public final class DBNodes
extends DBNodeSeq

This class stores database nodes in an ascending order. Instances of this class will be returned by the method QueryProcessor.cache(int) method. They are used in the GUI and in the Context class to reference currently opened, marked, and copied database nodes.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.value.seq.DBNodeSeq

all, data, pres

Fields inherited from class org.basex.query.value.seq.Seq

size

Fields inherited from class org.basex.query.value.Value

type

Constructor Summary

Constructors

Constructor	Description
DBNodes(Data data, boolean all, int... pres)	Constructor, specifying a database, pre values and full-text positions.
DBNodes(Data data, int... pres)	Constructor, specifying a database and pre values.

Method Summary

Modifier and Type	Method	Description
final long	atomSize()	Computes the number of atomized items.
final void	cache(boolean lazy, InputInfo ii)	Caches lazy values.
boolean	contains(int pre)	Checks if the specified node is contained in the array.
DBNodes	discardDocs()	Returns null if the pre values reference all documents of the database.
boolean	equals(Object obj)	This function is e.g.
int	find(int pre)	Returns the position of the specified node or the negative value - 1 of the position where it should have been found.
FTPosData	ftpos()	Returns full-text position data.
DBNodes	ftpos(FTPosData ft)	Assigns full-text position data.
final Value	insert(long pos, Item item, QueryContext qc)	Inserts an item at the given position into this sequence and returns the resulting sequence.
DBNode	itemAt(long pos)	Returns the item at the given position in the value.
final Value	remove(long pos, QueryContext qc)	Removes the item at the given position in this sequence and returns the resulting sequence.
int	sorted(int index)	Returns a sorted pre value.
void	toggle(int pre)	Adds or removes the specified pre node.
void	union(int[] pre)	Merges the specified array with the existing pre nodes.

Methods inherited from class org.basex.query.value.seq.DBNodeSeq

all, atomValue, data, ddo, ebv, get, get, get, plan, pre, pres, reverse

Methods inherited from class org.basex.query.value.seq.Seq

copyInsert, description, get, hash, initialCapacity, insertBefore, item, iter, plan, refineType, seqType, size, subSeq, subsequence, test, toErrorString, toJava

Methods inherited from class org.basex.query.value.Value

accept, checkUp, compile, copy, count, exprSize, has, inline, inlineable, isEmpty, isItem, iter, iterator, materialize, serialize, serialize, serialize, value

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

arg, args, atomItem, atomIter, data, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, optimize, simplifyFor, typeCheck, uses, vacuous, visitAll

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

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

DBNodes

public DBNodes(Data data,
 int... pres)

Constructor, specifying a database and pre values.

Parameters:

data - data reference

pres - pre values

DBNodes

public DBNodes(Data data,
 boolean all,
 int... pres)

Constructor, specifying a database, pre values and full-text positions.

Parameters:

all - pre values reference all documents of the database

data - data reference

pres - pre values

Method Details

ftpos

public DBNodes ftpos(FTPosData ft)

Assigns full-text position data.

Parameters:

ft - full-text positions

Returns:

self reference

ftpos

public FTPosData ftpos()

Returns full-text position data.

Returns:

position data

discardDocs

public DBNodes discardDocs()

Returns null if the pre values reference all documents of the database.

Returns:

self reference or null

contains

public boolean contains(int pre)

Checks if the specified node is contained in the array.

Parameters:

pre - pre value

Returns:

true if the node was found

find

public int find(int pre)

Returns the position of the specified node or the negative value - 1 of the position where it should have been found.

Parameters:

pre - pre value

Returns:

position, or -1

toggle

public void toggle(int pre)

Adds or removes the specified pre node.

Parameters:

pre - pre value

union

public void union(int[] pre)

Merges the specified array with the existing pre nodes.

Parameters:

pre - pre value

sorted

public int sorted(int index)

Returns a sorted pre value.

Parameters:

index - index of pre value

Returns:

pre value

itemAt

public DBNode itemAt(long pos)

Description copied from class: Value

Returns the item at the given position in the value. The specified value must be lie within the valid bounds.

Overrides:

itemAt in class DBNodeSeq

Parameters:

pos - position

Returns:

item

equals

public boolean equals(Object obj)

Description copied from class: Expr

This function is e.g. called by:

• If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
• CmpR.mergeEbv(Expr, boolean, CompileContext) or CmpSR.mergeEbv(Expr, boolean, CompileContext), in order to merge expressions with identical input.
• CmpG.optimize(CompileContext) or CmpV.optimize(CompileContext), in order to pre-evaluate equality tests.
• CmpG.optimize(CompileContext) or Pos.get(Expr, CmpV.OpV, InputInfo, CompileContext), in order to compare the start and end value.
• PathCache, in order to find identical root values at runtime.

Overrides:

equals in class DBNodeSeq

cache

public final void cache(boolean lazy,
 InputInfo ii)

Description copied from class: Value

Caches lazy values.

Specified by:

cache in class Value

Parameters:

lazy - lazy caching

ii - input info

atomSize

public final long atomSize()

Description copied from class: Value

Computes the number of atomized items.

Specified by:

atomSize in class Value

Returns:

atomized item

insert

public final Value insert(long pos,
 Item item,
 QueryContext qc)

Inserts an item at the given position into this sequence and returns the resulting sequence. Because this function will mostly be invoked recursively, the standard implementation will be called, because its runtime outweighs the possibly higher memory consumption.

Specified by:

insert in class Seq

Parameters:

pos - position at which the item should be inserted, must be between 0 and Seq.size

item - item to insert

qc - query context

Returns:

resulting value

remove

public final Value remove(long pos,
 QueryContext qc)

Removes the item at the given position in this sequence and returns the resulting sequence. Because this function will mostly be invoked recursively, the standard implementation will be called, because its runtime outweighs the possibly higher memory consumption.

Specified by:

remove in class Seq

Parameters:

pos - position of the item to remove, must be between 0 and Seq.size - 1

qc - query context

Returns:

resulting sequence