Class DocAvailable

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.DocAvailable

All Implemented Interfaces:

Serializable, SourceLocator, LocationProvider, SaxonLocator, InstructionInfo, Locator

public class DocAvailable
extends SystemFunction

Implement the fn:doc-available() function

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocAvailable.ErrorDiscarder

Field Summary

Fields inherited from class SystemFunction

operation

Fields inherited from class FunctionCall

argument

Fields inherited from class 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

Constructors

Constructor	Description
DocAvailable()

Method Summary

Modifier and Type	Method	Description
void	checkArguments(ExpressionVisitor visitor)	Method called during static type checking
boolean	docAvailable(String href, XPathContext context)
Item	evaluateItem(XPathContext context)	Evaluate the expression
String	getStaticBaseURI()	Get the static base URI of the expression
Expression	preEvaluate(ExpressionVisitor visitor)	preEvaluate: this method suppresses compile-time evaluation by doing nothing

Methods inherited from class SystemFunction

addContextDocumentArgument, addDocToPathMap, computeCardinality, computeSpecialProperties, copy, equals, getDetails, getErrorCodeForTypeErrors, getImplementationMethod, getItemType, getOperation, getRequiredType, makeSystemFunction, optimize, setDetails, useContextItemAsDefault

Methods inherited from class FunctionCall

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

Methods inherited from class 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, iterate, iterateEvents, iterateSameFocusSubExpressions, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeError

Methods inherited from class Object

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

Constructor Details

DocAvailable

public DocAvailable()

Method Details

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 - if the arguments are incorrect

getStaticBaseURI

public String getStaticBaseURI()

Get the static base URI of the expression

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

Evaluate the expression

Overrides:

evaluateItem in class Expression

Parameters:

context -

Returns:

the result of evaluating the expression (a BooleanValue)

Throws:

XPathException

docAvailable

public boolean docAvailable(String href,
 XPathContext context)
                     throws XPathException

Throws:

XPathException