net.sf.saxon.functions
Class Component

java.lang.Object
  net.sf.saxon.expr.Expression
      net.sf.saxon.expr.FunctionCall
          net.sf.saxon.functions.SystemFunction
              net.sf.saxon.functions.Component

All Implemented Interfaces:

Serializable, SourceLocator, Container, EvaluableItem, SequenceIterable, InstructionInfoProvider

public class Component
extends SystemFunction

This class supports the get_X_from_Y functions defined in XPath 2.0

See Also:

Serialized Form

Field Summary

static int	DAY
static int	HOURS
static int	LOCALNAME
static int	MICROSECONDS
static int	MINUTES
static int	MONTH
static int	NAMESPACE
static int	PREFIX
static int	SECONDS
static int	TIMEZONE
static int	WHOLE_SECONDS
static int	YEAR

Fields inherited from class net.sf.saxon.expr.Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Component()

Method Summary

Item	evaluateItem(XPathContext context) Evaluate the expression
int	getRequiredComponent() Get the required component
String	getRequiredComponentAsString() Get the required component name as a string
Expression	simplify(StaticContext env) Simplify the function call.

Methods inherited from class net.sf.saxon.functions.SystemFunction

checkArguments, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, getItemType, main, makeSystemFunction, optimize, setDetails

Methods inherited from class net.sf.saxon.expr.FunctionCall

getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionNameCode, typeCheck

Methods inherited from class net.sf.saxon.expr.Expression

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getContainingProcedure, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, iterate, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation

Methods inherited from class java.lang.Object

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

Field Detail

YEAR

public static final int YEAR

See Also:

Constant Field Values

MONTH

public static final int MONTH

See Also:

Constant Field Values

DAY

public static final int DAY

See Also:

Constant Field Values

HOURS

public static final int HOURS

See Also:

Constant Field Values

MINUTES

public static final int MINUTES

See Also:

Constant Field Values

SECONDS

public static final int SECONDS

See Also:

Constant Field Values

TIMEZONE

public static final int TIMEZONE

See Also:

Constant Field Values

LOCALNAME

public static final int LOCALNAME

See Also:

Constant Field Values

NAMESPACE

public static final int NAMESPACE

See Also:

Constant Field Values

PREFIX

public static final int PREFIX

See Also:

Constant Field Values

MICROSECONDS

public static final int MICROSECONDS

See Also:

Constant Field Values

WHOLE_SECONDS

public static final int WHOLE_SECONDS

See Also:

Constant Field Values

Constructor Detail

Component

public Component()

Method Detail

simplify

public Expression simplify(StaticContext env)
                    throws XPathException

Description copied from class: FunctionCall

Simplify the function call. Default method is to simplify each of the supplied arguments and evaluate the function if all are now known.

Overrides:

simplify in class FunctionCall

Returns:

the simplified expression

Throws:

XPathException - if an error is discovered during expression rewriting

getRequiredComponent

public int getRequiredComponent()

Get the required component

getRequiredComponentAsString

public String getRequiredComponentAsString()

Get the required component name as a string

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Evaluate the expression

Specified by:

evaluateItem in interface EvaluableItem

Overrides:

evaluateItem in class Expression

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