net.sf.saxon.style
Class StyleElement

java.lang.Object
  net.sf.saxon.tree.NodeImpl
      net.sf.saxon.tree.ElementImpl
          net.sf.saxon.tree.ElementWithAttributes
              net.sf.saxon.style.StyleElement

All Implemented Interfaces:

Serializable, Source, SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, NamespaceResolver, NodeInfo, ValueRepresentation, InstructionInfo, Locator

Direct Known Subclasses:

AbsentExtensionElement, ExtensionInstruction, LiteralResultElement, SaxonCollation, SaxonDoctype, SaxonEntityRef, SaxonImportQuery, SaxonScript, SaxonWhile, XSLAnalyzeString, XSLApplyImports, XSLApplyTemplates, XSLAttributeSet, XSLCallTemplate, XSLCharacterMap, XSLChoose, XSLCopy, XSLCopyOf, XSLDecimalFormat, XSLDocument, XSLElement, XSLFallback, XSLForEach, XSLForEachGroup, XSLFunction, XSLGeneralIncorporate, XSLGeneralVariable, XSLIf, XSLImportSchema, XSLKey, XSLMatchingSubstring, XSLMessage, XSLNamespaceAlias, XSLNextMatch, XSLNumber, XSLOtherwise, XSLOutput, XSLOutputCharacter, XSLPerformSort, XSLPreserveSpace, XSLResultDocument, XSLSequence, XSLSort, XSLStringConstructor, XSLStylesheet, XSLTemplate, XSLWhen

public abstract class StyleElement
extends ElementWithAttributes
implements Locator, Container, InstructionInfo

Abstract superclass for all element nodes in the stylesheet.
Note: this class implements Locator. The element retains information about its own location in the stylesheet, which is useful when an XSL error is found.

See Also:

Serialized Form

Field Summary

static int	REPORT_ALWAYS
static int	REPORT_IF_INSTANTIATED
static int	REPORT_UNLESS_FALLBACK_AVAILABLE
static int	REPORT_UNLESS_FORWARDS_COMPATIBLE

Fields inherited from class net.sf.saxon.tree.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

StyleElement()
Constructor

Method Summary

