net.sf.saxon.functions

Class UnparsedTextLines

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunctionCall

net.sf.saxon.functions.UnparsedTextFunction

net.sf.saxon.functions.UnparsedTextLines

All Implemented Interfaces:

SourceLocator, Callable, IdentityComparable, InstructionInfo

public class UnparsedTextLines
extends UnparsedTextFunction
implements Callable

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
UnparsedTextLines()

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] arguments) Evaluate the expression
Item	evaluateItem(XPathContext context) This method handles evaluation of the function: it returns a StringValue in the case of unparsed-text(), or a BooleanValue in the case of unparsed-text-available().
static URI	getAbsoluteURI(String href, String baseURI)
static XPathException	handleIOError(URI absoluteURI, IOException ioErr)
SequenceIterator	iterate(XPathContext context) Return an Iterator to iterate over the values of a sequence.
static void	main(String[] args)
static CharSequence	readFile(IntPredicate checker, Reader reader) 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.UnparsedTextFunction

checkArguments, computeSpecialProperties, getAbsoluteURI, getErrorCodePrefix, getExpressionBaseURI, handleIOError, preEvaluate, readFile

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, 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, 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

Constructor Detail

UnparsedTextLines

public UnparsedTextLines()

Method Detail

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

This method handles evaluation of the function: it returns a StringValue in the case of unparsed-text(), or a BooleanValue in the case of unparsed-text-available(). In the case of unparsed-text-lines() this shouldn't be called, but we deal with it anyway.

Overrides:

evaluateItem in class Expression

Parameters:

context - The context in which the expression is to be evaluated

Returns:

the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence

Throws:

XPathException - if any dynamic error occurs evaluating the expression

call

public Sequence call(XPathContext context,
            Sequence[] arguments)
              throws XPathException

Evaluate the expression

Specified by:

call in interface Callable

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as SequenceIterators

Returns:

the result of the evaluation, in the form of a SequenceIterator

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions. This default implementation handles iteration for expressions that return singleton values: for non-singleton expressions, the subclass must provide its own implementation.

Overrides:

iterate in class Expression

Parameters:

context - supplies the context for evaluation

Returns:

a SequenceIterator that can be used to iterate over the result of the expression

Throws:

XPathException - if any dynamic error occurs evaluating the expression

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

Overrides:

readFile in class UnparsedTextFunction

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)
                          throws XPathException

Throws:

XPathException

handleIOError

public static XPathException handleIOError(URI absoluteURI,
                           IOException ioErr)

readFile

public static CharSequence readFile(IntPredicate checker,
                    Reader reader)
                             throws IOException,
                                    XPathException

Read the contents of an unparsed text file

Parameters:

checker - NameChecker for checking whether characters are valid XML characters

reader - Reader to be used for reading the file

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

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception