net.sf.saxon.functions

Class FormatInteger

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.FormatInteger

All Implemented Interfaces:

java.lang.Iterable<Function>, Callable, StatefulSystemFunction, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class FormatInteger
extends SystemFunction
implements StatefulSystemFunction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	preface

Constructor Summary

Constructors

Constructor and Description
FormatInteger()

Method Summary

Modifier and Type	Method and Description
StringValue	call(XPathContext context, Sequence[] arguments) Evaluate the expression
SystemFunction	copy() Make a copy of this SystemFunction.
static NumericGroupFormatter	getPicSeparators(java.lang.String pic) Get the picture separators and filter them out of the picture.
Expression	makeOptimizedFunctionCall(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo, Expression... arguments) Allow the function to create an optimized call based on the values of the actual arguments

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

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

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

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.Function

argumentArray, getGenre

Methods inherited from interface net.sf.saxon.om.Item

getLength, head, isStreamed, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

preface

public static final java.lang.String preface

See Also:

Constant Field Values

Constructor Detail

FormatInteger

public FormatInteger()

Method Detail

makeOptimizedFunctionCall

public Expression makeOptimizedFunctionCall(ExpressionVisitor visitor,
                                            ContextItemStaticInfo contextInfo,
                                            Expression... arguments)
                                     throws XPathException

Description copied from class: SystemFunction

Allow the function to create an optimized call based on the values of the actual arguments

Overrides:

makeOptimizedFunctionCall in class SystemFunction

Parameters:

visitor - the expression visitor

contextInfo - information about the context item

arguments - the supplied arguments to the function call. Note: modifying the contents of this array should not be attempted, it is likely to have no effect.

Returns:

either a function call on this function, or an expression that delivers the same result, or null indicating that no optimization has taken place

Throws:

XPathException - if an error is detected

call

public StringValue call(XPathContext context,
                        Sequence[] arguments)
                 throws XPathException

Evaluate the expression

Specified by:

call in interface Callable

Specified by:

call in interface Function

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as SequenceIterators

Returns:

the result of the evaluation, in the form of a SequenceIterator

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

getPicSeparators

public static NumericGroupFormatter getPicSeparators(java.lang.String pic)
                                              throws XPathException

Get the picture separators and filter them out of the picture. Has side effect of creating a simplified picture, which it makes available as the getAdjustedPicture() property of the returned NumericGroupFormatter.

Parameters:

pic - the formatting picture, after stripping off any modifiers

Returns:

a NumericGroupFormatter that implements the formatting defined in the picture

Throws:

XPathException - if the picture is invalid

copy

public SystemFunction copy()

Description copied from interface: StatefulSystemFunction

Make a copy of this SystemFunction. This is required only for system functions such as regex functions that maintain state on behalf of a particular caller.

Specified by:

copy in interface StatefulSystemFunction

Returns:

a copy of the system function able to contain its own copy of the state on behalf of the caller.