void	addChild(NodeImpl node, int index) Add a child node to this node.
void	allocatePatternSlots(Pattern match, SlotManager frame) Allocate space for range variables within predicates in the match pattern.
void	allocateSlots(Expression exp) Allocate slots in the local stack frame to range variables used in an XPath expression
void	allocateSlots(Pattern pattern) Allocate slots to any variables used within a pattern.
boolean	backwardsCompatibleModeIsEnabled() Determine whether backwards-compatible mode is enabled for this element
XSLVariableDeclaration	bindVariable(StructuredQName qName) Bind a variable used in this element to the compiled form of the XSLVariable element in which it is declared
void	checkEmpty() Convenience method to check that the stylesheet element is empty
void	checkTopLevel(String errorCode) Convenience method to check that the stylesheet element is at the top level
void	checkWithinTemplate() Check that the stylesheet element is within a sequence constructor
void	compact(int size) Compact the space used by this node
abstract Expression	compile(Executable exec) Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.
Expression	compileSequenceConstructor(Executable exec, AxisIterator iter, boolean includeParams) Compile the children of this instruction on the stylesheet tree, adding the subordinate instructions to the parent instruction on the execution tree.
void	fixupReferences() Fix up references from XPath expressions.
boolean	forwardsCompatibleModeIsEnabled() Determine whether forwards-compatible mode is enabled for this element
List	getAllStylesheetFunctions() Get a list of all stylesheet functions, excluding any that are masked by one of higher precedence
String	getAttributeValue(String clarkName) Get an attribute value given the Clark name of the attribute (that is, the name in {uri}local format).
int	getConstructType() Get the type of construct.
SlotManager	getContainingSlotManager() Get the SlotManager for the containing Procedure definition
XSLStylesheet	getContainingStylesheet() Get the containing XSLStylesheet element
Executable	getExecutable() Get the Executable (representing a complete stylesheet or query) of which this Container forms part
NodeInfo	getFirstChild() Get the first child node of the element
int	getHostLanguage() Get the host language (XSLT, XQuery, XPath) used to implement the code in this container
NodeInfo	getLastChild() Get the last child node of the element
int	getLineNumber() Get the line number of the node within its source document entity
int	getLineNumber(long locationId) Get the line number within the document or module containing a particular location
LocationProvider	getLocationProvider() Get the LocationProvider allowing location identifiers to be resolved.
NamespaceResolver	getNamespaceResolver() Get the namespace context of the instruction.
StructuredQName	getObjectName() Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
StructuredQName	getObjectName(NamePool pool) Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
int	getPrecedence() Get the import precedence of this stylesheet element.
PreparedStylesheet	getPreparedStylesheet() Get the PreparedStylesheet object.
XSLStylesheet	getPrincipalStylesheet() Get the principal XSLStylesheet node.
Iterator	getProperties() Get an iterator over all the properties available.
Object	getProperty(String name) Get the value of a particular property of the instruction.
SchemaType	getSchemaType(String typeAtt) Get the Schema type definition for a type named in the stylesheet (in a "type" attribute).
StaticContext	getStaticContext() Get the static context for expressions on this element
String	getStringValue() Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
XSLFunction	getStylesheetFunction(StructuredQName qName, int arity) Get a FunctionCall declared using an xsl:function element in the stylesheet
String	getSystemId(long locationId) Get the URI of the document or module containing a particular location
int	getTypeAnnotation(SchemaType schemaType) Get the type annotation to use for a given schema type
BigDecimal	getVersion() Get the numeric value of the version number on this element, or inherited from its ancestors
boolean	hasChildNodes() Determine if the node has any children.
boolean	isExcludedNamespace(short uriCode) Check whether a namespace uri defines an namespace excluded from the result.
boolean	isExtensionNamespace(short uriCode) Check whether a namespace uri defines an extension element.
boolean	isInstruction() Determine whether this node is an instruction.
boolean	isTopLevel() Test whether this is a top-level element
Expression	makeExpression(String expression) Compile an XPath expression in the context of this stylesheet element
ExpressionVisitor	makeExpressionVisitor() Make an expression visitor
SavedNamespaceContext	makeNamespaceContext() Make a NamespaceContext object representing the list of in-scope namespaces.
Pattern	makePattern(String pattern) Make a pattern in the context of this stylesheet element
StructuredQName	makeQName(String lexicalQName) Make a structured QName, using this Element as the context for namespace resolution, and registering the code in the namepool.
SequenceType	makeSequenceType(String sequenceType) Process an attribute whose value is a SequenceType
void	postValidate() Hook to allow additional validation of a parent element immediately after its children have been validated.
boolean	replaceSubExpression(Expression original, Expression replacement) Replace one subexpression by a replacement subexpression
void	reportAbsence(String attribute) Convenience method to report the absence of a mandatory attribute
void	setLineNumber(int lineNumber) Set the line number of the element within its source document entity
void	setObjectName(StructuredQName qName) Set the object name, for example the name of a function, variable, or template declared on this element
void	substituteFor(StyleElement temp) Make this node a substitute for a temporary one previously added to the tree.
Expression	typeCheck(String name, Expression exp) Type-check an expression.
Pattern	typeCheck(String name, Pattern pattern) Type-check a pattern.
void	validate() Check that the stylesheet element is valid.
void	validateSubtree() Recursive walk through the stylesheet to validate all nodes

Methods inherited from class net.sf.saxon.tree.ElementWithAttributes

copy, getAttributeList, getAttributeValue, getDeclaredNamespaces, getInScopeNamespaceCodes, getPrefixForURI, getURICodeForPrefix, getURIForPrefix, initialise, iteratePrefixes, setNamespaceDeclarations

Methods inherited from class net.sf.saxon.tree.ElementImpl

generateId, getBaseURI, getDocumentRoot, getNameCode, getNodeKind, getRoot, getSystemId, setNameCode, setSystemId

Methods inherited from class net.sf.saxon.tree.NodeImpl

atomize, compareOrder, equals, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getTypeAnnotation, getTypedValue, getURI, hashCode, isSameNodeInfo, iterateAxis, iterateAxis

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.trace.InstructionInfo

getSystemId

Field Detail

REPORT_ALWAYS

public static final int REPORT_ALWAYS

See Also:

Constant Field Values

REPORT_UNLESS_FORWARDS_COMPATIBLE

