net.sf.saxon.functions
Class UnparsedTextLines

java.lang.Object
  extended by net.sf.saxon.expr.Expression
      extended by net.sf.saxon.expr.FunctionCall
          extended by net.sf.saxon.functions.SystemFunction
              extended by net.sf.saxon.functions.UnparsedText
                  extended by net.sf.saxon.functions.UnparsedTextLines
All Implemented Interfaces:
Serializable, SourceLocator, LocationProvider, SaxonLocator, CallableExpression, InstructionInfo, Locator

public class UnparsedTextLines
extends UnparsedText
implements CallableExpression

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.functions.SystemFunction
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, EVENT_FEED_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD
 
Constructor Summary
UnparsedTextLines()
           
 
Method Summary
 SequenceIterator call(SequenceIterator[] arguments, XPathContext context)
          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(NameChecker 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.UnparsedText
checkArguments, computeSpecialProperties, evalUnparsedText, getExpressionBaseURI, preEvaluate
 
Methods inherited from class net.sf.saxon.functions.SystemFunction
addContextDocumentArgument, addDocToPathMap, computeCardinality, copy, equals, getDetails, getErrorCodeForTypeErrors, getImplementationMethod, getItemType, getOperation, getRequiredType, makeSystemFunction, optimize, setDetails, useContextItemAsDefault
 
Methods inherited from class net.sf.saxon.expr.FunctionCall
addExternalFunctionCallToPathMap, checkArgumentCount, explain, getArguments, getDisplayName, getExpressionName, getFunctionName, getNumberOfArguments, hashCode, iterateSubExpressions, promote, replaceSubExpression, setArguments, setFunctionName, simplify, simplifyArguments, toString, typeCheck
 
Methods inherited from class net.sf.saxon.expr.Expression
addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getEvaluationMethod, getExecutable, getHostLanguage, getIntegerBounds, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, hasVariableBinding, implementsStaticTypeCheck, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterateEvents, iterateSameFocusSubExpressions, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeError
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.sf.saxon.expr.CallableExpression
getArguments
 

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 UnparsedText
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 SequenceIterator call(SequenceIterator[] arguments,
                             XPathContext context)
                      throws XPathException
Evaluate the expression

Specified by:
call in interface CallableExpression
Overrides:
call in class UnparsedText
Parameters:
arguments - the values of the arguments, supplied as SequenceIterators
context - the dynamic evaluation context
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 UnparsedText
Throws:
XPathException

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(NameChecker 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


Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.