Module org.apache.jena.arq

Package org.apache.jena.sparql.expr.nodevalue

Class XSDFuncOp

java.lang.Object

org.apache.jena.sparql.expr.nodevalue.XSDFuncOp

public class XSDFuncOp
extends Object

Implementation of XQuery/XPath functions and operators. http://www.w3.org/TR/xpath-functions/

Field Summary

Fields

Modifier and Type	Field	Description
static final String	implicitTimezoneStr
static Duration	zeroDuration

Method Summary

Modifier and Type	Method	Description
static NodeValue	abs(NodeValue nv)
static NodeValue	adjustToTimezone(NodeValue nv1, NodeValue nv2)	Adjust xsd:dateTime/xsd:date/xsd:time to a timezone.
static boolean	booleanEffectiveValue(NodeValue nv)	F&O fn:boolean
static NodeValue	booleanEffectiveValueAsNodeValue(NodeValue nv)	F&O fn:boolean
static String	canonicalDecimalStr(BigDecimal decimal)	Canonical decimal according to XML Schema Datatype 2.
static String	canonicalDecimalStrNoIntegerDot(BigDecimal bd)	Decimal format, cast-to-string.
static NodeValue	ceiling(NodeValue v)
static NumericType	classifyNumeric(String fName, NodeValue nv)
static NumericType	classifyNumeric(String fName, NodeValue nv1, NodeValue nv2)
static int	compareBoolean(NodeValue nv1, NodeValue nv2)
static int	compareDateTime(NodeValue nv1, NodeValue nv2)
static int	compareDateTimeFO(NodeValue nv1, NodeValue nv2)	Strict F&O handling of compare date(times).
static int	compareDateTimeXSD(NodeValue nv1, NodeValue nv2)	Compare two date/times by XSD rules (dateTimes, one with and one without timezone can be indeterminate)
static int	compareDuration(NodeValue nv1, NodeValue nv2)
static int	compareNumeric(NodeValue nv1, NodeValue nv2)
static int	compareString(NodeValue nv1, NodeValue nv2)
static int	compareXSDDateTime(NodeValue nv1, NodeValue nv2)	Compare date times, including "indeterminate" rather than applying locale timezone
static NodeValue	dateTimeCast(NodeValue nv, XSDDatatype xsd)	Cast a NodeValue to a date/time type (xsd dateTime, date, time, g*) according to F&O 17.1.5 Casting to date and time types Throws an exception on incorrect case.
static NodeValue	dtDateTime(NodeValue nv1, NodeValue nv2)	Create an xsd:dateTime from an xsd:date and an xsd:time.
static NodeValue	dtGetDay(NodeValue nv)
static NodeValue	dtGetHours(NodeValue nv)
static NodeValue	dtGetMinutes(NodeValue nv)
static NodeValue	dtGetMonth(NodeValue nv)
static NodeValue	dtGetSeconds(NodeValue nv)
static NodeValue	dtGetTimezone(NodeValue nv)
static NodeValue	dtGetTZ(NodeValue nv)
static NodeValue	dtGetYear(NodeValue nv)
static NodeValue	durGetDays(NodeValue nv)
static NodeValue	durGetHours(NodeValue nv)
static NodeValue	durGetMinutes(NodeValue nv)
static NodeValue	durGetMonths(NodeValue nv)
static NodeValue	durGetSeconds(NodeValue nv)
static NodeValue	durGetSign(NodeValue nv)
static NodeValue	durGetYears(NodeValue nv)
static NodeValue	floor(NodeValue v)
static NodeValue	fnConcat(List<NodeValue> args)	F&O fn:concat (implicit cast to strings).
static NodeValue	formatNumber(NodeValue nv, NodeValue picture, NodeValue nvLocale)	fn:format-number The 3rd argument, if present, called decimal-format-name, is here a IETF BCP 47 language tag string.
static NodeValue	getDay(NodeValue nv)
static NodeValue	getHours(NodeValue nv)
static NodeValue	getMinutes(NodeValue nv)
static NodeValue	getMonth(NodeValue nv)
static NodeValue	getSeconds(NodeValue nv)
static NodeValue	getYear(NodeValue nv)
static NodeValue	implicitTimezone()	Implciit Timezone // https://www.w3.org/TR/xpath-functions-3/#comp.datetime
static boolean	isBinaryDatatype(XSDDatatype datatype)
static boolean	isDayTime(Duration dur)
static boolean	isDecimalDatatype(XSDDatatype xsdDatatype)
static boolean	isDurationDatatype(XSDDatatype datatype)
static boolean	isIntegerDatatype(XSDDatatype xsdDatatype)
static boolean	isNumeric(Node node)
static boolean	isNumericDatatype(XSDDatatype xsdDatatype)
static boolean	isTemporalDatatype(XSDDatatype datatype)
static boolean	isYearMonth(Duration dur)
static NodeValue	javaSprintf(NodeValue nvFormat, List<NodeValue> valuesToPrint)
static NodeValue	javaSubstring(NodeValue v1, NodeValue v2)
static NodeValue	javaSubstring(NodeValue nvString, NodeValue nvStart, NodeValue nvFinish)
static NodeValue	localSystemTimezone()	Local timezone of the query engine: afn:system-timezone
static NodeValue	max(NodeValue nv1, NodeValue nv2)
static NodeValue	min(NodeValue nv1, NodeValue nv2)
static NodeValue	not(NodeValue nv)	F&O fn:not
static NodeValue	numAdd(NodeValue nv1, NodeValue nv2)
static NodeValue	numDivide(NodeValue nv1, NodeValue nv2)
static NodeValue	numericMod(NodeValue nv1, NodeValue nv2)
static NodeValue	numIntegerDivide(NodeValue nv1, NodeValue nv2)	Integer divide
static NodeValue	numMultiply(NodeValue nv1, NodeValue nv2)
static NodeValue	numSubtract(NodeValue nv1, NodeValue nv2)
static NodeValue	round(NodeValue v)
static NodeValue	roundXpath3(NodeValue v, NodeValue precision, boolean isHalfEven)
static NodeValue	sqrt(NodeValue v)
static NodeValue	strAfter(NodeValue string, NodeValue match)
static NodeValue	strBefore(NodeValue string, NodeValue match)
static NodeValue	strConcat(List<NodeValue> args)	SPARQL CONCAT (no implicit casts to strings)
static NodeValue	strContains(NodeValue string, NodeValue match)
static NodeValue	strEncodeForURI(NodeValue v)
static NodeValue	strEndsWith(NodeValue string, NodeValue match)
static NodeValue	strlen(NodeValue nvString)
static NodeValue	strLowerCase(NodeValue string)
static NodeValue	strNormalizeSpace(NodeValue v)	fn:normalizeSpace
static NodeValue	strNormalizeUnicode(NodeValue v1, NodeValue v2)
static NodeValue	strReplace(NodeValue nvStr, Pattern pattern, NodeValue nvReplacement)
static NodeValue	strReplace(NodeValue nvStr, NodeValue nvPattern, NodeValue nvReplacement)
static NodeValue	strReplace(NodeValue nvStr, NodeValue nvPattern, NodeValue nvReplacement, NodeValue nvFlags)
static NodeValue	strStartsWith(NodeValue string, NodeValue match)
static NodeValue	strUpperCase(NodeValue string)
static NodeValue	substring(NodeValue v1, NodeValue v2)
static NodeValue	substring(NodeValue nvString, NodeValue nvStart, NodeValue nvLength)
static NodeValue	unaryMinus(NodeValue nv)
static NodeValue	unaryPlus(NodeValue nv)

