|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.expr.Expression net.sf.saxon.expr.instruct.Instruction net.sf.saxon.expr.instruct.ResultDocument
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.
Field Summary |
---|
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 | |
---|---|
ResultDocument(Properties globalProperties,
Properties localProperties,
Expression href,
Expression formatExpression,
String baseURI,
int validationAction,
SchemaType schemaType,
IntHashMap<Expression> serializationAttributes,
NamespaceResolver nsResolver)
Create a result-document instruction |
Method Summary | |
---|---|
Expression |
copy()
Copy an expression. |
void |
explain(ExpressionPresenter out)
Diagnostic print of expression structure. |
Expression |
getContentExpression()
Get the expression that constructs the content |
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 |
SchemaType |
getSchemaType()
|
int |
getValidationAction()
|
Iterator<Expression> |
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,
ExpressionVisitor.ContextItemType contextItemType)
Perform optimisation of an expression and its subexpressions. |
void |
process(Expression content,
XPathContext context)
Evaluation method designed for calling from compiled bytecode. |
TailCall |
processLeavingTail(XPathContext context)
ProcessLeavingTail: called to do the real work of this instruction. |
void |
processLeft(Stack<XPathContext> contextStack,
Stack<Object> state)
In streaming mode, process the first half of the instruction (for example, to start a new document or element) |
void |
processRight(Stack<XPathContext> contextStack,
Stack<Object> state)
In streaming mode, process the right half of the instruction (for example, to end a new document or element) |
static void |
processXslOutputElement(NodeInfo element,
Properties props,
XPathContext c)
Construct a set of output properties from an xsl:output element supplied at run-time |
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 |
setContentExpression(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,
Configuration config)
Validate a serialization property and add its value to a Properties collection |
void |
setUseStaticBaseUri(boolean staticBase)
Set whether the the instruction should resolve the href relative URI against the static base URI (rather than the dynamic base output URI) |
Expression |
simplify(ExpressionVisitor visitor)
Simplify an expression. |
Expression |
typeCheck(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Perform type checking of an expression and its subexpressions. |
Methods inherited from class net.sf.saxon.expr.instruct.Instruction |
---|
assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, createsNewNodes, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getImplementationMethod, getInstructionName, getIteratorFromProcessMethod, getSourceLocator, isXSLT, iterate, process, promote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.xml.transform.SourceLocator |
---|
getColumnNumber, getLineNumber, getPublicId, getSystemId |
Constructor Detail |
---|
public ResultDocument(Properties globalProperties, Properties localProperties, Expression href, Expression formatExpression, String baseURI, int validationAction, SchemaType schemaType, IntHashMap<Expression> serializationAttributes, NamespaceResolver nsResolver)
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 resolverMethod Detail |
---|
public void setContentExpression(Expression content)
content
- the expression defining the content of the result documentpublic Expression getContentExpression()
getContentExpression
in interface DivisibleInstruction
public void setDynamicOutputElement(Expression exp)
exp
- the expression whose result should be an xsl:output elementpublic void setUseStaticBaseUri(boolean staticBase)
staticBase
- set to true by fn:put(), to resolve against the static base URI of the query.
Default is false, which causes resolution against the base output URI obtained dynamically
from the Controllerpublic Expression simplify(ExpressionVisitor visitor) throws XPathException
simplify
in class Instruction
visitor
- an expression visitor
XPathException
- if an error is discovered during expression rewritingpublic Expression typeCheck(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
Expression
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 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 class 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
XPathException
- if an error is discovered during this phase
(typically a type error)public Expression optimize(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
Expression
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 class 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
XPathException
- if an error is discovered during this phase
(typically a type error)public int getIntrinsicDependencies()
Expression
getIntrinsicDependencies
in class Expression
public Expression copy()
copy
in class Expression
protected void promoteInst(PromotionOffer offer) throws XPathException
promoteInst
in class Instruction
offer
- The type of rewrite being offered
XPathException
public int getInstructionNameCode()
getInstructionNameCode
in class Instruction
public ItemType getItemType(TypeHierarchy th)
getItemType
in class Instruction
th
- the type hierarchy cache
public SchemaType getSchemaType()
getSchemaType
in interface ValidatingInstruction
public int getValidationAction()
getValidationAction
in interface ValidatingInstruction
public Iterator<Expression> iterateSubExpressions()
iterateSubExpressions
in class Expression
public boolean replaceSubExpression(Expression original, Expression replacement)
replaceSubExpression
in class Expression
original
- the original subexpressionreplacement
- the replacement subexpression
public TailCall processLeavingTail(XPathContext context) throws XPathException
Instruction
processLeavingTail
in interface TailCallReturner
processLeavingTail
in class Instruction
context
- The dynamic context of the transformation, giving access to the current node,
the current variables, etc.
XPathException
- if a dynamic error occurs during the evaluation
of the instructionpublic void process(Expression content, XPathContext context) throws XPathException
content
- The content expression. When called from bytecode, this will be the compiled version
of the interpreted content expressioncontext
- dynamic evaluation context
XPathException
- if a dynamic error occurspublic void processLeft(Stack<XPathContext> contextStack, Stack<Object> state) throws XPathException
processLeft
in interface DivisibleInstruction
contextStack
- Stack of XPathContext objects. The instruction should use the one at the top of the stack.
Some instructions (such as xsl:result-document) create a new context object and add it to the stack, removing it
in the corresponding processRight() action.state
- a stack on which the instruction can save state information during the call on processLeft()
XPathException
- if a dynamic error occurspublic void processRight(Stack<XPathContext> contextStack, Stack<Object> state) throws XPathException
processRight
in interface DivisibleInstruction
contextStack
- the stack of dynamic context objectsstate
- a stack on which the instruction can save state information during the call on processLeft()
XPathException
- if a dynamic error occurspublic static void setSerializationProperty(Properties details, String uri, String lname, String value, NamespaceResolver nsResolver, boolean prevalidated, Configuration config) throws XPathException
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 and a NamespaceResolver is supplied;
otherwise they will use Clark-format namesnsResolver
- resolver for lexical QNames; not needed if prevalidated, or if QNames are supplied in Clark
formatprevalidated
- true if values are already known to be valid and lexical QNames have been
expanded into Clark notationconfig
- the Saxon configuration
XPathException
- if any serialization property has an invalid valuepublic void explain(ExpressionPresenter out)
explain
in class Expression
out
- the expression presenter used to display the structurepublic static void processXslOutputElement(NodeInfo element, Properties props, XPathContext c) throws XPathException
element
- an xsl:output elementprops
- Properties object to which will be added the values of those serialization properties
that were specifiedc
- the XPath dynamic context
XPathException
- if a dynamic error occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |