|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.expr.Expression
net.sf.saxon.expr.FunctionCall
net.sf.saxon.functions.SystemFunction
net.sf.saxon.functions.Doc
public class Doc
Implement the fn:doc() function - a simplified form of the Document function
| 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 | |
|---|---|
Doc()
|
|
| Method Summary | |
|---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap. |
SequenceIterator |
call(SequenceIterator[] arguments,
XPathContext context)
Evaluate the expression |
void |
checkArguments(ExpressionVisitor visitor)
Method called during static type checking |
int |
computeCardinality()
Determine the cardinality of the function. |
int |
computeSpecialProperties()
Get the static properties of this expression (other than its type). |
Expression |
copy()
Copy an expression. |
boolean |
equals(Object o)
Determine whether two expressions are equivalent |
Item |
evaluateItem(XPathContext context)
Evaluate the expression |
String |
getStaticBaseURI()
Get the static base URI of the expression |
boolean |
isReadOnce()
Ask whether this document has been marked as being read once only. |
Expression |
preEvaluate(ExpressionVisitor visitor)
preEvaluate: this method suppresses compile-time evaluation unless a configuration option has been set to allow early evaluation. |
void |
sendDocument(XPathContext context,
Receiver out)
Copy the document identified by this expression to a given Receiver. |
void |
setReadOnce(boolean once)
Indicate that the document will be read once only (or that it should be treated as if it is read once only. |
| Methods inherited from class net.sf.saxon.functions.SystemFunction |
|---|
addContextDocumentArgument, addDocToPathMap, 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 java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface net.sf.saxon.expr.CallableExpression |
|---|
getArguments |
| Constructor Detail |
|---|
public Doc()
| Method Detail |
|---|
public void setReadOnce(boolean once)
once - true if this document is to be treated as being read once onlypublic boolean isReadOnce()
public void checkArguments(ExpressionVisitor visitor)
throws XPathException
SystemFunction
checkArguments in class SystemFunctionvisitor - the expression visitor
XPathException - if the arguments are incorrectpublic String getStaticBaseURI()
public Expression preEvaluate(ExpressionVisitor visitor)
preEvaluate in class FunctionCallvisitor - an expression visitor
public int computeCardinality()
SystemFunction
computeCardinality in class SystemFunctionStaticProperty.ALLOWS_ZERO_OR_ONE,
StaticProperty.EXACTLY_ONE, StaticProperty.ALLOWS_ONE_OR_MORE,
StaticProperty.ALLOWS_ZERO_OR_MORE
public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
addToPathMap in class ExpressionpathMap - the PathMap to which the expression should be addedpathMapNodeSet -
public Expression copy()
copy in class SystemFunctionpublic boolean equals(Object o)
equals in class SystemFunction
public Item evaluateItem(XPathContext context)
throws XPathException
evaluateItem in class Expressioncontext - the dynamic evaluation context
XPathException
public SequenceIterator call(SequenceIterator[] arguments,
XPathContext context)
throws XPathException
call in interface CallableExpressionarguments - the values of the arguments, supplied as SequenceIteratorscontext - the dynamic evaluation context
XPathException - if a dynamic error occurs during the evaluation of the expressionpublic int computeSpecialProperties()
computeSpecialProperties in class SystemFunction
public void sendDocument(XPathContext context,
Receiver out)
throws XPathException
context - the XPath dynamic contextout - the destination to which the document will be sent
XPathException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||