Methods inherited from class java.lang.Object

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

Field Details

zeroDuration

public static Duration zeroDuration

implicitTimezoneStr

public static final String implicitTimezoneStr

See Also:

• Constant Field Values

Method Details

numAdd

public static NodeValue numAdd(NodeValue nv1,
 NodeValue nv2)

numSubtract

public static NodeValue numSubtract(NodeValue nv1,
 NodeValue nv2)

numMultiply

public static NodeValue numMultiply(NodeValue nv1,
 NodeValue nv2)

numDivide

public static NodeValue numDivide(NodeValue nv1,
 NodeValue nv2)

numIntegerDivide

public static NodeValue numIntegerDivide(NodeValue nv1,
 NodeValue nv2)

Integer divide

numericMod

public static NodeValue numericMod(NodeValue nv1,
 NodeValue nv2)

canonicalDecimalStrNoIntegerDot

public static String canonicalDecimalStrNoIntegerDot(BigDecimal bd)

Decimal format, cast-to-string.

Decimal canonical form where integer values have no ".0" (as in XSD 1.1).

In XSD 2, canonical integer-valued decimal has a trailing ".0". In F&O v 3.1, xs:string cast of a decimal which integer valued, does not have the trailing ".0".

canonicalDecimalStr

public static String canonicalDecimalStr(BigDecimal decimal)

