public class ResultDocument extends Instruction implements ValidatingInstruction, InstructionWithComplexContent
Modifier and Type | Class and Description |
---|---|
static class |
ResultDocument.CloseableResult |
Modifier and Type | Field and Description |
---|---|
protected CharacterMapIndex |
characterMapIndex |
protected java.util.Properties |
globalProperties |
protected java.util.Properties |
localProperties |
protected boolean |
resolveAgainstStaticBase |
protected java.util.Map<StructuredQName,Operand> |
serializationAttributes |
protected ParseOptions |
validationOptions |
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD
Constructor and Description |
---|
ResultDocument(java.util.Properties globalProperties,
java.util.Properties localProperties,
Expression href,
Expression formatExpression,
int validationAction,
SchemaType schemaType,
java.util.Map<StructuredQName,Expression> serializationAttributes,
CharacterMapIndex characterMapIndex)
Create a result-document instruction
|
Modifier and Type | Method and Description |
---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap.
|
static void |
checkAcceptableUri(XPathContext context,
java.lang.String uri) |
Expression |
copy(RebindingMap rebindings)
Copy an expression.
|
void |
export(ExpressionPresenter out)
Diagnostic print of expression structure.
|
java.util.Properties |
gatherOutputProperties(XPathContext context)
Create a properties object that combines the serialization properties specified
on the xsl:result-document itself with those specified in the referenced xsl:output declaration
|
Expression |
getContentExpression()
Get the subexpression that is used to evaluated the content, that is,
the contained sequence constructor
|
Expression |
getFormatExpression() |
Expression |
getHref() |
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()
Get the item type of the items returned by evaluating this instruction
|
static ResultDocument.CloseableResult |
getResult(Expression href,
java.lang.String baseURI,
XPathContext context,
OutputURIResolver resolver,
boolean resolveAgainstStaticBase) |
SchemaType |
getSchemaType()
Get the schema type chosen for validation; null if not defined
|
java.lang.String |
getStaticSerializationProperty(StructuredQName name)
Get the value of a serialization property if it is statically known
|
java.lang.String |
getStreamerName()
Get the (partial) name of a class that supports streaming of this kind of expression
|
int |
getValidationAction()
Get the validation mode for this instruction
|
ParseOptions |
getValidationOptions()
Get the validation options
|
boolean |
isAsynchronous()
Ask if the instruction is to be asynchronous
|
boolean |
isMultiThreaded(Configuration config)
Ask whether the expression is multithreaded (that is, whether its operands are
evaluated in parallel)
|
boolean |
isResolveAgainstStaticBase() |
java.lang.Iterable<Operand> |
operands()
Get the immediate sub-expressions of this expression, with information about the relationship
of each expression to its parent expression.
|
Expression |
optimize(ExpressionVisitor visitor,
ContextItemStaticInfo contextInfo)
Perform optimisation of an expression and its subexpressions.
|
void |
process(Expression content,
XPathContext context) |
void |
processInstruction(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.
|
static void |
processXslOutputElement(NodeInfo element,
java.util.Properties props,
XPathContext c)
Construct a set of output properties from an xsl:output element supplied at run-time
|
void |
setAsynchronous(boolean async) |
void |
setContentExpression(Expression content)
Set the expression that constructs the content
|
void |
setFormatExpression(Expression formatExpression) |
void |
setHref(Expression href) |
void |
setSchemaType(SchemaType type)
Set the schema type to be used for validation
|
static void |
setSerializationProperty(java.util.Properties details,
java.lang.String uri,
java.lang.String lname,
java.lang.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)
|
void |
setValidationAction(int mode,
SchemaType schemaType)
Set the validation mode for the new document
|
static void |
traceDestination(XPathContext context,
javax.xml.transform.Result result) |
Expression |
typeCheck(ExpressionVisitor visitor,
ContextItemStaticInfo contextInfo)
Perform type checking of an expression and its subexpressions.
|
alwaysCreatesNewNodes, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getImplementationMethod, getInstructionName, getNetCost, getSourceLocator, isInstruction, isXSLT, iterate, mayCreateNewNodes, process, someOperandCreatesNewNodes
adoptChildExpression, allowExtractingCommonSubexpressions, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeHashCode, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getCardinality, getConfiguration, getCost, getDependencies, getEvaluationMethod, getExtraProperty, getIntegerBounds, getInterpretedExpression, getLocalRetainedStaticContext, getLocation, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, hasCompatibleStaticContext, hashCode, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isLiftable, isSameExpression, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toShortString, toString, typeCheckChildren, typeError, unordered, verifyParentPointers, verifyParentPointers
protected java.util.Properties globalProperties
protected java.util.Properties localProperties
protected ParseOptions validationOptions
protected java.util.Map<StructuredQName,Operand> serializationAttributes
protected boolean resolveAgainstStaticBase
protected CharacterMapIndex characterMapIndex
public ResultDocument(java.util.Properties globalProperties, java.util.Properties localProperties, Expression href, Expression formatExpression, int validationAction, SchemaType schemaType, java.util.Map<StructuredQName,Expression> serializationAttributes, CharacterMapIndex characterMapIndex)
globalProperties
- properties defined on static xsl:outputlocalProperties
- non-AVT properties defined on result-document elementhref
- href attribute of instructionformatExpression
- format attribute of instructionvalidationAction
- for example Validation.STRICT
schemaType
- schema type against which output is to be validatedserializationAttributes
- computed local propertiespublic void setContentExpression(Expression content)
content
- the expression defining the content of the result documentpublic void setSchemaType(SchemaType type)
type
- the type to be used for validation. (For a document constructor, this is the required
type of the document element)public SchemaType getSchemaType()
getSchemaType
in interface ValidatingInstruction
public boolean isResolveAgainstStaticBase()
public ParseOptions getValidationOptions()
public void setValidationAction(int mode, SchemaType schemaType)
mode
- the validation mode, for example Validation.STRICT
schemaType
- the required type (for validation by type). Null if not
validating by typepublic int getValidationAction()
getValidationAction
in interface ValidatingInstruction
Validation.STRICT
or Validation.PRESERVE
public Expression getFormatExpression()
public 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 void setAsynchronous(boolean async)
public boolean isAsynchronous()
public boolean isMultiThreaded(Configuration config)
Expression
isMultiThreaded
in class Expression
config
- the Saxon configurationpublic Expression typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) 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.
typeCheck
in class Expression
visitor
- an expression visitorcontextInfo
- Information available statically about the context item: whether it is (possibly)
absent; its static type; its streaming posture.XPathException
- if an error is discovered during this phase
(typically a type error)public int getIntrinsicDependencies()
Expression
getIntrinsicDependencies
in class Expression
public Expression optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) 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 visitorcontextInfo
- 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 copy(RebindingMap rebindings)
copy
in class Expression
rebindings
- public int getInstructionNameCode()
getInstructionNameCode
in class Instruction
public ItemType getItemType()
getItemType
in class Instruction
public java.lang.Iterable<Operand> operands()
Expression
If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.
operands
in class Instruction
public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
The default implementation of this method assumes that an expression does no navigation other than the navigation done by evaluating its subexpressions, and that the subexpressions are evaluated in the same context as the containing expression. The method must be overridden for any expression where these assumptions do not hold. For example, implementations exist for AxisExpression, ParentExpression, and RootExpression (because they perform navigation), and for the doc(), document(), and collection() functions because they create a new navigation root. Implementations also exist for PathExpression and FilterExpression because they have subexpressions that are evaluated in a different context from the calling expression.
addToPathMap
in class Expression
pathMap
- the PathMap to which the expression should be addedpathMapNodeSet
- the PathMapNodeSet to which the paths embodied in this expression should be addedpublic 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
XPathException
public void processInstruction(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 contextXPathException
- if a dynamic error occurspublic static ResultDocument.CloseableResult getResult(Expression href, java.lang.String baseURI, XPathContext context, OutputURIResolver resolver, boolean resolveAgainstStaticBase) throws XPathException
XPathException
public static void traceDestination(XPathContext context, javax.xml.transform.Result result)
public static void checkAcceptableUri(XPathContext context, java.lang.String uri) throws XPathException
XPathException
public java.util.Properties gatherOutputProperties(XPathContext context) throws XPathException
context
- The XPath evaluation contextXPathException
- if invalid properties are foundpublic java.lang.String getStaticSerializationProperty(StructuredQName name)
name
- the name of the serialization propertypublic static void setSerializationProperty(java.util.Properties details, java.lang.String uri, java.lang.String lname, java.lang.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 configurationXPathException
- if any serialization property has an invalid valuepublic void export(ExpressionPresenter out) throws XPathException
export
in interface ExportAgent
export
in class Expression
out
- the expression presenter used to display the structureXPathException
- if the export fails, for example if an expression is found that won't work
in the target environment.public static void processXslOutputElement(NodeInfo element, java.util.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 contextXPathException
- if a dynamic error occurspublic java.lang.String getStreamerName()
getStreamerName
in class Expression
public Expression getHref()
public void setHref(Expression href)
public void setFormatExpression(Expression formatExpression)
public Expression getContentExpression()
InstructionWithComplexContent
getContentExpression
in interface InstructionWithComplexContent
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.