net.sf.saxon.functions

Class UnparsedTextFunction

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.UnparsedTextFunction

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

Direct Known Subclasses:

UnparsedText, UnparsedTextAvailable, UnparsedTextLines

public abstract class UnparsedTextFunction
extends SystemFunction

Abstract superclass containing common code supporting the functions unparsed-text(), unparsed-text-lines(), and unparsed-text-available()

Constructor Summary

Constructors

Constructor and Description
UnparsedTextFunction()

Method Summary

Modifier and Type	Method and Description
static java.net.URI	getAbsoluteURI(java.lang.String href, java.lang.String baseURI, XPathContext context)
protected static java.lang.String	getErrorCodePrefix(XPathContext context) Get the prefix of the error code for dynamic errors: "XTDE" for XSLT 2.0, "FOUT" for XPath 3.0
int	getSpecialProperties(Expression[] arguments) Determine the special properties of this function.
static XPathException	handleIOError(java.net.URI absoluteURI, java.io.IOException ioErr, XPathContext context)
static java.lang.CharSequence	readFile(IntPredicate checker, java.io.Reader reader, XPathContext context) Read the contents of an unparsed text file
static java.lang.CharSequence	readFile(java.net.URI absoluteURI, java.lang.String encoding, XPathContext context) Supporting routine to load one external file given a URI (href) and a baseURI

Methods inherited from class net.sf.saxon.functions.SystemFunction

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, isStreamed, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.Function

call, iterate

Methods inherited from interface net.sf.saxon.om.Item

head

Methods inherited from interface net.sf.saxon.om.GroundedValue

getLength, head, itemAt, reduce, subsequence

Constructor Detail

UnparsedTextFunction

public UnparsedTextFunction()

Method Detail

getSpecialProperties

public int getSpecialProperties(Expression[] arguments)

Description copied from class: SystemFunction

Determine the special properties of this function. The general rule is that a system function call is non-creative unless more details are defined in a subclass.

Overrides:

getSpecialProperties in class SystemFunction

Parameters:

arguments - the actual arguments supplied in a call to the function

getErrorCodePrefix

protected static java.lang.String getErrorCodePrefix(XPathContext context)

Get the prefix of the error code for dynamic errors: "XTDE" for XSLT 2.0, "FOUT" for XPath 3.0

Parameters:

context - the dynamic context

Returns:

the first four characters of the error code to be used

readFile

public static java.lang.CharSequence readFile(java.net.URI absoluteURI,
                                              java.lang.String encoding,
                                              XPathContext context)
                                       throws XPathException

Supporting routine to load one external file given a URI (href) and a baseURI

Parameters:

absoluteURI - the absolutized URI

encoding - the character encoding

context - the XPath dynamic context

Returns:

the content of the file

Throws:

XPathException - if the file cannot be read

getAbsoluteURI

public static java.net.URI getAbsoluteURI(java.lang.String href,
                                          java.lang.String baseURI,
                                          XPathContext context)
                                   throws XPathException

Throws:

XPathException

handleIOError

public static XPathException handleIOError(java.net.URI absoluteURI,
                                           java.io.IOException ioErr,
                                           XPathContext context)

readFile

public static java.lang.CharSequence readFile(IntPredicate checker,
                                              java.io.Reader reader,
                                              XPathContext context)
                                       throws java.io.IOException,
                                              XPathException

Read the contents of an unparsed text file

Parameters:

checker - predicate for checking whether characters are valid XML characters

reader - Reader to be used for reading the file

context - the XPath dynamic context

Returns:

a CharSequence representing the contents of the file

Throws:

java.io.IOException - if a failure occurs reading the file

XPathException - if the file contains illegal characters