Canonical decimal according to XML Schema Datatype 2. Integer-valued decimals have a trailing ".0". (In XML Schema Datatype 1.1 they did not have a ".0".)

Java BigDecimal.toPlainString does not produce XSD 2 compatible lexical forms for integer values.

max

public static NodeValue max(NodeValue nv1,
 NodeValue nv2)

min

public static NodeValue min(NodeValue nv1,
 NodeValue nv2)

not

public static NodeValue not(NodeValue nv)

F&O fn:not

booleanEffectiveValueAsNodeValue

public static NodeValue booleanEffectiveValueAsNodeValue(NodeValue nv)

F&O fn:boolean

booleanEffectiveValue

public static boolean booleanEffectiveValue(NodeValue nv)

F&O fn:boolean

unaryMinus

public static NodeValue unaryMinus(NodeValue nv)

unaryPlus

public static NodeValue unaryPlus(NodeValue nv)

abs

public static NodeValue abs(NodeValue nv)

ceiling

public static NodeValue ceiling(NodeValue v)

floor

public static NodeValue floor(NodeValue v)

round

public static NodeValue round(NodeValue v)

roundXpath3

public static NodeValue roundXpath3(NodeValue v,
 NodeValue precision,
 boolean isHalfEven)

sqrt

public static NodeValue sqrt(NodeValue v)

javaSubstring

public static NodeValue javaSubstring(NodeValue v1,
 NodeValue v2)

javaSubstring

public static NodeValue javaSubstring(NodeValue nvString,
 NodeValue nvStart,
 NodeValue nvFinish)

javaSprintf

public static NodeValue javaSprintf(NodeValue nvFormat,
 List<NodeValue> valuesToPrint)

strlen

public static NodeValue strlen(NodeValue nvString)

strReplace

public static NodeValue strReplace(NodeValue nvStr,
 NodeValue nvPattern,
 NodeValue nvReplacement,
 NodeValue nvFlags)

strReplace

public static NodeValue strReplace(NodeValue nvStr,
 Pattern pattern,
 NodeValue nvReplacement)

strReplace

public static NodeValue strReplace(NodeValue nvStr,
 NodeValue nvPattern,
 NodeValue nvReplacement)

substring

public static NodeValue substring(NodeValue v1,
 NodeValue v2)

substring

public static NodeValue substring(NodeValue nvString,
 NodeValue nvStart,
 NodeValue nvLength)

strContains

public static NodeValue strContains(NodeValue string,
 NodeValue match)

strStartsWith

public static NodeValue strStartsWith(NodeValue string,
 NodeValue match)

strEndsWith

public static NodeValue strEndsWith(NodeValue string,
 NodeValue match)

strBefore

public static NodeValue strBefore(NodeValue string,
 NodeValue match)

strAfter

public static NodeValue strAfter(NodeValue string,
 NodeValue match)

strLowerCase

public static NodeValue strLowerCase(NodeValue string)

strUpperCase

public static NodeValue strUpperCase(NodeValue string)

strEncodeForURI

public static NodeValue strEncodeForURI(NodeValue v)

fnConcat

public static NodeValue fnConcat(List<NodeValue> args)

F&O fn:concat (implicit cast to strings).

strConcat

public static NodeValue strConcat(List<NodeValue> args)

SPARQL CONCAT (no implicit casts to strings)

strNormalizeSpace

public static NodeValue strNormalizeSpace(NodeValue v)

fn:normalizeSpace

strNormalizeUnicode

public static NodeValue strNormalizeUnicode(NodeValue v1,
 NodeValue v2)

classifyNumeric

public static NumericType classifyNumeric(String fName,
 NodeValue nv1,
 NodeValue nv2)

classifyNumeric

public static NumericType classifyNumeric(String fName,
 NodeValue nv)

isNumericDatatype

public static boolean isNumericDatatype(XSDDatatype xsdDatatype)

isNumeric

public static boolean isNumeric(Node node)

isDecimalDatatype

public static boolean isDecimalDatatype(XSDDatatype xsdDatatype)

isIntegerDatatype

public static boolean isIntegerDatatype(XSDDatatype xsdDatatype)

isTemporalDatatype

public static boolean isTemporalDatatype(XSDDatatype datatype)

isDurationDatatype

