Package com.saxonica.functions.extfn

Class EXPathFileFunctionSet

java.lang.Object

net.sf.saxon.functions.registry.BuiltInFunctionSet

com.saxonica.functions.extfn.EXPathFileFunctionSet

All Implemented Interfaces:

FunctionLibrary

public class EXPathFileFunctionSet
extends BuiltInFunctionSet

Implementation of the file:base-dir function in the EXPath file library. Other functions in this library are implemented as reflexive extension functions, but this one can't be implemented this way because it needs access to the static context.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EXPathFileFunctionSet.EXPathFileFunction
static class	EXPathFileFunctionSet.FileAppend
static class	EXPathFileFunctionSet.FileAppendBinary
static class	EXPathFileFunctionSet.FileAppendText
static class	EXPathFileFunctionSet.FileAppendTextLines
static class	EXPathFileFunctionSet.FileBaseDir
static class	EXPathFileFunctionSet.FileChildren
static class	EXPathFileFunctionSet.FileCopy
static class	EXPathFileFunctionSet.FileCreateDir
static class	EXPathFileFunctionSet.FileCreateTempDir
static class	EXPathFileFunctionSet.FileCreateTempFile
static class	EXPathFileFunctionSet.FileCurrentDir
static class	EXPathFileFunctionSet.FileDelete
static class	EXPathFileFunctionSet.FileDirSeparator
static class	EXPathFileFunctionSet.FileExists
static class	EXPathFileFunctionSet.FileIsDir
static class	EXPathFileFunctionSet.FileIsFile
static class	EXPathFileFunctionSet.FileLastModified
static class	EXPathFileFunctionSet.FileLineSeparator
static class	EXPathFileFunctionSet.FileList
static class	EXPathFileFunctionSet.FileMove
static class	EXPathFileFunctionSet.FileName
static class	EXPathFileFunctionSet.FileParent
static class	EXPathFileFunctionSet.FilePathSeparator
static class	EXPathFileFunctionSet.FilePathToNative
static class	EXPathFileFunctionSet.FilePathToUri
static class	EXPathFileFunctionSet.FileReadBinary
static class	EXPathFileFunctionSet.FileReadText
static class	EXPathFileFunctionSet.FileReadTextLines
static class	EXPathFileFunctionSet.FileResolvePath
static class	EXPathFileFunctionSet.FileSize
static class	EXPathFileFunctionSet.FileTempDir
static class	EXPathFileFunctionSet.FileWrite
static class	EXPathFileFunctionSet.FileWriteBinary
static class	EXPathFileFunctionSet.FileWriteText
static class	EXPathFileFunctionSet.FileWriteTextLines

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

BuiltInFunctionSet.Entry

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_INDEX_OUT_OF_BOUNDS
static java.lang.String	ERROR_IO
static java.lang.String	ERROR_NAMESPACE
static java.lang.String	ERROR_PREFIX
static java.lang.String	NAMESPACE
static java.lang.String	NEWLINE
static java.lang.String	PREFIX
static BigDecimalValue	VERSION

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

Method Summary

Modifier and Type	Method	Description
static java.lang.String	_parent(java.lang.String path)
static void	error(java.lang.String message, java.lang.Exception cause, java.lang.String code)	Throw an error
static void	error(java.lang.String message, java.lang.String code)	Throw an error
java.lang.String	getConventionalPrefix()	Return a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.
static EXPathFileFunctionSet	getInstance()
java.lang.String	getNamespace()	Return the namespace URI for the functions local to this function set.

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

bind, copy, getFunctionDetails, getFunctionItem, importFunctionSet, isAvailable, makeFunction, register, registerReducedArityVariants

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.functions.FunctionLibrary

setConfiguration

Field Detail

VERSION

public static final BigDecimalValue VERSION

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

ERROR_NAMESPACE

public static final java.lang.String ERROR_NAMESPACE

See Also:

Constant Field Values

ERROR_PREFIX

public static final java.lang.String ERROR_PREFIX

See Also:

Constant Field Values

ERROR_INDEX_OUT_OF_BOUNDS

public static final java.lang.String ERROR_INDEX_OUT_OF_BOUNDS

See Also:

Constant Field Values

ERROR_IO

public static final java.lang.String ERROR_IO

See Also:

Constant Field Values

NEWLINE

public static final java.lang.String NEWLINE

Method Detail

getInstance

public static EXPathFileFunctionSet getInstance()

getNamespace

public java.lang.String getNamespace()

Description copied from class: BuiltInFunctionSet

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 java.lang.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"

error

public static void error(java.lang.String message,
                         java.lang.String code)
                  throws XPathException

Throw an error

Parameters:

message - the error message

code - the error code to be used

Throws:

XPathException - always

error

public static void error(java.lang.String message,
                         java.lang.Exception cause,
                         java.lang.String code)
                  throws XPathException

Throw an error

Parameters:

message - the error message

cause - the underlying exception, usually an IOException

code - the error code to be used

Throws:

XPathException - always

_parent

public static java.lang.String _parent(java.lang.String path)
                                throws XPathException

Throws:

XPathException