com.sleepycat.dbxml

Class XmlStackFrame

java.lang.Object

com.sleepycat.dbxml.XmlStackFrame

public class XmlStackFrame
extends java.lang.Object

The XmlStackFrame class provides stack trace information about an executing query to the methods of XmlDebugListener. XmlStackFrame objects describe a stack frame in the stack trace and includes a pointer to the previous stack frame.

Constructor Summary

Constructors

Constructor and Description
XmlStackFrame()

Method Summary

Modifier and Type	Method and Description
XmlStackFrame	getPreviousStackFrame() Returns the previous stack frame or null if this is the first stack frame.
int	getQueryColumn() Returns the column number of the position in the query represented by this stack frame.
java.lang.String	getQueryFile() Returns the URI of the query represented by this stack frame.
int	getQueryLine() Returns the line number of the position in the query represented by this stack frame.
java.lang.String	getQueryPlan() Returns the query plan of the sub-expression represented by this stack frame.
XmlResults	query(java.lang.String queryString) Prepares and executes the query given in the dynamic context of the stack frame.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlStackFrame

public XmlStackFrame()

Method Detail

getQueryFile

public java.lang.String getQueryFile()
                              throws XmlException

Returns the URI of the query represented by this stack frame.

Throws:

XmlException

getQueryLine

public int getQueryLine()
                 throws XmlException

Returns the line number of the position in the query represented by this stack frame.

Throws:

XmlException

getQueryColumn

public int getQueryColumn()
                   throws XmlException

Returns the column number of the position in the query represented by this stack frame.

Throws:

XmlException

query

public XmlResults query(java.lang.String queryString)
                 throws XmlException

Prepares and executes the query given in the dynamic context of the stack frame. This can be used to examine the value of the context item (".") or variables ("$var") for a given stack frame as well as other parts of the dynamic context. Users may find that the context item and variables present in their original query do not exist during query execution due to optimization performed by DB XML.

Parameters:

queryString - The query expression to prepare and execute.

Throws:

XmlException

getQueryPlan

public java.lang.String getQueryPlan()
                              throws XmlException

Returns the query plan of the sub-expression represented by this stack frame.

Throws:

XmlException

getPreviousStackFrame

public XmlStackFrame getPreviousStackFrame()
                                    throws XmlException

Returns the previous stack frame or null if this is the first stack frame.

Throws:

XmlException