net.sf.saxon.functions

Class Translate

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunctionCall

net.sf.saxon.functions.Translate

All Implemented Interfaces:

SourceLocator, Callable, IdentityComparable, InstructionInfo

public class Translate
extends SystemFunctionCall
implements Callable

Implement the XPath translate() function

Field Summary

Fields inherited from class net.sf.saxon.functions.SystemFunctionCall

operation

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

argument

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

EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD

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
StringValue	evaluateItem(XPathContext context) Evaluate the function
ExpressionCompiler	getExpressionCompiler() Return the compiler of the Translate expression
IntToIntMap	getStaticMap() Get the translation map built at compile time if there is one
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
Expression	typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) Type-check the expression.

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

addContextDocumentArgument, addDocToPathMap, bindStaticContext, checkArguments, computeCardinality, computeSpecialProperties, copy, equalOrNull, equals, getContextNode, getConvertingCallable, getDefaultArgumentNode, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getImplementationMethod, getItemType, getOperation, getRequiredType, makeSystemFunction, operands, optimize, setDetails, toShortString, useContextItemAsDefault

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

addExternalFunctionCallToPathMap, checkArgumentCount, explain, getArguments, getDisplayName, getExpressionName, getFunctionName, getNumberOfArguments, hashCode, preEvaluate, promote, replaceOperand, setArguments, setFunctionName, simplifyArguments, toString

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

addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, clearStreamabilityData, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getConfiguration, getConstructType, getContainer, getDependencies, getEvaluationMethod, getHostLanguage, getIntegerBounds, getIntrinsicDependencies, getLineNumber, getLocationId, getObjectName, getPosture, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getStreamability, getStreamingAdjunct, getSweep, getSystemId, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isIdentical, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterate, iterateEvents, makeStreamingAdjunct, markTailFunctionCalls, operandList, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, setPostureAndSweep, simplify, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, typeError, unordered

Methods inherited from class java.lang.Object

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

Constructor Detail

Translate

public Translate()

Method Detail

typeCheck

public Expression typeCheck(ExpressionVisitor visitor,
                   ContextItemStaticInfo contextInfo)
                     throws XPathException

Description copied from class: FunctionCall

Type-check the expression. This also calls preEvaluate() to evaluate the function if all the arguments are constant; functions that do not require this behavior can override the preEvaluate method.

Overrides:

typeCheck in class FunctionCall

Parameters:

visitor - an expression visitor

contextInfo - Information available statically about the context item: whether it is (possibly) absent; its static type; its streaming posture.

Returns:

the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations

Throws:

XPathException - if an error is discovered during this phase (typically a type error)

evaluateItem

public StringValue evaluateItem(XPathContext context)
                         throws XPathException

Evaluate the function

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

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

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 Expression

Returns:

the relevant ExpressionCompiler