Previous  Top  Next

IXQuery

Interface for the XQuery engine. Public interface that extends IAltovaXMLEngine and IExecutable.

Superinterface: IAltovaXMLEngine, IExecutable,  IReleasable

Implementing classes: XQuery

Methods

The following methods are defined.

setXQueryFileName

public void setXQueryFileName(java.lang.String filename)

Sets the file name of the XQuery document.

Parameters:

filename: an absolute URL giving the base location of the XQuery file.

setXQueryStatement

public void setXQueryStatement(java.lang.String text)

Sets the text value of the XQuery statement.

Parameters:

text: a string containing the XQuery statement.

setOutputEncoding

public void setOutputEncoding(java.lang.String encoding)

Sets the encoding of the result document.

Parameters:

encoding: a string containing the name of the encoding name (for example: UTF-8, UTF-16, ASCII, 8859-1, 1252).

getOutputEncoding

public java.lang.String getOutputEncoding()

Retrieves the encoding specified for the result document.

Returns:

a string containing an encoding name.

setOutputIndent

public void setOutputIndent(boolean indent)

Enables/disables the indentation option for the result document.

Parameters:

indent: boolean value to enable/disable output indentation.

getOutputIndent

public boolean getOutputIndent()

Retrieves the output indent option specified for the result document.

Returns:

boolean value indicating whether output is indented (true) or not (false).

setOutputMethod

public void setOutputMethod(java.lang.String method)

Sets the serialization method for the result document.

Parameters:

method: a string containing the serialization method. (Valid values are: xml, xhtml, html, text).

getOutputMethod

public java.lang.String getOutputMethod()

Retrieves the serialization method for the result document.

Returns:

a string containing the serialization method for the output document.

setOutputOmitXMLDeclaration

public void setOutputOmitXMLDeclaration(boolean decl)

Enables/disables the serialization option omitXMLDeclaration for the result document.

Parameters:

decl: new boolean value for the omit-xml-declaration parameter.

getOutputOmitXMLDeclaration

public boolean getOutputOmitXMLDeclaration()

Retrieve the value of omitXMLDeclaration option specified for the result document.

Returns:

boolean value indicating whether output document contains an XML declaration (true) or not (false).

addExternalVariable

public void addExternalVariable(java.lang.String name,

                               java.lang.String val)

Add name and value for an external variable.

Parameters:

name: a string containing a valid QName as the variable name.

val: a string containing the value of the variable; the value will be used as a string.

addExternalVariableAsXPath

public void addExternalVariableAsXPath(java.lang.String name,

                               java.lang.String val)

Add name and value for an external variable, with value being evaluated as an XPath 2.0 expression.

Parameters:

name: a string containing a valid QName as the variable name.

val: a string containing the value of the variable; the value will be evaluated as an XPath 2.0 expression.

clearExternalVariableList

public void clearExternalVariableList()

Clears the list of external variables.