Package org.partiql.lang.util

Types

Containing static methods intended to be invoked by Java clients, this class provides a standard way to compare identifiers and includes some helper methods for looking up values from IonStruct and Map instances according to the specified BindingCase.

ConfigurableExprValueFormatter

class ConfigurableExprValueFormatter(config: ConfigurableExprValueFormatter.Configuration) : ExprValueFormatter

ExprValueFormatter

interface ExprValueFormatter

IonWriterContext

class IonWriterContext(writer: IonWriter)

A simple wrapper for writing Ion from Kotlin. This is not implemented as a set of extension methods because our coding standards disallow non-private extension methods.

WhenAsExpressionHelper

class WhenAsExpressionHelper

See case for a description of how to use this[]

Functions

asIonInt

fun IonValue.asIonInt(): IonInt

asIonSexp

fun IonValue.asIonSexp(): IonSexp

asIonStruct

fun IonValue.asIonStruct(): IonStruct

asIonSymbol

fun IonValue.asIonSymbol(): IonSymbol

asSequence

fun IonValue.asSequence(): Sequence<IonValue>

bigDecimalValue

fun IonValue.bigDecimalValue(): BigDecimal

bigDecimalValueOrNull

fun IonValue.bigDecimalValueOrNull(): BigDecimal?

booleanValue

fun IonValue.booleanValue(): Boolean

booleanValueOrNull

fun IonValue.booleanValueOrNull(): Boolean?

bytesValue

fun IonValue.bytesValue(): ByteArray

bytesValueOrNull

fun IonValue.bytesValueOrNull(): ByteArray?

cartesianProduct

fun <T> List<List<T>>.cartesianProduct(): List<List<T>>

Returns the cartesian product between each list in this (i.e. every possible list formed by choosing an element from each of the sublists where order matters). Elements in each sub-list must have homogeneous elements.

case

inline fun case(block: () -> Unit): WhenAsExpressionHelper

In Kotlin, the cases of a when <is <type>>... must be exhaustive only when when is used as an expression. Wrapping each of the cases in this is an attempt to allow when to be easily used as an expression even when an expression isn't actually needed. Example:

caseInsensitiveEquivalent

fun String.caseInsensitiveEquivalent(name: String): Boolean

One case insensitive equality check to rule them all.

codePointSequence

fun String.codePointSequence(): Sequence<Int>

Provides a lazy sequence over the code points in the given string.

coerce

fun <T : Number> Number.coerce(type: Class<T>): T

Provides a narrowing or widening operator on supported numbers.

coerceNumbers

fun coerceNumbers(first: Number, second: Number): Pair<Number, Number>

Implements a very simple number tower to convert two numbers to their arithmetic compatible type.

compareTo

operator fun Number.compareTo(other: Number): Int

div

operator fun Number.div(other: Number): Number

doubleValue

fun IonValue.doubleValue(): Double

doubleValueOrNull

fun IonValue.doubleValueOrNull(): Double?

downcast

fun <T> Any.downcast(type: Class<T>?): T?

Simple dynamic downcast for a type.

exp

fun BigDecimal.exp(mathContext: MathContext = MATH_CONTEXT): BigDecimal

Computes e^x of a given BigDecimal x.

field

fun IonStruct.field(nameOfField: String): IonValue

filterMetaNodes

fun IonSexp.filterMetaNodes(): IonValue

Creates a new IonSexp from a legacy AST IonSexp that strips out meta nodes.

foldLeftProduct

inline fun <T, S, C> List<S>.foldLeftProduct(initialContext: C, crossinline map: (C, S) -> Iterator<Pair<C, T>>): Iterable<List<T>>

Constructs a cartesian product of the given ordered list of source elements, by computing the Iterable via a mapping function with a context. The mapping function constructs an Iterator of Pair instances of C and S that are used to derive subsequent iterators.

forAll

inline fun <T> List<T>.forAll(predicate: (T) -> Boolean): Boolean

Given a predicate function, return true if all members of the list satisfy the predicate, return false otherwise. In the case that an empty list is given, the result is true.

get

operator fun IonValue.get(index: Int): IonValue

operator fun IonValue.get(name: String): IonValue?

ionValue

fun Number.ionValue(ion: IonSystem): IonValue

isAnyMissing

fun Iterable<ExprValue>.isAnyMissing(): Boolean

Returns true if any ExprValue in the Iterable is missing.

isAnyNull

fun Iterable<ExprValue>.isAnyNull(): Boolean

Returns true if any ExprValue in the Iterable is null.

isAnyUnknown

fun Iterable<ExprValue>.isAnyUnknown(): Boolean

Returns true if any ExprValue in the Iterable is an unknown value, i.e. either MISSING or NULL.

isAstLiteral

fun IonValue.isAstLiteral(): Boolean

isBindingNameEquivalent

fun String.isBindingNameEquivalent(other: String, case: BindingCase): Boolean

Compares this string to other using the rules specified by case.

iterator

operator fun IonValue.iterator(): Iterator<IonValue>

javaValue

fun IonInt.javaValue(): Number

fun BigDecimal.ln(mathContext: MathContext = MATH_CONTEXT): BigDecimal

Compute the natural logarithm of a big decimal.

longValue

fun IonValue.longValue(): Long

longValueOrNull

fun IonValue.longValueOrNull(): Long?

minus

operator fun Number.minus(other: Number): Number

numberValue

fun IonValue.numberValue(): Number

numberValueOrNull

fun IonValue.numberValueOrNull(): Number?

plus

operator fun Number.plus(other: Number): Number

power

fun BigDecimal.power(power: BigDecimal, mathContext: MathContext = MATH_CONTEXT): BigDecimal

Calculate the given big decimal raised to the pth power, where p is another big decimal.

product

fun <T> List<Iterable<T>>.product(): Iterable<List<T>>

Calculates the cartesian product of the given ordered lists of collections of homogeneous values.

propertyValueMapOf

fun propertyValueMapOf(vararg properties: Pair<Property, Any>): PropertyValueMap

fun propertyValueMapOf(line: Int, column: Int, vararg otherProperties: Pair<Property, Any>): PropertyValueMap

Helper function to reduce the syntactical overhead of creating a PropertyValueMap.

rem

operator fun Number.rem(other: Number): Number

seal

fun IonValue.seal(): IonValue

singleArgWithTag

fun IonSexp.singleArgWithTag(tagName: String): IonValue

singleArgWithTagOrNull

fun IonSexp.singleArgWithTagOrNull(tagName: String): IonValue?

squareRoot

fun BigDecimal.squareRoot(mathContext: MathContext = MATH_CONTEXT): BigDecimal

Computes the square root of a given BigDecimal. See https://dl.acm.org/doi/pdf/10.1145/214408.214413

stringValue

fun IonValue.stringValue(): String?

stringValueOrNull

fun IonValue.stringValueOrNull(): String?

times

operator fun Number.times(other: Number): Number

timestampValue

fun IonValue.timestampValue(): Timestamp

timestampValueOrNull

fun IonValue.timestampValueOrNull(): Timestamp?

infix fun Property.to(that: Any): Pair<Property, Any>

Simple overloaded infix operator which accepts a Propery and value as arguments and returns a Pair. Intended to be used in conjunction with propertyValueMapOf.

toIntExact