net.sf.saxon.expr.instruct

Class ComponentBody

java.lang.Object

net.sf.saxon.expr.instruct.ComponentBody

All Implemented Interfaces:

SourceLocator, Container, InstructionInfo

Direct Known Subclasses:

Accumulator, AttributeSet, GlobalVariable, KeyDefinition, Template, UserFunction

public abstract class ComponentBody
extends Object
implements Container, InstructionInfo

This object represents the compiled form of a user-written function, template, attribute-set, etc (the source can be either an XSLT stylesheet function or an XQuery function).

It is assumed that type-checking, of both the arguments and the results, has been handled at compile time. That is, the expression supplied as the body of the function must be wrapped in code to check or convert the result to the required type, and calls on the function must be wrapped at compile time to check or convert the supplied arguments.

Field Summary

Fields

Modifier and Type	Field and Description
protected Expression	body

Constructor Summary

Constructors

Constructor and Description
ComponentBody()

Method Summary

Methods

Modifier and Type	Method and Description
void	allocateAllBindingSlots(StylesheetPackage pack) Allocate slot numbers to all the external component references in this procedure
protected static void	allocateBindingSlotsRecursive(StylesheetPackage pack, ComponentBody p, Expression exp)
Expression	getBody()
int	getColumnNumber()
abstract int	getComponentKind() Get the kind of component that this represents, using integer constants such as StandardNames.XSL_FUNCTION
Configuration	getConfiguration() Get the Configuration to which this Container belongs
int	getContainerGranularity() Get the granularity of the container.
Component	getDeclaringComponent()
int	getHostLanguage() Get the host language (XSLT, XQuery, XPath) used to implement the code in this container
int	getLineNumber() Get the line number of the instruction in the source stylesheet module.
LocationProvider	getLocationProvider() Get the LocationProvider allowing location identifiers to be resolved.
PackageData	getPackageData() Get basic data about the unit of compilation (XQuery module, XSLT package) to which this container belongs
Iterator<String>	getProperties() Get an iterator over all the properties available.
Object	getProperty(String name) Get the value of a particular property of the instruction.
String	getPublicId()
SlotManager	getStackFrameMap()
String	getSystemId() Get the system identifier (URI) of the source stylesheet or query module containing the instruction.
void	makeDeclaringComponent(Visibility visibility, StylesheetPackage declaringPackage)
void	setBody(Expression body)
void	setHostLanguage(int language)
void	setLineNumber(int lineNumber)
void	setPackageData(PackageData packageData) Set basic data about the unit of compilation (XQuery module, XSLT package) to which this procedure belongs
void	setStackFrameMap(SlotManager map)
void	setSystemId(String systemId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getConstructType, getObjectName

Field Detail

body

protected Expression body

Constructor Detail

ComponentBody

public ComponentBody()

Method Detail

setPackageData

public void setPackageData(PackageData packageData)

Set basic data about the unit of compilation (XQuery module, XSLT package) to which this procedure belongs

Parameters:

packageData - information about the containing package

getPackageData

public PackageData getPackageData()

Get basic data about the unit of compilation (XQuery module, XSLT package) to which this container belongs

Specified by:

getPackageData in interface Container

Returns:

the data about the package

getContainerGranularity

public int getContainerGranularity()

Get the granularity of the container.

Specified by:

getContainerGranularity in interface Container

Returns:

0 for a temporary container created during parsing; 1 for a container that operates at the level of an XPath expression; 2 for a container at the level of a global function or template

makeDeclaringComponent

public void makeDeclaringComponent(Visibility visibility,
                          StylesheetPackage declaringPackage)

getDeclaringComponent

public Component getDeclaringComponent()

allocateAllBindingSlots

public void allocateAllBindingSlots(StylesheetPackage pack)

Allocate slot numbers to all the external component references in this procedure

Parameters:

pack - the containing package

allocateBindingSlotsRecursive

protected static void allocateBindingSlotsRecursive(StylesheetPackage pack,
                                 ComponentBody p,
                                 Expression exp)

getConfiguration

public Configuration getConfiguration()

Get the Configuration to which this Container belongs

Specified by:

getConfiguration in interface Container

Returns:

the Configuration

setBody

public void setBody(Expression body)

setHostLanguage

public void setHostLanguage(int language)

getHostLanguage

public int getHostLanguage()

Description copied from interface: Container

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

getBody

public final Expression getBody()

setStackFrameMap

public void setStackFrameMap(SlotManager map)

getStackFrameMap

public SlotManager getStackFrameMap()

getLocationProvider

public LocationProvider getLocationProvider()

Get the LocationProvider allowing location identifiers to be resolved.

setLineNumber

public void setLineNumber(int lineNumber)

setSystemId

public void setSystemId(String systemId)

getLineNumber

public int getLineNumber()

Description copied from interface: InstructionInfo

Get the line number of the instruction in the source stylesheet module. If this is not known, or if the instruction is an artificial one that does not relate to anything in the source code, the value returned may be -1.

Specified by:

getLineNumber in interface SourceLocator

Specified by:

getLineNumber in interface InstructionInfo

Returns:

the line number of the expression within the containing module

getSystemId

public String getSystemId()

Description copied from interface: InstructionInfo

Get the system identifier (URI) of the source stylesheet or query module containing the instruction. This will generally be an absolute URI. If the system identifier is not known, the method may return null. In some cases, for example where XML external entities are used, the correct system identifier is not always retained.

Specified by:

getSystemId in interface SourceLocator

Specified by:

getSystemId in interface InstructionInfo

Returns:

the URI of the containing module

getColumnNumber

public int getColumnNumber()

Specified by:

getColumnNumber in interface SourceLocator

getPublicId

public String getPublicId()

Specified by:

getPublicId in interface SourceLocator

getProperty

public Object getProperty(String name)

Description copied from interface: InstructionInfo

Get the value of a particular property of the instruction. Properties of XSLT instructions are generally known by the name of the stylesheet attribute that defines them.

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<String> 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. The iterator may return properties whose value is null.

Specified by:

getProperties in interface InstructionInfo

Returns:

an iterator over the properties.

getComponentKind

public abstract int getComponentKind()

Get the kind of component that this represents, using integer constants such as StandardNames.XSL_FUNCTION