|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.basex.query.util.inspect.Inspect
public abstract class Inspect
This class contains functions for inspecting XQuery modules and generating XQuery documentation.
Field Summary | |
---|---|
protected QueryContext |
ctx
Query context. |
protected InputInfo |
info
Input info. |
protected StaticScope |
module
Parsed main module. |
Constructor Summary | |
---|---|
protected |
Inspect(QueryContext qc,
InputInfo ii)
Constructor. |
Method Summary | |
---|---|
static void |
add(byte[] value,
Context ctx,
FElem elem)
Parses a string as XML and adds the resulting nodes to the specified parent. |
protected void |
annotation(Ann ann,
FElem parent,
boolean uri)
Creates annotation child elements. |
protected void |
comment(TokenObjMap<TokenList> tags,
FElem parent)
Creates a comment sub element. |
static byte[] |
doc(TokenObjMap<TokenList> doc,
byte[] name)
Returns a value for the specified parameter, or null . |
protected abstract FElem |
elem(java.lang.String name,
FElem parent)
Creates an element. |
abstract FElem |
parse(IO io)
Parses a module and returns an inspection element. |
QueryParser |
parseQuery(IO io)
Parses a module. |
protected abstract FElem |
tag(byte[] tag,
FElem parent)
Creates a new element for the specified tag. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final QueryContext ctx
protected final InputInfo info
protected StaticScope module
Constructor Detail |
---|
protected Inspect(QueryContext qc, InputInfo ii)
qc
- query contextii
- input infoMethod Detail |
---|
public abstract FElem parse(IO io) throws QueryException
io
- input reference
QueryException
- query exceptionpublic final QueryParser parseQuery(IO io) throws QueryException
io
- input reference
QueryException
- query exceptionprotected final void comment(TokenObjMap<TokenList> tags, FElem parent)
tags
- map with tagsparent
- parent elementprotected final void annotation(Ann ann, FElem parent, boolean uri) throws QueryException
ann
- annotationsparent
- parent elementuri
- include uri
QueryException
- query exceptionprotected abstract FElem tag(byte[] tag, FElem parent)
tag
- tagparent
- parent element
protected abstract FElem elem(java.lang.String name, FElem parent)
name
- name of elementparent
- parent element
public static void add(byte[] value, Context ctx, FElem elem)
ctx
- database contextvalue
- string to parseelem
- elementpublic static byte[] doc(TokenObjMap<TokenList> doc, byte[] name)
null
.
doc
- documentationname
- parameter name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |