Package com.saxonica.functions.sql

Class SQLFunctionSet

java.lang.Object

net.sf.saxon.functions.registry.BuiltInFunctionSet

com.saxonica.functions.sql.SQLFunctionSet

All Implemented Interfaces:

FunctionLibrary

public class SQLFunctionSet
extends BuiltInFunctionSet

The SQLFunctionSet is a set of Saxon vendor-supplied extension functions designed to enable access to SQL databases

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet

BuiltInFunctionSet.Entry

Field Summary

Fields

Modifier and Type	Field	Description
protected Configuration	config

Fields inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet

ABS, AS_ARG0, AS_PRIM_ARG0, BASE, CARD0, CDOC, CITEM, CTRL, DCOLL, DEPENDS_ON_STATIC_CONTEXT, DLANG, EMPTY, FILTER, FOCUS, INS, LAST, LATE, NAV, NEW, NS, ONE, OPT, PLUS, POSN, SEQV, SIDE, STAR, TRA, UO

Constructor Summary

Constructors

Constructor	Description
SQLFunctionSet()

Method Summary

Modifier and Type	Method	Description
static Connection	expectConnection(Sequence arg, XPathContext context)
String	getConventionalPrefix()	Return a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.
NamespaceUri	getNamespace()	Return the namespace URI for the functions local to this function set.
void	setConfiguration(Configuration config)	Supply details of the configuration in use.
static void	setSqlStatementParam(PreparedStatement ps, int index, Sequence value, XPathContext context)
static List<MapItem>	sqlQueryResult(ResultSet rs)
static void	supplyParameters(ParameterMetaData metaData, SequenceType[] parameterTypes)

Methods inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet

bind, copy, field, getFunctionDetails, getFunctionItem, importFunctionSet, isAvailable, makeFunction, register, register, registerVariadic

Methods inherited from class java.lang.Object

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

Field Details

config

protected Configuration config

Constructor Details

SQLFunctionSet

public SQLFunctionSet()

Method Details

setConfiguration

public void setConfiguration(Configuration config)

Description copied from interface: FunctionLibrary

Supply details of the configuration in use.

Parameters:

config - the configuration. The default implementation does nothing (many function libraries do not need to know any configuration details)

sqlQueryResult

public static List<MapItem> sqlQueryResult(ResultSet rs)
                                    throws SQLException

Throws:

SQLException

setSqlStatementParam

public static void setSqlStatementParam(PreparedStatement ps,
 int index,
 Sequence value,
 XPathContext context)
                                 throws XPathException

Throws:

XPathException

supplyParameters

public static void supplyParameters(ParameterMetaData metaData,
 SequenceType[] parameterTypes)
                             throws SQLException

Throws:

SQLException

expectConnection

public static Connection expectConnection(Sequence arg,
 XPathContext context)
                                   throws XPathException

Throws:

XPathException

getNamespace

public NamespaceUri getNamespace()

Return the namespace URI for the functions local to this function set.

Overrides:

getNamespace in class BuiltInFunctionSet

Returns:

the namespace URI of the functions local to this function set. Note that functions imported from another function set may have a different namespace URI.

getConventionalPrefix

public String getConventionalPrefix()

Description copied from class: BuiltInFunctionSet

Return a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.

Overrides:

getConventionalPrefix in class BuiltInFunctionSet

Returns:

the string "fn"