public static final int REPORT_UNLESS_FORWARDS_COMPATIBLE

See Also:

Constant Field Values

REPORT_IF_INSTANTIATED

public static final int REPORT_IF_INSTANTIATED

See Also:

Constant Field Values

REPORT_UNLESS_FALLBACK_AVAILABLE

public static final int REPORT_UNLESS_FALLBACK_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

StyleElement

public StyleElement()

Constructor

Method Detail

getExecutable

public Executable getExecutable()

Description copied from interface: Container

Get the Executable (representing a complete stylesheet or query) of which this Container forms part

Specified by:

getExecutable in interface Container

Returns:

the executable

getLocationProvider

public LocationProvider getLocationProvider()

Get the LocationProvider allowing location identifiers to be resolved.

Specified by:

getLocationProvider in interface Container

Returns:

the location provider

getStaticContext

public StaticContext getStaticContext()

Get the static context for expressions on this element

Returns:

the static context

makeExpressionVisitor

public ExpressionVisitor makeExpressionVisitor()

Make an expression visitor

Returns:

the expression visitor

getLineNumber

public int getLineNumber()

Description copied from class: ElementImpl

Get the line number of the node within its source document entity

Specified by:

getLineNumber in interface SourceLocator

Specified by:

getLineNumber in interface NodeInfo

Specified by:

getLineNumber in interface InstructionInfo

Specified by:

getLineNumber in interface Locator

Overrides:

getLineNumber in class ElementImpl

Returns:

the line number of the node in its original source document; or -1 if not available

setLineNumber

public void setLineNumber(int lineNumber)

Description copied from class: ElementImpl

Set the line number of the element within its source document entity

Overrides:

setLineNumber in class ElementImpl

Parameters:

lineNumber - the line number

substituteFor

public void substituteFor(StyleElement temp)

Make this node a substitute for a temporary one previously added to the tree. See StyleNodeFactory for details. "A node like the other one in all things but its class". Note that at this stage, the node will not yet be known to its parent, though it will contain a reference to its parent; and it will have no children.

Parameters:

temp - the element which this one is substituting for

isInstruction

public boolean isInstruction()

Determine whether this node is an instruction. The default implementation says it isn't.

Returns:

true if this element is an instruction

getContainingStylesheet

public XSLStylesheet getContainingStylesheet()

Get the containing XSLStylesheet element

Returns:

the XSLStylesheet element representing the outermost element of the containing stylesheet module

getPrecedence

public int getPrecedence()

Get the import precedence of this stylesheet element.

Returns:

the import precedence. The actual numeric value is arbitrary, but a higher number indicates a higher precedence.

makeQName

public final StructuredQName makeQName(String lexicalQName)
                                throws XPathException,
                                       NamespaceException

Make a structured QName, using this Element as the context for namespace resolution, and registering the code in the namepool. If the name is unprefixed, the default namespace is not used.

Parameters:

lexicalQName - The lexical QName as written, in the form "[prefix:]localname". The name must have already been validated as a syntactically-correct QName. Leading and trailing whitespace will be trimmed

Returns:

the StructuredQName representation of this lexical QName

Throws:

XPathException - if the qname is not a lexically-valid QName, or if the name is in a reserved namespace.

NamespaceException - if the prefix of the qname has not been declared

makeNamespaceContext

public SavedNamespaceContext makeNamespaceContext()

Make a NamespaceContext object representing the list of in-scope namespaces. This will be a copy of the namespace context with no references to objects in the stylesheet tree, so that it can be kept until run-time without locking the tree down in memory.

Returns:

a copy of the namespace context

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

Get the namespace context of the instruction.

Specified by:

getNamespaceResolver in interface InstructionInfo

Returns:

the namespace context. This method does not make a copy of the namespace context, so a reference to the returned NamespaceResolver will lock the stylesheet tree in memory.

getAttributeValue

public String getAttributeValue(String clarkName)

Get an attribute value given the Clark name of the attribute (that is, the name in {uri}local format).

Parameters:

clarkName - the name of the attribute in {uri}local format

Returns:

the value of the attribute if it exists, or null otherwise

makeExpression

public Expression makeExpression(String expression)
                          throws XPathException

Compile an XPath expression in the context of this stylesheet element

Parameters:

