Class FixedAttribute

  extended by net.sf.saxon.expr.Expression
      extended by net.sf.saxon.expr.instruct.Instruction
          extended by net.sf.saxon.expr.instruct.SimpleNodeConstructor
              extended by net.sf.saxon.expr.instruct.AttributeCreator
                  extended by net.sf.saxon.expr.instruct.FixedAttribute
All Implemented Interfaces:
Serializable, SourceLocator, LocationProvider, SaxonLocator, EvaluableItem, TailCallReturner, SequenceIterable, InstructionInfo, Locator

public final class FixedAttribute
extends AttributeCreator

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.

See Also:
Serialized Form

Field Summary
Fields inherited from class net.sf.saxon.expr.instruct.SimpleNodeConstructor
Fields inherited from class net.sf.saxon.expr.Expression
Constructor Summary
FixedAttribute(int nameCode, int validationAction, SimpleType schemaType, int annotation)
          Construct an Attribute instruction
Method Summary
 void checkPermittedContents(SchemaType parentType, StaticContext env, 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.
 Expression copy()
          Copy an expression.
 Item evaluateItem(XPathContext context)
          Evaluate as an expression.
 int evaluateNameCode(XPathContext context)
          Run-time method to compute the name of the node being constructed.
 void explain(ExpressionPresenter out)
          Diagnostic print of expression structure.
 int getAttributeNameCode()
          Get the name pool name code of the attribute to be constructed
 int getCardinality()
          Determine the static cardinality of the expression.
 int getInstructionNameCode()
          Get the name of this instruction (return 'xsl:attribute')
 ItemType getItemType(TypeHierarchy th)
          Get the item type of the items returned by evaluating this instruction
 void localTypeCheck(ExpressionVisitor visitor, ItemType contextItemType)
          Method to perform type-checking specific to the kind of instruction
 void setSelect(Expression select, Configuration config)
          Set the expression defining the value of the attribute.
Methods inherited from class net.sf.saxon.expr.instruct.AttributeCreator
getAnnotation, getOptions, getSchemaType, getValidationAction, processValue, setAnnotation, setNoSpecialChars, setOptions, setRejectDuplicates, setSchemaType, setValidationAction
Methods inherited from class net.sf.saxon.expr.instruct.SimpleNodeConstructor
checkContent, computeCardinality, computeSpecialProperties, createsNewNodes, getContentExpression, iterate, iterateSubExpressions, optimize, processLeavingTail, promoteInst, replaceSubExpression, simplify, typeCheck
Methods inherited from class net.sf.saxon.expr.instruct.Instruction
assembleParams, assembleTunnelParams, dynamicError, evaluateAsString, getConstructType, getExpressionName, getImplementationMethod, getInstructionName, getIteratorFromProcessMethod, getSourceLocator, isXSLT, process, promote
Methods inherited from class net.sf.saxon.expr.Expression
addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getColumnNumber, getColumnNumber, getContainer, getDependencies, getEvaluationMethod, getExecutable, getHostLanguage, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterateEvents, iterateSameFocusSubExpressions, markTailFunctionCalls, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, toString, typeError
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 FixedAttribute(int nameCode,
                      int validationAction,
                      SimpleType schemaType,
                      int annotation)
Construct an Attribute instruction

nameCode - Represents the attribute name
validationAction - the validation required, for example strict or lax
schemaType - the schema type against which validation is required, null if not applicable
annotation - Integer code identifying the type named in the type attribute of the instruction - zero if the attribute was not present
Method Detail


public int getInstructionNameCode()
Get the name of this instruction (return 'xsl:attribute')

getInstructionNameCode in class Instruction
a code identifying the instruction: typically but not always the fingerprint of a name in the XSLT namespace


public void setSelect(Expression select,
                      Configuration config)
               throws XPathException
Set the expression defining the value of the attribute. If this is a constant, and if validation against a schema type was requested, the validation is done immediately.

setSelect in class SimpleNodeConstructor
select - The expression defining the content of the attribute
config - The Saxon configuration
XPathException - if the expression is a constant, and validation is requested, and the constant doesn't match the required type.


public void localTypeCheck(ExpressionVisitor visitor,
                           ItemType contextItemType)
                    throws XPathException
Description copied from class: SimpleNodeConstructor
Method to perform type-checking specific to the kind of instruction

Specified by:
localTypeCheck in class SimpleNodeConstructor
visitor - an expression visitor
contextItemType - the static type of the context item


public int getAttributeNameCode()
Get the name pool name code of the attribute to be constructed

the attribute's name code


public ItemType getItemType(TypeHierarchy th)
Description copied from class: Instruction
Get the item type of the items returned by evaluating this instruction

getItemType in class Instruction
th - the type hierarchy cache
the static item type of the instruction


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.

getCardinality in class Expression
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).


public Expression copy()
Copy an expression. This makes a deep copy.

Specified by:
copy in class Expression
the copy of the original expression


public int evaluateNameCode(XPathContext context)
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

evaluateNameCode in class SimpleNodeConstructor
context - the XPath dynamic evaluation context
the name pool nameCode identifying the name of the constructed node


public void checkPermittedContents(SchemaType parentType,
                                   StaticContext env,
                                   boolean whole)
                            throws XPathException
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.

checkPermittedContents in class Expression
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 type
env - the static context
whole - 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
XPathException - if the value delivered by this expression cannot be part of the content model of the given type


public Item evaluateItem(XPathContext context)
                  throws XPathException
Description copied from class: SimpleNodeConstructor
Evaluate as an expression.

Specified by:
evaluateItem in interface EvaluableItem
evaluateItem in class SimpleNodeConstructor
context - The context in which the expression is to be evaluated
the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence
XPathException - if any dynamic error occurs evaluating the expression


public void explain(ExpressionPresenter out)
Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.

Specified by:
explain in class Expression
out - the expression presenter used to display the structure

Copyright (c) 2004-2010 Saxonica Limited. All rights reserved.