net.sf.saxon.instruct
Class ResultDocument
- SourceLocator, EvaluableItem, InstructionInfoProvider, SequenceIterable, Serializable, SourceLocator, TailCallReturner
public class ResultDocument
The compiled form of an xsl:result-document element in the stylesheet.
The xsl:result-document element takes an attribute href="filename". The filename will
often contain parameters, e.g. {position()} to ensure that a different file is produced
for each element instance.
There is a further attribute "format" which determines the format of the
output file, it identifies the name of an xsl:output element containing the output
format details. In addition, individual serialization properties may be specified as attributes.
These are attribute value templates, so they may need to be computed at run-time.
Expression | copy() - Copy an expression.
|
void | explain(ExpressionPresenter out) - Diagnostic print of expression structure.
|
int | getInstructionNameCode() - Get the name of this instruction for diagnostic and tracing purposes
(the string "xsl:result-document")
|
int | getIntrinsicDependencies() - Determine the intrinsic dependencies of an expression, that is, those which are not derived
from the dependencies of its subexpressions.
|
ItemType | getItemType(TypeHierarchy th) - Get the item type of the items returned by evaluating this instruction
|
Iterator | iterateSubExpressions() - Get all the XPath expressions associated with this instruction
(in XSLT terms, the expression present on attributes of the instruction,
as distinct from the child instructions in a sequence construction)
|
Expression | optimize(ExpressionVisitor visitor, ItemType contextItemType) - Perform optimisation of an expression and its subexpressions.
|
TailCall | processLeavingTail(XPathContext context) - ProcessLeavingTail: called to do the real work of this instruction.
|
protected void | promoteInst(PromotionOffer offer) - Handle promotion offers, that is, non-local tree rewrites.
|
boolean | replaceSubExpression(Expression original, Expression replacement) - Replace one subexpression by a replacement subexpression
|
void | setContent(Expression content) - Set the expression that constructs the content
|
void | setDynamicOutputElement(Expression exp) - Set an expression that evaluates to a run-time xsl:output element, used in the saxon:result-document()
extension function designed for use in XQuery
|
static void | setSerializationProperty(Properties details, String uri, String lname, String value, NamespaceResolver nsResolver, boolean prevalidated, NameChecker checker) - Validate a serialization property and add its value to a Properties collection
|
Expression | simplify(ExpressionVisitor visitor) - Simplify an expression.
|
Expression | typeCheck(ExpressionVisitor visitor, ItemType contextItemType) - Perform type checking of an expression and its subexpressions.
|
assembleParams , assembleTunnelParams , computeCardinality , computeSpecialProperties , createsNewNodes , dynamicError , evaluateAsString , evaluateItem , getImplementationMethod , getInstructionInfo , getInstructionNameCode , getItemType , getSourceLocator , isXSLT , iterate , process , processLeavingTail , promote , promoteInst , simplify |
addToPathMap , adoptChildExpression , checkPermittedContents , computeCardinality , computeDependencies , computeSpecialProperties , computeStaticProperties , copy , display , doPromotion , dynamicError , effectiveBooleanValue , evaluateAsString , evaluateItem , explain , explain , findParentOf , getCardinality , getColumnNumber , getConstructType , getContainer , getDependencies , getExecutable , getHostLanguage , getImplementationMethod , getInstructionInfo , getIntrinsicDependencies , getItemType , getLineNumber , getLocationId , getLocationProvider , getPublicId , getSlotsUsed , getSpecialProperties , getSystemId , hasLoopingSubexpression , implementsStaticTypeCheck , iterate , iterateEvents , iterateSubExpressions , markTailFunctionCalls , optimize , process , promote , replaceSubExpression , resetLocalStaticProperties , setContainer , setFiltered , setFlattened , setLocationId , simplify , staticTypeCheck , suppressValidation , toString , typeCheck , typeError |
ResultDocument
public ResultDocument(Properties globalProperties,
Properties localProperties,
Expression href,
Expression formatExpression,
String baseURI,
int validationAction,
SchemaType schemaType,
IntHashMap serializationAttributes,
NamespaceResolver nsResolver)
Create a result-document instruction
globalProperties
- properties defined on static xsl:outputlocalProperties
- non-AVT properties defined on result-document elementhref
- href attribute of instructionformatExpression
- format attribute of instructionbaseURI
- base URI of the instructionvalidationAction
- for example Validation.STRICT
schemaType
- schema type against which output is to be validatedserializationAttributes
- computed local propertiesnsResolver
- namespace resolver
copy
public Expression copy()
Copy an expression. This makes a deep copy.
- copy in interface Expression
- the copy of the original expression
explain
public void explain(ExpressionPresenter out)
Diagnostic print of expression structure. The abstract expression tree
is written to the supplied output destination.
- explain in interface Expression
getInstructionNameCode
public int getInstructionNameCode()
Get the name of this instruction for diagnostic and tracing purposes
(the string "xsl:result-document")
- getInstructionNameCode in interface Instruction
getIntrinsicDependencies
public int getIntrinsicDependencies()
Determine the intrinsic dependencies of an expression, that is, those which are not derived
from the dependencies of its subexpressions. For example, position() has an intrinsic dependency
on the context position, while (position()+1) does not. The default implementation
of the method returns 0, indicating "no dependencies".
- getIntrinsicDependencies in interface Expression
- a set of bit-significant flags identifying the "intrinsic"
dependencies. The flags are documented in class net.sf.saxon.value.StaticProperty
getItemType
public ItemType getItemType(TypeHierarchy th)
Get the item type of the items returned by evaluating this instruction
- getItemType in interface Instruction
th
- the type hierarchy cache
- the static item type of the instruction. This is empty: the result-document instruction
returns nothing.
iterateSubExpressions
public Iterator iterateSubExpressions()
Get all the XPath expressions associated with this instruction
(in XSLT terms, the expression present on attributes of the instruction,
as distinct from the child instructions in a sequence construction)
- iterateSubExpressions in interface Expression
optimize
public Expression optimize(ExpressionVisitor visitor,
ItemType contextItemType)
throws XPathException
Perform optimisation of an expression and its subexpressions. This is the third and final
phase of static optimization.
This method is called after all references to functions and variables have been resolved
to the declaration of the function or variable, and after all type checking has been done.
- optimize in interface Expression
visitor
- an expression visitorcontextItemType
- the static type of "." at the point where this expression is invoked.
The parameter is set to null if it is known statically that the context item will be undefined.
If the type of the context item is not known statically, the argument is set to
Type.ITEM_TYPE
- the original expression, rewritten if appropriate to optimize execution
XPathException
- if an error is discovered during this phase
(typically a type error)
processLeavingTail
public TailCall processLeavingTail(XPathContext context)
throws XPathException
ProcessLeavingTail: called to do the real work of this instruction. This method
must be implemented in each subclass. The results of the instruction are written
to the current Receiver, which can be obtained via the Controller.
- processLeavingTail in interface TailCallReturner
- processLeavingTail in interface Instruction
context
- The dynamic context of the transformation, giving access to the current node,
the current variables, etc.
- null if the instruction has completed execution; or a TailCall indicating
a function call or template call that is delegated to the caller, to be made after the stack has
been unwound so as to save stack space.
replaceSubExpression
public boolean replaceSubExpression(Expression original,
Expression replacement)
Replace one subexpression by a replacement subexpression
- replaceSubExpression in interface Expression
original
- the original subexpressionreplacement
- the replacement subexpression
- true if the original subexpression is found
setContent
public void setContent(Expression content)
Set the expression that constructs the content
content
- the expression defining the content of the result document
setDynamicOutputElement
public void setDynamicOutputElement(Expression exp)
Set an expression that evaluates to a run-time xsl:output element, used in the saxon:result-document()
extension function designed for use in XQuery
exp
- the expression whose result should be an xsl:output element
setSerializationProperty
public static void setSerializationProperty(Properties details,
String uri,
String lname,
String value,
NamespaceResolver nsResolver,
boolean prevalidated,
NameChecker checker)
throws XPathException
Validate a serialization property and add its value to a Properties collection
details
- the properties to be updateduri
- the uri of the property namelname
- the local part of the property namevalue
- the value of the serialization property. In the case of QName-valued values,
this will use lexical QNames if prevalidated is false, Clark-format names otherwisensResolver
- resolver for lexical QNames; not needed if prevalidatedprevalidated
- true if values are already known to be valid and lexical QNames have been
expanded into Clark notationchecker
- the XML 1.0 or 1.1 name checker
simplify
public Expression simplify(ExpressionVisitor visitor)
throws XPathException
Simplify an expression. This performs any static optimization (by rewriting the expression
as a different expression). The default implementation does nothing.
- simplify in interface Instruction
visitor
- an expression visitor
- the simplified expression
XPathException
- if an error is discovered during expression rewriting
typeCheck
public Expression typeCheck(ExpressionVisitor visitor,
ItemType contextItemType)
throws XPathException
Perform type checking of an expression and its subexpressions. This is the second phase of
static optimization.
This checks statically that the operands of the expression have
the correct type; if necessary it generates code to do run-time type checking or type
conversion. A static type error is reported only if execution cannot possibly succeed, that
is, if a run-time type error is inevitable. The call may return a modified form of the expression.
This method is called after all references to functions and variables have been resolved
to the declaration of the function or variable. However, the types of such functions and
variables may not be accurately known if they have not been explicitly declared.
If the implementation returns a value other than "this", then it is required to ensure that
the parent pointer and location information in the returned expression have been set up correctly.
It should not rely on the caller to do this, although for historical reasons many callers do so.
- typeCheck in interface Expression
visitor
- an expression visitorcontextItemType
- the static type of "." at the point where this expression is invoked.
The parameter is set to null if it is known statically that the context item will be undefined.
If the type of the context item is not known statically, the argument is set to
Type.ITEM_TYPE
- the original expression, rewritten to perform necessary run-time type checks,
and to perform other type-related optimizations
XPathException
- if an error is discovered during this phase
(typically a type error)