expression - the source text of the XPath expression

Returns:

the compiled expression tree for the XPath expression

Throws:

XPathException

makePattern

public Pattern makePattern(String pattern)
                    throws XPathException

Make a pattern in the context of this stylesheet element

Parameters:

pattern - the source text of the pattern

Returns:

the compiled pattern

Throws:

XPathException

makeSequenceType

public SequenceType makeSequenceType(String sequenceType)
                              throws XPathException

Process an attribute whose value is a SequenceType

Parameters:

sequenceType - the source text of the attribute

Returns:

the processed sequence type

Throws:

XPathException - if the syntax is invalid or for example if it refers to a type that is not in the static context

getVersion

public BigDecimal getVersion()

Get the numeric value of the version number on this element, or inherited from its ancestors

Returns:

the version number as a decimal

forwardsCompatibleModeIsEnabled

public boolean forwardsCompatibleModeIsEnabled()

Determine whether forwards-compatible mode is enabled for this element

Returns:

true if forwards-compatible mode is enabled

backwardsCompatibleModeIsEnabled

public boolean backwardsCompatibleModeIsEnabled()

Determine whether backwards-compatible mode is enabled for this element

Returns:

true if backwards compatable mode is enabled, that is, if this or an enclosing element specifies [xsl:]version="1.0"

isExtensionNamespace

public boolean isExtensionNamespace(short uriCode)

Check whether a namespace uri defines an extension element. This checks whether the namespace is defined as an extension namespace on this or any ancestor node.

Parameters:

uriCode - the namespace URI code being tested

Returns:

true if the URI is an extension element namespace URI

isExcludedNamespace

public boolean isExcludedNamespace(short uriCode)

Check whether a namespace uri defines an namespace excluded from the result. This checks whether the namespace is defined as an excluded namespace on this or any ancestor node.

Parameters:

uriCode - the code of the namespace URI being tested

Returns:

true if this namespace URI is a namespace excluded by virtue of exclude-result-prefixes on this element or on an ancestor element

getSchemaType

public SchemaType getSchemaType(String typeAtt)
                         throws XPathException

Get the Schema type definition for a type named in the stylesheet (in a "type" attribute).

Parameters:

typeAtt - the value of the type attribute

Returns:

the corresponding schema type

Throws:

XPathException - if the type is not declared in an imported schema, or is not a built-in type

getTypeAnnotation

public int getTypeAnnotation(SchemaType schemaType)

Get the type annotation to use for a given schema type

Parameters:

schemaType - the schema type

Returns:

the corresponding numeric type annotation

validate

public void validate()
              throws XPathException

Check that the stylesheet element is valid. This is called once for each element, after the entire tree has been built. As well as validation, it can perform first-time initialisation. The default implementation does nothing; it is normally overriden in subclasses.

Throws:

XPathException

postValidate

public void postValidate()
                  throws XPathException

Hook to allow additional validation of a parent element immediately after its children have been validated.

Throws:

XPathException

typeCheck

public Expression typeCheck(String name,
                            Expression exp)
                     throws XPathException

Type-check an expression. This is called to check each expression while the containing instruction is being validated. It is not just a static type-check, it also adds code to perform any necessary run-time type checking and/or conversion.

Parameters:

name - the name of the attribute containing the expression to be checked (used for diagnostics)

exp - the expression to be checked

Returns:

the (possibly rewritten) expression after type checking

Throws:

XPathException

allocateSlots

public void allocateSlots(Expression exp)

Allocate slots in the local stack frame to range variables used in an XPath expression

Parameters:

exp - the XPath expression for which slots are to be allocated

allocateSlots

public void allocateSlots(Pattern pattern)

Allocate slots to any variables used within a pattern. This is needed only for "free-standing" patterns such as template match or key match; other cases are handed by the containing PatternSponsor

Parameters:

pattern - the pattern whose slots are to be allocated

allocatePatternSlots

public void allocatePatternSlots(Pattern match,
                                 SlotManager frame)

Allocate space for range variables within predicates in the match pattern. The xsl:template element has no XPath expressions among its attributes, so if this method is called on this object it can only be because there are variables used in the match pattern. We work out how many slots are needed for the match pattern in each template rule, and then apply-templates can allocate a stack frame that is large enough for the most demanding match pattern in the entire stylesheet.

