net.sf.saxon.instruct

Class ElementCreator

public abstract class ElementCreator extends ParentNodeConstructor

An instruction that creates an element node. There are two subtypes, FixedElement for use where the name is known statically, and Element where it is computed dynamically. To allow use in both XSLT and XQuery, the class acts both as an Instruction and as an Expression.

Field Summary
protected boolean	inheritNamespaces The inheritNamespaces flag indicates that the namespace nodes on the element created by this instruction are to be inherited (copied) on the children of this element.

Constructor Summary
	ElementCreator()

Method Summary
int	computeSpecialProperties() Get the static properties of this expression (other than its type).
Item	evaluateItem(XPathContext context) Evaluate the constructor, returning the constructed element node.
int[]	getActiveNamespaces() Callback to get a list of the intrinsic namespaces that need to be generated for the element.
int	getImplementationMethod() An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
ItemType	getItemType(TypeHierarchy th) Get the item type of the value returned by this instruction
abstract int	getNameCode(XPathContext context)
int	getValidationMode() Get the validation mode for the constructed element
protected abstract void	outputNamespaceNodes(XPathContext context, Receiver receiver) Callback to output namespace nodes for the new element.
TailCall	processLeavingTail(XPathContext context) Evaluate the instruction to produce a new element node.
void	setValidationMode(int mode) Set the validation mode for the new element
void	suppressValidation(int validationMode) Suppress validation on contained element constructors, on the grounds that the parent element is already performing validation.

Field Detail

inheritNamespaces

protected boolean inheritNamespaces

The inheritNamespaces flag indicates that the namespace nodes on the element created by this instruction are to be inherited (copied) on the children of this element. That is, if this flag is false, the child elements must carry a namespace undeclaration for all the namespaces on the parent, unless they are redeclared in some way.

Constructor Detail

ElementCreator

public ElementCreator()

Method Detail

computeSpecialProperties

public int computeSpecialProperties()

Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.

Returns: a set of flags indicating static properties of this expression

evaluateItem

public Item evaluateItem(XPathContext context)

Evaluate the constructor, returning the constructed element node. If lazy construction mode is in effect, then an UnconstructedParent object is returned instead.

getActiveNamespaces

public int[] getActiveNamespaces()

Callback to get a list of the intrinsic namespaces that need to be generated for the element. The result is an array of namespace codes, the codes either occupy the whole array or are terminated by a -1 entry. A result of null is equivalent to a zero-length array.

getImplementationMethod

public int getImplementationMethod()

An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is prefered. For instructions this is the process() method.

getItemType

public ItemType getItemType(TypeHierarchy th)

Get the item type of the value returned by this instruction

Parameters: th

Returns: the item type

getNameCode

public abstract int getNameCode(XPathContext context)

getValidationMode

public int getValidationMode()

Get the validation mode for the constructed element

outputNamespaceNodes

protected abstract void outputNamespaceNodes(XPathContext context, Receiver receiver)

Callback to output namespace nodes for the new element.

Parameters: context The execution context receiver the Receiver where the namespace nodes are to be written

Throws: net.sf.saxon.trans.XPathException

processLeavingTail

public TailCall processLeavingTail(XPathContext context)

Evaluate the instruction to produce a new element node. This method is typically used when there is a parent element or document in a result tree, to which the new element is added.

Parameters: context

Returns: null (this instruction never returns a tail call)

Throws: XPathException

setValidationMode

public void setValidationMode(int mode)

Set the validation mode for the new element

suppressValidation

public void suppressValidation(int validationMode)

Suppress validation on contained element constructors, on the grounds that the parent element is already performing validation. The default implementation does nothing.