com.ihr.xbrl.om

Class XBRLRSCustomFunctionLibraryAbstract<T extends FunctionCallWithDetails>

java.lang.Object

com.ihr.xbrl.om.XBRLRSCustomFunctionLibraryAbstract<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

net.sf.saxon.functions.FunctionLibrary

Direct Known Subclasses:

IXT1FunctionLibrary, IXT2FunctionLibrary, IXT3FunctionLibrary, IXT4FunctionLibrary, IXVFunctionLibrary, RSTableFunctionLibrary, XBRLFPRSCustomFunctionLibraryAbstract

public abstract class XBRLRSCustomFunctionLibraryAbstract<T extends FunctionCallWithDetails>
extends java.lang.Object
implements net.sf.saxon.functions.FunctionLibrary

This class in an implementation of the XBRLRSCustomFunctionLibrary interface that helps implementing new functions.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XBRLRSCustomFunctionLibraryAbstract()

Method Summary

Modifier and Type	Method and Description
net.sf.saxon.expr.Expression	bind(net.sf.saxon.trans.SymbolicName symName, net.sf.saxon.expr.Expression[] staticArgs, net.sf.saxon.expr.StaticContext env, net.sf.saxon.expr.Container container) Bind.
net.sf.saxon.functions.FunctionLibrary	copy() Copy.
abstract net.sf.saxon.functions.StandardFunction.Entry	getFunction(java.lang.String local, int arity) Returns the implementation of a specific function providing the function local name and the arity.
net.sf.saxon.om.FunctionItem	getFunctionItem(net.sf.saxon.trans.SymbolicName symName, net.sf.saxon.expr.StaticContext staticContext, net.sf.saxon.expr.Container container) Gets the function item.
abstract java.lang.String	getFunctionLibraryPrefix() Returns the custom function library prefix.
abstract java.lang.String	getFunctionLibraryURI() returns the custom function library URI.
net.sf.saxon.value.SequenceType[]	getFunctionSignature(net.sf.saxon.om.StructuredQName functionName, int arity) Gets the function signature.
boolean	isAvailable(net.sf.saxon.trans.SymbolicName symName) Checks if is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLRSCustomFunctionLibraryAbstract

public XBRLRSCustomFunctionLibraryAbstract()

Method Detail

getFunctionLibraryURI

public abstract java.lang.String getFunctionLibraryURI()

returns the custom function library URI.

Returns:

String

getFunctionLibraryPrefix

public abstract java.lang.String getFunctionLibraryPrefix()

Returns the custom function library prefix.

Returns:

String

getFunction

public abstract net.sf.saxon.functions.StandardFunction.Entry getFunction(java.lang.String local,
                                                                          int arity)

Returns the implementation of a specific function providing the function local name and the arity.

Parameters:

local - function local name

arity - number of arguments

Returns:

StandardFunction.Entry

copy

public net.sf.saxon.functions.FunctionLibrary copy()

Copy.

Specified by:

copy in interface net.sf.saxon.functions.FunctionLibrary

Returns:

the function library

isAvailable

public boolean isAvailable(net.sf.saxon.trans.SymbolicName symName)

Checks if is available.

Specified by:

isAvailable in interface net.sf.saxon.functions.FunctionLibrary

Parameters:

symName - the Symbolic name

Returns:

true, if is available

getFunctionSignature

public net.sf.saxon.value.SequenceType[] getFunctionSignature(net.sf.saxon.om.StructuredQName functionName,
                                                              int arity)

Gets the function signature.

Parameters:

functionName - the function name

arity - the arity

Returns:

the function signature

bind

public net.sf.saxon.expr.Expression bind(net.sf.saxon.trans.SymbolicName symName,
                                         net.sf.saxon.expr.Expression[] staticArgs,
                                         net.sf.saxon.expr.StaticContext env,
                                         net.sf.saxon.expr.Container container)
                                  throws net.sf.saxon.trans.XPathException

Bind.

Specified by:

bind in interface net.sf.saxon.functions.FunctionLibrary

Parameters:

symName - the sym name

staticArgs - the static args

env - the env

container - the container

Returns:

the expression

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getFunctionItem

public net.sf.saxon.om.FunctionItem getFunctionItem(net.sf.saxon.trans.SymbolicName symName,
                                                    net.sf.saxon.expr.StaticContext staticContext,
                                                    net.sf.saxon.expr.Container container)
                                             throws net.sf.saxon.trans.XPathException

Gets the function item.

Specified by:

getFunctionItem in interface net.sf.saxon.functions.FunctionLibrary

Parameters:

symName - the sym name

staticContext - the static context

container - the container

Returns:

the function item

Throws:

net.sf.saxon.trans.XPathException - the x path exception