Parameters:

match - the pattern

frame - the stackframe outline for this pattern

typeCheck

public Pattern typeCheck(String name,
                         Pattern pattern)
                  throws XPathException

Type-check a pattern. This is called to check each pattern while the containing instruction is being validated. It is not just a static type-check, it also adds code to perform any necessary run-time type checking and/or conversion.

Parameters:

name - the name of the attribute holding the pattern, for example "match": used in diagnostics

pattern - the compiled pattern

Returns:

the original pattern, or a substitute pattern if it has been rewritten

Throws:

XPathException

fixupReferences

public void fixupReferences()
                     throws XPathException

Fix up references from XPath expressions. Overridden for function declarations and variable declarations

Throws:

XPathException

getContainingSlotManager

public SlotManager getContainingSlotManager()

Get the SlotManager for the containing Procedure definition

Returns:

the SlotManager associated with the containing Function, Template, etc, or null if there is no such containing Function, Template etc.

validateSubtree

public void validateSubtree()
                     throws XPathException

Recursive walk through the stylesheet to validate all nodes

Throws:

XPathException

getPrincipalStylesheet

public XSLStylesheet getPrincipalStylesheet()

Get the principal XSLStylesheet node. This gets the principal style sheet, i.e. the one originally loaded, that forms the root of the import/include tree

Returns:

the xsl:stylesheet element at the root of the principal stylesheet module

getPreparedStylesheet

public PreparedStylesheet getPreparedStylesheet()

Get the PreparedStylesheet object.

Returns:

the PreparedStylesheet to which this stylesheet element belongs

checkWithinTemplate

public void checkWithinTemplate()
                         throws XPathException

Check that the stylesheet element is within a sequence constructor

Throws:

XPathException - if not within a sequence constructor

checkTopLevel

public void checkTopLevel(String errorCode)
                   throws XPathException

Convenience method to check that the stylesheet element is at the top level

Parameters:

errorCode - the error to throw if it is not at the top level; defaults to XTSE0010 if the value is null

Throws:

XPathException - if not at top level

checkEmpty

public void checkEmpty()
                throws XPathException

Convenience method to check that the stylesheet element is empty

Throws:

XPathException - if it is not empty

reportAbsence

public void reportAbsence(String attribute)
                   throws XPathException

Convenience method to report the absence of a mandatory attribute

Parameters:

attribute - the name of the attribute whose absence is to be reported

Throws:

XPathException - if the attribute is missing

compile

public abstract Expression compile(Executable exec)
                            throws XPathException

Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.

Parameters:

exec - the Executable

Returns:

either a ComputedExpression, or null. The value null is returned when compiling an instruction that returns a no-op, or when compiling a top-level object such as an xsl:template that compiles into something other than an instruction.

Throws:

XPathException

compileSequenceConstructor

public Expression compileSequenceConstructor(Executable exec,
                                             AxisIterator iter,
                                             boolean includeParams)
                                      throws XPathException

Compile the children of this instruction on the stylesheet tree, adding the subordinate instructions to the parent instruction on the execution tree.

Parameters:

exec - the Executable

iter - Iterator over the children. This is used in the case where there are children that are not part of the sequence constructor, for example the xsl:sort children of xsl:for-each; the iterator can be positioned past such elements.

includeParams - true if xsl:param elements are to be treated as child instructions (true for templates but not for functions)

Returns:

an Expression tree representing the children of this instruction

Throws:

XPathException

isTopLevel

public boolean isTopLevel()

Test whether this is a top-level element

Returns:

true if the element is a child of the xsl:stylesheet element

bindVariable

public XSLVariableDeclaration bindVariable(StructuredQName qName)
                                    throws XPathException

Bind a variable used in this element to the compiled form of the XSLVariable element in which it is declared

Parameters:

qName - The name of the variable

Returns:

the XSLVariableDeclaration (that is, an xsl:variable or xsl:param instruction) for the variable

Throws:

XPathException - if the variable has not been declared

getStylesheetFunction

public XSLFunction getStylesheetFunction(StructuredQName qName,
                                         int arity)

Get a FunctionCall declared using an xsl:function element in the stylesheet

Parameters:

qName - the name of the function

