net.sf.saxon.functions

Class Translate

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Translate

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class Translate
extends SystemFunction
implements Callable

Implement the XPath translate() function

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Translate.TranslateFixed

Constructor Summary

Constructors

Constructor and Description
Translate()

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] arguments) Evaluate the expression
ExpressionCompiler	getExpressionCompiler() Return the compiler of the Translate expression
IntToIntMap	getStaticMap() Get the translation map built at compile time if there is one
Expression	makeOptimizedFunctionCall(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo, Expression... arguments) Allow the function to create an optimized call based on the values of the actual arguments
static CharSequence	translate(StringValue sv0, StringValue sv1, StringValue sv2) Perform the translate function
static CharSequence	translateUsingMap(StringValue in, IntToIntMap map) Implement the translate() function using an index built at compile time

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

equals, export, exportAttributes, getArity, getCardinality, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamingAdjunct, importAttributes, makeCall, makeFunction, makeFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, typeCheckCaller

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

atomize, deepEquals, effectiveBooleanValue, getStringValue, getStringValueCS, isArray, isMap, optimize, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

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

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

iterate

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

head

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

getLength, head, itemAt, reduce, subsequence

Constructor Detail

Translate

public Translate()

Method Detail

makeOptimizedFunctionCall

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

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

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

getStaticMap

public IntToIntMap getStaticMap()

Get the translation map built at compile time if there is one

Returns:

the map built at compile time, or null if not available

translate

public static CharSequence translate(StringValue sv0,
                     StringValue sv1,
                     StringValue sv2)

Perform the translate function

Parameters:

sv0 - the string to be translated

sv1 - the characters to be substituted

sv2 - the replacement characters

Returns:

the converted string

translateUsingMap

public static CharSequence translateUsingMap(StringValue in,
                             IntToIntMap map)

Implement the translate() function using an index built at compile time

Parameters:

in - the string to be translated

map - index built at compile time, mapping input characters to output characters. The map returns -1 for a character that is to be deleted from the input string, Integer.MAX_VALUE for a character that is to remain intact

Returns:

the translated character string

call

public Sequence 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 Sequences

Returns:

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

Throws:

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

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the Translate expression

Overrides:

getExpressionCompiler in class SystemFunction

Returns:

the relevant ExpressionCompiler