net.sf.saxon.functions
Class UnparsedText
java.lang.Object
net.sf.saxon.expr.Expression
net.sf.saxon.expr.FunctionCall
net.sf.saxon.functions.SystemFunction
net.sf.saxon.functions.UnparsedText
- All Implemented Interfaces:
- java.io.Serializable, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, EvaluableItem, SequenceIterable, InstructionInfo, org.xml.sax.Locator
public class UnparsedText
- extends SystemFunction
- See Also:
- Serialized Form
Method Summary |
void |
checkArguments(ExpressionVisitor visitor)
Method called during static type checking |
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 void |
main(java.lang.String[] args)
|
Expression |
preEvaluate(ExpressionVisitor visitor)
preEvaluate: this method suppresses compile-time evaluation by doing nothing |
static java.lang.CharSequence |
readFile(NameChecker checker,
java.io.Reader reader)
Read the contents of an unparsed text file |
Methods inherited from class net.sf.saxon.functions.SystemFunction |
addContextDocumentArgument, addDocToPathMap, computeCardinality, computeSpecialProperties, copy, getDetails, getErrorCodeForTypeErrors, getItemType, getRequiredType, makeSystemFunction, optimize, setDetails, useContextItemAsDefault |
Methods inherited from class net.sf.saxon.expr.FunctionCall |
addExternalFunctionCallToPathMap, checkArgumentCount, equals, explain, getArguments, getDisplayName, 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, getExecutable, getHostLanguage, getImplementationMethod, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterate, iterateEvents, iterateSameFocusSubExpressions, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeError |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
expressionBaseURI
java.lang.String expressionBaseURI
UNPARSED_TEXT
public static final int UNPARSED_TEXT
- See Also:
- Constant Field Values
UNPARSED_TEXT_AVAILABLE
public static final int UNPARSED_TEXT_AVAILABLE
- See Also:
- Constant Field Values
UnparsedText
public UnparsedText()
checkArguments
public void checkArguments(ExpressionVisitor visitor)
throws XPathException
- Description copied from class:
SystemFunction
- Method called during static type checking
- Overrides:
checkArguments
in class SystemFunction
- Parameters:
visitor
- the expression visitor
- Throws:
XPathException
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
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()
- Specified by:
evaluateItem
in interface EvaluableItem
- 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
readFile
public static java.lang.CharSequence readFile(NameChecker checker,
java.io.Reader reader)
throws java.io.IOException,
XPathException
- Read the contents of an unparsed text file
- Parameters:
checker
- NameChecker for checking whether characters are valid XML charactersreader
- Reader to be used for reading the file
- 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
main
public static void main(java.lang.String[] args)
throws java.lang.Exception
- Throws:
java.lang.Exception