arity - the number of arguments in the function call. The value -1 indicates that any arity will do (this is used to support the function-available() function).

Returns:

the XSLFunction object representing the function declaration in the stylesheet, or null if no such function is defined.

getAllStylesheetFunctions

public List getAllStylesheetFunctions()

Get a list of all stylesheet functions, excluding any that are masked by one of higher precedence

Returns:

a list of all stylesheet functions. The members of the list are instances of class XSLFunction

getConstructType

public int getConstructType()

Get the type of construct. This will be a constant in class Location. This method is part of the InstructionInfo interface

Specified by:

getConstructType in interface InstructionInfo

getObjectName

public StructuredQName getObjectName(NamePool pool)

Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically. If there is no name, the value will be -1.

Specified by:

getObjectName in interface InstructionInfo

Parameters:

pool - the name pool (not needed in this implementation of the method)

getObjectName

public StructuredQName getObjectName()

Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically. If there is no name, the value will be null.

Returns:

the name of the object declared in this element, if any

setObjectName

public void setObjectName(StructuredQName qName)

Set the object name, for example the name of a function, variable, or template declared on this element

Parameters:

qName - the object name as a QName

getProperty

public Object getProperty(String name)

Get the value of a particular property of the instruction. This is part of the InstructionInfo interface for run-time tracing and debugging. The properties available include all the attributes of the source instruction (named by the attribute name): these are all provided as string values.

Specified by:

getProperty in interface InstructionInfo

Parameters:

name - The name of the required property

Returns:

The value of the requested property, or null if the property is not available

getProperties

public Iterator getProperties()

Get an iterator over all the properties available. The values returned by the iterator will be of type String, and each string can be supplied as input to the getProperty() method to retrieve the value of the property.

Specified by:

getProperties in interface InstructionInfo

getSystemId

public String getSystemId(long locationId)

Description copied from interface: LocationProvider

Get the URI of the document or module containing a particular location

Specified by:

getSystemId in interface LocationProvider

Parameters:

locationId - identifier of the location in question (as passed down the Receiver pipeline)

Returns:

the URI of the document or module.

getLineNumber

public int getLineNumber(long locationId)

Description copied from interface: LocationProvider

Get the line number within the document or module containing a particular location

Specified by:

getLineNumber in interface LocationProvider

Parameters:

locationId - identifier of the location in question (as passed down the Receiver pipeline)

Returns:

the line number within the document or module.

getHostLanguage

public int getHostLanguage()

Get the host language (XSLT, XQuery, XPath) used to implement the code in this container

Specified by:

getHostLanguage in interface Container

Returns:

typically Configuration.XSLT or Configuration.XQUERY

replaceSubExpression

public boolean replaceSubExpression(Expression original,
                                    Expression replacement)

Replace one subexpression by a replacement subexpression

Specified by:

replaceSubExpression in interface Container

Parameters:

original - the original subexpression

replacement - the replacement subexpression

Returns:

true if the original subexpression is found

hasChildNodes

public final boolean hasChildNodes()

Determine if the node has any children.

Specified by:

hasChildNodes in interface NodeInfo

Overrides:

hasChildNodes in class NodeImpl

Returns:

true if the node has any children, false if the node has no children.

getFirstChild

public final NodeInfo getFirstChild()

Get the first child node of the element

Overrides:

getFirstChild in class NodeImpl

Returns:

the first child node of the required type, or null if there are no children

getLastChild

public final NodeInfo getLastChild()

Get the last child node of the element

Overrides:

getLastChild in class NodeImpl

Returns:

the last child of the element, or null if there are no children

getStringValue

public String getStringValue()

Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.

Returns:

the accumulated character content of the element, including descendant elements.

See Also:

Item.getStringValueCS()

getStringValueCS

public CharSequence getStringValueCS()

Description copied from class: NodeImpl

Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.

Specified by:

getStringValueCS in interface Item

Specified by:

getStringValueCS in interface ValueRepresentation

Overrides:

getStringValueCS in class NodeImpl

Returns:

the string value of the item

See Also:

Item.getStringValue()

addChild

public void addChild(NodeImpl node,
                     int index)

Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.

Parameters:

node - the node to be added as a child of this node

index - the position where the child is to be added

compact

public void compact(int size)

Compact the space used by this node

Parameters:

size - the number of actual children