Package net.sf.saxon.expr.instruct
Class FixedAttribute
java.lang.Object
net.sf.saxon.expr.Expression
net.sf.saxon.expr.instruct.Instruction
net.sf.saxon.expr.instruct.SimpleNodeConstructor
net.sf.saxon.expr.instruct.AttributeCreator
net.sf.saxon.expr.instruct.FixedAttribute
- All Implemented Interfaces:
ExportAgent
,ValidatingInstruction
,Locatable
,IdentityComparable
,Traceable
An instruction derived from an xsl:attribute element in stylesheet, or from
an attribute constructor in XQuery. This version deals only with attributes
whose name is known at compile time. It is also used for attributes of
literal result elements. The value of the attribute is in general computed
at run-time.
-
Field Summary
Fields inherited from class net.sf.saxon.expr.instruct.SimpleNodeConstructor
selectOp
Fields inherited from class net.sf.saxon.expr.Expression
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_COST, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD
-
Constructor Summary
ConstructorsConstructorDescriptionFixedAttribute
(NodeName nodeName, int validationAction, SimpleType schemaType) Construct an Attribute instruction -
Method Summary
Modifier and TypeMethodDescriptionvoid
checkPermittedContents
(SchemaType parentType, boolean whole) Check that any elements and attributes constructed or returned by this expression are acceptable in the content model of a given complex type.copy
(RebindingMap rebindings) Copy an expression.evaluateItem
(XPathContext context) Evaluate as an expression.evaluateNodeName
(XPathContext context) Run-time method to compute the name of the node being constructed.void
Diagnostic print of expression structure.void
gatherProperties
(BiConsumer<String, Object> consumer) Get the properties of this object to be included in trace messages, by supplying the property values to a supplied consumer functionint
Get the name pool name code of the attribute to be constructedint
Determine the static cardinality of the expression.Make an elaborator for this expressionGet a name identifying the kind of expression, in terms meaningful to a user.int
Get the name of this instruction (return 'xsl:attribute')void
localTypeCheck
(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Method to perform type-checking specific to the kind of instructionProduce a short string identifying the expression for use in error messagesMethods inherited from class net.sf.saxon.expr.instruct.AttributeCreator
computeSpecialProperties, getItemType, getOptions, getSchemaType, getValidationAction, isInstruction, processValue, setInstruction, setNoSpecialChars, setOptions, setRejectDuplicates, setSchemaType, setValidationAction, validate, validateOrphanAttribute
Methods inherited from class net.sf.saxon.expr.instruct.SimpleNodeConstructor
allowExtractingCommonSubexpressions, alwaysCreatesNewNodes, checkContent, computeCardinality, getSelect, getSelectOp, getStreamerName, isLocal, iterate, mayCreateNewNodes, operands, optimize, setSelect, typeCheck
Methods inherited from class net.sf.saxon.expr.instruct.Instruction
assembleParams, assembleTunnelParams, dynamicError, evaluateAsString, getImplementationMethod, getNetCost, getSourceLocator, isXSLT, process, someOperandCreatesNewNodes
Methods inherited from class net.sf.saxon.expr.Expression
addToPathMap, adoptChildExpression, checkedOperands, checkForUpdatingSubexpressions, computeDependencies, computeHashCode, computeStaticProperties, dispatchTailCall, dynamicError, effectiveBooleanValue, equals, explain, getConfiguration, getCost, getDependencies, getEvaluationMethod, getExtraProperty, getIntegerBounds, getIntrinsicDependencies, getLocalRetainedStaticContext, getLocation, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, getTracingTag, hasCompatibleStaticContext, hashCode, hasSpecialProperty, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isEqual, isIdentical, isLiftable, isMultiThreaded, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, makeElaborator, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, prepareForStreaming, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, supportsLazyEvaluation, suppressValidation, toPattern, toString, typeCheckChildren, typeError, unordered, verifyParentPointers, withLocation
-
Constructor Details
-
FixedAttribute
Construct an Attribute instruction- Parameters:
nodeName
- Represents the attribute namevalidationAction
- the validation required, for example strict or laxschemaType
- the schema type against which validation is required, null if not applicable of the instruction - zero if the attribute was not present
-
-
Method Details
-
getInstructionNameCode
public int getInstructionNameCode()Get the name of this instruction (return 'xsl:attribute')- Overrides:
getInstructionNameCode
in classInstruction
- Returns:
- a code identifying the instruction: typically but not always the fingerprint of a name in the XSLT namespace
-
getExpressionName
Get a name identifying the kind of expression, in terms meaningful to a user.- Overrides:
getExpressionName
in classInstruction
- Returns:
- a name identifying the kind of expression, in terms meaningful to a user. The name will always be in the form of a lexical XML QName, and should match the name used in explain() output displaying the expression.
-
getAttributeName
-
gatherProperties
Get the properties of this object to be included in trace messages, by supplying the property values to a supplied consumer function- Parameters:
consumer
- the function to which the properties should be supplied, as (property name, value) pairs.
-
localTypeCheck
public void localTypeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) throws XPathException Description copied from class:SimpleNodeConstructor
Method to perform type-checking specific to the kind of instruction- Specified by:
localTypeCheck
in classSimpleNodeConstructor
- Parameters:
visitor
- an expression visitorcontextItemType
- the static type of the context item- Throws:
XPathException
- if a type error is detected
-
getAttributeFingerprint
public int getAttributeFingerprint()Get the name pool name code of the attribute to be constructed- Returns:
- the attribute's name code
-
getCardinality
public int getCardinality()Description copied from class:Expression
Determine the static cardinality of the expression. This establishes how many items there will be in the result of the expression, at compile time (i.e., without actually evaluating the result.- Overrides:
getCardinality
in classExpression
- Returns:
- one of the values Cardinality.ONE_OR_MORE, Cardinality.ZERO_OR_MORE, Cardinality.EXACTLY_ONE, Cardinality.ZERO_OR_ONE, Cardinality.EMPTY. This default implementation returns ZERO_OR_MORE (which effectively gives no information).
-
copy
Copy an expression. This makes a deep copy.- Specified by:
copy
in classExpression
- Parameters:
rebindings
- a mutable list of (old binding, new binding) pairs that is used to update the bindings held in any local variable references that are copied.- Returns:
- the copy of the original expression
-
evaluateNodeName
Description copied from class:SimpleNodeConstructor
Run-time method to compute the name of the node being constructed. This is overridden for nodes that have a name. The default implementation returns -1, which is suitable for unnamed nodes such as comments- Overrides:
evaluateNodeName
in classSimpleNodeConstructor
- Parameters:
context
- the XPath dynamic evaluation context- Returns:
- the name pool nameCode identifying the name of the constructed node
-
checkPermittedContents
Check that any elements and attributes constructed or returned by this expression are acceptable in the content model of a given complex type. It's always OK to say yes, since the check will be repeated at run-time. The process of checking element and attribute constructors against the content model of a complex type also registers the type of content expected of those constructors, so the static validation can continue recursively.- Overrides:
checkPermittedContents
in classExpression
- Parameters:
parentType
- the "given complex type": the method is checking that the nodes returned by this expression are acceptable members of the content model of this typewhole
- if true, we want to check that the value of this expression satisfies the content model as a whole; if false we want to check that the value of the expression is acceptable as one part of the content- Throws:
XPathException
- if the value delivered by this expression cannot be part of the content model of the given type
-
evaluateItem
Description copied from class:SimpleNodeConstructor
Evaluate as an expression.- Overrides:
evaluateItem
in classSimpleNodeConstructor
- Parameters:
context
- The context in which the expression is to be evaluated- Returns:
- the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence
- Throws:
XPathException
- if any dynamic error occurs evaluating the expression
-
export
Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.- Specified by:
export
in interfaceExportAgent
- Specified by:
export
in classExpression
- Parameters:
out
- the expression presenter used to display the structure- Throws:
XPathException
- if the export fails, for example if an expression is found that won't work in the target environment.
-
toShortString
Produce a short string identifying the expression for use in error messages- Overrides:
toShortString
in classExpression
- Returns:
- a short string, sufficient to identify the expression
-
getElaborator
Make an elaborator for this expression- Overrides:
getElaborator
in classExpression
- Returns:
- a suitable elaborator
-