net.sf.saxon.functions

Class UnparsedTextFunction

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunctionCall

net.sf.saxon.functions.UnparsedTextFunction

All Implemented Interfaces:

SourceLocator, Callable, IdentityComparable, InstructionInfo

Direct Known Subclasses:

UnparsedText, UnparsedTextAvailable, UnparsedTextLines

public abstract class UnparsedTextFunction
extends SystemFunctionCall
implements Callable

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

Field Summary

Fields inherited from class net.sf.saxon.functions.SystemFunctionCall

operation

Fields inherited from class net.sf.saxon.expr.FunctionCall

argument

Fields inherited from class net.sf.saxon.expr.Expression

EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD

Constructor Summary

Constructors

Constructor and Description
UnparsedTextFunction()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkArguments(ExpressionVisitor visitor) Method called during static type checking
int	computeSpecialProperties() Determine the special properties of this expression.
static URI	getAbsoluteURI(String href, String baseURI, XPathContext context)
protected static String	getErrorCodePrefix(XPathContext context) Get the prefix of the error code for dynamic errors: "XTDE" for XSLT 2.0, "FOUT" for XPath 3.0
String	getExpressionBaseURI() getExpressionBaseURI: this method returns the expression base URI
static XPathException	handleIOError(URI absoluteURI, IOException ioErr, XPathContext context)
Expression	preEvaluate(ExpressionVisitor visitor) preEvaluate: this method suppresses compile-time evaluation by doing nothing
static CharSequence	readFile(IntPredicate checker, Reader reader, XPathContext context) Read the contents of an unparsed text file
CharSequence	readFile(String href, String baseURI, 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.SystemFunctionCall

addContextDocumentArgument, addDocToPathMap, bindStaticContext, computeCardinality, copy, equalOrNull, equals, getContextNode, getConvertingCallable, getDefaultArgumentNode, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getImplementationMethod, getItemType, getOperation, getRequiredType, makeSystemFunction, operands, optimize, setDetails, toShortString, useContextItemAsDefault

Methods inherited from class net.sf.saxon.expr.FunctionCall

addExternalFunctionCallToPathMap, checkArgumentCount, explain, getArguments, getDisplayName, getExpressionName, getFunctionName, getNumberOfArguments, hashCode, promote, replaceOperand, setArguments, setFunctionName, simplifyArguments, toString, typeCheck

Methods inherited from class net.sf.saxon.expr.Expression

addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, clearStreamabilityData, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getConfiguration, getConstructType, getContainer, getDependencies, getEvaluationMethod, getExpressionCompiler, getHostLanguage, getIntegerBounds, getIntrinsicDependencies, getLineNumber, getLocationId, getObjectName, getPosture, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getStreamability, getStreamingAdjunct, getSweep, getSystemId, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isIdentical, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterate, iterateEvents, makeStreamingAdjunct, markTailFunctionCalls, operandList, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, setPostureAndSweep, simplify, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, typeError, unordered

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.expr.Callable

call

Constructor Detail

UnparsedTextFunction

public UnparsedTextFunction()

Method Detail

checkArguments

public void checkArguments(ExpressionVisitor visitor)
                    throws XPathException

Description copied from class: SystemFunctionCall

Method called during static type checking

Overrides:

checkArguments in class SystemFunctionCall

Parameters:

visitor - the expression visitor

Throws:

XPathException - if the arguments are incorrect

getExpressionBaseURI

public String getExpressionBaseURI()

getExpressionBaseURI: this method returns the expression base URI

Returns:

the static base URI if known, otherwise null

preEvaluate

public Expression preEvaluate(ExpressionVisitor visitor)

preEvaluate: this method suppresses compile-time evaluation by doing nothing

Overrides:

preEvaluate in class FunctionCall

Parameters:

visitor - an expression visitor

Returns:

the result of the early evaluation, or the original expression, or potentially a simplified expression

computeSpecialProperties

public int computeSpecialProperties()

Description copied from class: SystemFunctionCall

Determine the special properties of this expression. The general rule is that a system function call is non-creative if its return type is atomic, or if all its arguments are non-creative. This is overridden for the generate-id() function, which is considered creative if its operand is creative (because the result depends on the identity of the operand)

Overrides:

computeSpecialProperties in class SystemFunctionCall

Returns:

the special properties, as a bit-significant integer

getErrorCodePrefix

protected static 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 CharSequence readFile(String href,
                    String baseURI,
                    String encoding,
                    XPathContext context)
                      throws XPathException

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

Parameters:

href - the relative URI

baseURI - the base 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 URI getAbsoluteURI(String href,
                 String baseURI,
                 XPathContext context)
                          throws XPathException

Throws:

XPathException

handleIOError

public static XPathException handleIOError(URI absoluteURI,
                           IOException ioErr,
                           XPathContext context)

readFile

public static CharSequence readFile(IntPredicate checker,
                    Reader reader,
                    XPathContext context)
                             throws 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:

IOException - if a failure occurs reading the file

XPathException - if the file contains illegal characters