public static boolean isDurationDatatype(XSDDatatype datatype)

isBinaryDatatype

public static boolean isBinaryDatatype(XSDDatatype datatype)

compareNumeric

public static int compareNumeric(NodeValue nv1,
 NodeValue nv2)

compareString

public static int compareString(NodeValue nv1,
 NodeValue nv2)

compareDateTime

public static int compareDateTime(NodeValue nv1,
 NodeValue nv2)

compareDateTimeXSD

public static int compareDateTimeXSD(NodeValue nv1,
 NodeValue nv2)

Compare two date/times by XSD rules (dateTimes, one with and one without timezone can be indeterminate)

compareDateTimeFO

public static int compareDateTimeFO(NodeValue nv1,
 NodeValue nv2)

Strict F&O handling of compare date(times). But that means applying the "local" timezone if there is no TZ. The data may have come from different timezones to the query. We use a fixed locale timezone of UTC/00:00.

compareXSDDateTime

public static int compareXSDDateTime(NodeValue nv1,
 NodeValue nv2)

Compare date times, including "indeterminate" rather than applying locale timezone

compareBoolean

public static int compareBoolean(NodeValue nv1,
 NodeValue nv2)

dateTimeCast

public static NodeValue dateTimeCast(NodeValue nv,
 XSDDatatype xsd)

Cast a NodeValue to a date/time type (xsd dateTime, date, time, g*) according to F&O 17.1.5 Casting to date and time types Throws an exception on incorrect case.

Throws:

ExprEvalTypeException

getYear

public static NodeValue getYear(NodeValue nv)

getMonth

public static NodeValue getMonth(NodeValue nv)

getDay

public static NodeValue getDay(NodeValue nv)

getHours

public static NodeValue getHours(NodeValue nv)

getMinutes

public static NodeValue getMinutes(NodeValue nv)

getSeconds

public static NodeValue getSeconds(NodeValue nv)

dtDateTime

public static NodeValue dtDateTime(NodeValue nv1,
 NodeValue nv2)

Create an xsd:dateTime from an xsd:date and an xsd:time.

dtGetYear

public static NodeValue dtGetYear(NodeValue nv)

dtGetMonth

public static NodeValue dtGetMonth(NodeValue nv)

dtGetDay

public static NodeValue dtGetDay(NodeValue nv)

dtGetHours

public static NodeValue dtGetHours(NodeValue nv)

dtGetMinutes

public static NodeValue dtGetMinutes(NodeValue nv)

dtGetSeconds

public static NodeValue dtGetSeconds(NodeValue nv)

dtGetTZ

public static NodeValue dtGetTZ(NodeValue nv)

dtGetTimezone

public static NodeValue dtGetTimezone(NodeValue nv)

isYearMonth

public static boolean isYearMonth(Duration dur)

isDayTime

public static boolean isDayTime(Duration dur)

durGetYears

public static NodeValue durGetYears(NodeValue nv)

durGetMonths

public static NodeValue durGetMonths(NodeValue nv)

durGetDays

public static NodeValue durGetDays(NodeValue nv)

durGetHours

public static NodeValue durGetHours(NodeValue nv)

durGetMinutes

public static NodeValue durGetMinutes(NodeValue nv)

durGetSeconds

public static NodeValue durGetSeconds(NodeValue nv)

durGetSign

public static NodeValue durGetSign(NodeValue nv)

compareDuration

public static int compareDuration(NodeValue nv1,
 NodeValue nv2)

implicitTimezone

public static NodeValue implicitTimezone()

Implciit Timezone // https://www.w3.org/TR/xpath-functions-3/#comp.datetime

localSystemTimezone

public static NodeValue localSystemTimezone()

Local timezone of the query engine: afn:system-timezone

adjustToTimezone

public static NodeValue adjustToTimezone(NodeValue nv1,
 NodeValue nv2)

Adjust xsd:dateTime/xsd:date/xsd:time to a timezone. This covers fn:adjust-dateTime-to-timezone, fn:adjust-date-to-timezone and fn:adjust-time-to-timezone. via ADJUST (E_AdjustToTimezone). If the second argument is null, use implicit timezone. In Jena, the implicit timezone is fixed to UTC.

formatNumber

public static NodeValue formatNumber(NodeValue nv,
 NodeValue picture,
 NodeValue nvLocale)

fn:format-number The 3rd argument, if present, called decimal-format-name, is here a IETF BCP 47 language tag string.