net.sf.saxon.functions

Class StartsWith

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.CollatingFunctionFixed

net.sf.saxon.functions.StartsWith

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class StartsWith
extends CollatingFunctionFixed

Implements the fn:starts-with() function, with the collation already known

Constructor Summary

Constructors

Constructor and Description
StartsWith()

Method Summary

Methods

Modifier and Type	Method and Description
BooleanValue	call(XPathContext context, Sequence[] arguments) Evaluate the function
ExpressionCompiler	getExpressionCompiler() Return the compiler of the StartsWith expression
static boolean	startsWith(StringValue arg0, StringValue arg1, StringCollator collator)

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

exportAttributes, getAtomicComparer, getPreAllocatedAtomicComparer, getStringCollator, importAttributes, preAllocateComparer, setCollationName, setRetainedStaticContext

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

equals, export, getArity, getCardinality, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamingAdjunct, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, 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

StartsWith

public StartsWith()

Method Detail

startsWith

public static boolean startsWith(StringValue arg0,
                 StringValue arg1,
                 StringCollator collator)
                          throws XPathException

Throws:

XPathException

call

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

Evaluate the function

Parameters:

context - the XPath dynamic evaluation context

arguments - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the StartsWith expression

Overrides:

getExpressionCompiler in class SystemFunction

Returns:

the relevant ExpressionCompiler