Index (Pathling 9.8.0 API)

A B C D E F G I L M O P R S U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractUdfRegistrar - Class in au.csiro.pathling.sql.udf: A base Spark configurer that registers user-defined functions (UDFs) in Spark sessions.
AbstractUdfRegistrar() - Constructor for class au.csiro.pathling.sql.udf.AbstractUdfRegistrar
AbstractUdfRegistrar.UdfRegistrar - Class in au.csiro.pathling.sql.udf: A helper class for registering user-defined functions with a Spark session.
au.csiro.pathling - package au.csiro.pathling
au.csiro.pathling.annotations - package au.csiro.pathling.annotations
au.csiro.pathling.config - package au.csiro.pathling.config
au.csiro.pathling.errors - package au.csiro.pathling.errors
au.csiro.pathling.fhirpath.literal - package au.csiro.pathling.fhirpath.literal
au.csiro.pathling.spark - package au.csiro.pathling.spark
au.csiro.pathling.sql.udf - package au.csiro.pathling.sql.udf
au.csiro.pathling.utilities - package au.csiro.pathling.utilities
au.csiro.pathling.validation - package au.csiro.pathling.validation

B

backCurried(BiFunction<A1, A2, R>) - Static method in interface au.csiro.pathling.utilities.Functions: Converts a function that takes two arguments to its curried version with reversed arguments.

C

check(boolean) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures the truth of an expression, throwing an AssertionError with the supplied message if it does not evaluate as true.
check(boolean, String, Object...) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures the truth of an expression, throwing an AssertionError with the supplied message if it does not evaluate as true.
checkArgument(boolean, String) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures the truth of an expression, throwing an IllegalArgumentException with the supplied message if it does not evaluate as true.
checkArgumentNotNull(T) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures that an object is not null, throwing an IllegalArgumentException if it is null.
checkPresent(Optional<T>) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures that an Optional value is present, throwing a AssertionError if it is not.
checkPresent(Optional<T>, String) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures that an Optional value is present, throwing a AssertionError if it is not.
checkState(boolean, String) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures the truth of an expression, throwing an IllegalStateException with the supplied message if it does not evaluate as true.
checkUserInput(boolean, String) - Static method in class au.csiro.pathling.utilities.Preconditions: Ensures the truth of an expression, throwing an InvalidUserInputError with the supplied message if it does not evaluate as true.
close() - Method in class au.csiro.pathling.utilities.ObjectHolder.SingletonHolder: Closes this singleton and releases any system resources associated with it.
close() - Method in class au.csiro.pathling.utilities.ResourceCloser
Configurable<T> - Interface in au.csiro.pathling.config: Interface for objects that can provide access to their configuration.
configure(SparkSession) - Method in interface au.csiro.pathling.spark.SparkConfigurer: Configures some aspect of a SparkSession.
configure(SparkSession) - Method in class au.csiro.pathling.sql.udf.AbstractUdfRegistrar: Configures the Spark session by registering user-defined functions.
configure(SparkSession) - Method in class au.csiro.pathling.sql.udf.SqlFunctionRegistrar
curried(BiFunction<A1, A2, R>) - Static method in interface au.csiro.pathling.utilities.Functions: Converts a function that takes two arguments to its curried version.

D

DEFAULT_SHUTDOWN_HOOK_PRIORITY - Static variable in class au.csiro.pathling.utilities.ObjectHolder.SingletonHolder: The default priority of the shutdown hook.

E

ensureValid(T, String) - Static method in class au.csiro.pathling.validation.ValidationUtils: Ensures that a bean annotated with JSR-380 constraints is valid.
escapeFhirPathString(String) - Static method in class au.csiro.pathling.fhirpath.literal.StringLiteral: On the way back out, we only do the minimal escaping to guarantee syntactical correctness.

F

failValidation(Set<? extends ConstraintViolation<?>>, String) - Static method in class au.csiro.pathling.validation.ValidationUtils: Fails with the ConstraintViolationException that includes the violated constraints and the human-readable representation of them.
formatViolations(Set<? extends ConstraintViolation<?>>) - Static method in class au.csiro.pathling.validation.ValidationUtils: Formats a set of ConstraintViolation to a human-readable string.
Functions - Interface in au.csiro.pathling.utilities: Utility class containing some functional programming helper functions.

G

getBuildVersion() - Method in class au.csiro.pathling.PathlingVersion: Returns the POM version of the application.
getConfiguration() - Method in interface au.csiro.pathling.config.Configurable: Returns the configuration object associated with this instance.
getDescriptiveVersion() - Method in class au.csiro.pathling.PathlingVersion: Returns a descriptive version including the POM version and Git commit SHA.
getMajorVersion() - Method in class au.csiro.pathling.PathlingVersion: Returns the major version component of the POM version.
getName() - Method in interface au.csiro.pathling.sql.udf.SqlFunction: Gets the name of the UDF.
getOrCreate(C) - Method in interface au.csiro.pathling.utilities.ObjectHolder: Retrieves the instance associated with given configuration and if necessary creates ones.
getOrCreate(C) - Method in class au.csiro.pathling.utilities.ObjectHolder.SingletonHolder
getReturnType() - Method in interface au.csiro.pathling.sql.udf.SqlFunction: Gets the return type of the UDF.

I

InvalidUserInputError - Exception Class in au.csiro.pathling.errors: Thrown when invalid user input is detected, and we want to send the details of the problem back to the user.
InvalidUserInputError(String) - Constructor for exception class au.csiro.pathling.errors.InvalidUserInputError: Creates a new InvalidUserInputError with the specified message.
InvalidUserInputError(String, Throwable) - Constructor for exception class au.csiro.pathling.errors.InvalidUserInputError: Creates a new InvalidUserInputError with the specified message and cause.
InvalidUserInputError(Throwable) - Constructor for exception class au.csiro.pathling.errors.InvalidUserInputError: Creates a new InvalidUserInputError with the specified cause.

L

Lists - Class in au.csiro.pathling.utilities: Utility class containing some List helper functions.

M

maybeCast(Class<T>) - Static method in interface au.csiro.pathling.utilities.Functions: Returns function that conditionally casts an object to a given class, returning an empty optional if the cast fails.

O

ObjectHolder<C,V> - Interface in au.csiro.pathling.utilities: Represents a scoped storage for instances of type V that can be created from configuration of type C.
ObjectHolder.SingletonHolder<C,V> - Class in au.csiro.pathling.utilities: A singleton implementation of ObjectHolder that holds a single instance of something.
optionalOf(List<T>) - Static method in class au.csiro.pathling.utilities.Lists: Returns an optional of given list for non-empty list, or empty optional otherwise.

P

parseCsvList(String, Function<String, T>) - Static method in class au.csiro.pathling.utilities.Strings: Leniently parses a list of coma separated values.
PathlingVersion - Class in au.csiro.pathling: Retrieves version information from the properties file created during the build, making it available to other areas of the application.
PathlingVersion() - Constructor for class au.csiro.pathling.PathlingVersion: Default constructor for creating a new PathlingVersion instance.
Preconditions - Class in au.csiro.pathling.utilities: Static convenience methods for checking the validity of inputs.

R

randomAlias() - Static method in class au.csiro.pathling.utilities.Strings: Generates a short random string for use as a column alias.
register(SqlFunction1<?, ?>) - Method in class au.csiro.pathling.sql.udf.AbstractUdfRegistrar.UdfRegistrar: Registers a single-argument SQL function with the Spark session.
register(SqlFunction2<?, ?, ?>) - Method in class au.csiro.pathling.sql.udf.AbstractUdfRegistrar.UdfRegistrar: Registers a two-argument SQL function with the Spark session.
registerResource(T) - Method in class au.csiro.pathling.utilities.ResourceCloser: Adds a resource to the list of resources to close.
registerUdfs(AbstractUdfRegistrar.UdfRegistrar) - Method in class au.csiro.pathling.sql.udf.AbstractUdfRegistrar: Override to perform the actual registration of SqlFunctionXXX instances.
reset() - Method in interface au.csiro.pathling.utilities.ObjectHolder: Destroys all the instances stored the underlying scope.
reset() - Method in class au.csiro.pathling.utilities.ObjectHolder.SingletonHolder
ResourceCloser - Class in au.csiro.pathling.utilities: A Closeable that closes a collection of underlying resources.
ResourceCloser(Closeable...) - Constructor for class au.csiro.pathling.utilities.ResourceCloser: Constructs a new ResourceCloser with provided resources to close.

S

singleton(Function<C, V>) - Static method in interface au.csiro.pathling.utilities.ObjectHolder: Creates the holder allowing a single instance to be created per process.
singleton(Function<C, V>, boolean, int) - Static method in interface au.csiro.pathling.utilities.ObjectHolder: Creates the holder allowing a single instance to be created per process.
SparkConfigurer - Interface in au.csiro.pathling.spark: Common interface for functions/classes that can configure a SparkSession.
SqlFunction - Interface in au.csiro.pathling.sql.udf: The interface that encapsulates meta data required for registration of a custom UDF function in Spark.
SqlFunction1<T1,R> - Interface in au.csiro.pathling.sql.udf: A registrable UDF function with one argument.
SqlFunction2<T1,T2,R> - Interface in au.csiro.pathling.sql.udf: A registrable UDF function with two arguments.
SqlFunction3<T1,T2,T3,R> - Interface in au.csiro.pathling.sql.udf: A registrable UDF function with three arguments.
SqlFunction4<T1,T2,T3,T4,R> - Interface in au.csiro.pathling.sql.udf: A registrable UDF function with three arguments.
SqlFunction5<T1,T2,T3,T4,T5,R> - Interface in au.csiro.pathling.sql.udf: A registrable UDF function with three arguments.
SqlFunctionRegistrar - Class in au.csiro.pathling.sql.udf: A spark configurer that registers user defined functions in the sessions.
SqlFunctionRegistrar(List<SqlFunction1<?, ?>>, List<SqlFunction2<?, ?, ?>>, List<SqlFunction3<?, ?, ?, ?>>, List<SqlFunction4<?, ?, ?, ?, ?>>, List<SqlFunction5<?, ?, ?, ?, ?, ?>>) - Constructor for class au.csiro.pathling.sql.udf.SqlFunctionRegistrar: Creates a new SqlFunctionRegistrar with the specified SQL functions.
streamOf(Iterator<T>) - Static method in class au.csiro.pathling.utilities.Streams: Creates a stream from the iterator.
Streams - Class in au.csiro.pathling.utilities: Utility class containing some stream helper functions.
Streams() - Constructor for class au.csiro.pathling.utilities.Streams
StringLiteral - Class in au.csiro.pathling.fhirpath.literal: Utility class for handling FHIRPath string literal escaping and unescaping.
Strings - Class in au.csiro.pathling.utilities: Utility class containing some methods for string wrangling.

U

UdfRegistrar(SparkSession) - Constructor for class au.csiro.pathling.sql.udf.AbstractUdfRegistrar.UdfRegistrar: Creates a new UDF registrar for the given Spark session.
unescapeFhirPathString(String) - Static method in class au.csiro.pathling.fhirpath.literal.StringLiteral: This method implements the rules for dealing with strings in the FHIRPath specification.
unquoteFhirIdentifier(String) - Static method in class au.csiro.pathling.fhirpath.literal.StringLiteral: Unquotes a FHIRPath quoted identifier, handling both the tick quotes and any escaped characters.
unSingleQuote(String) - Static method in class au.csiro.pathling.utilities.Strings: Removes surrounding single quotes from a string.
UnsupportedFhirPathFeatureError - Exception Class in au.csiro.pathling.errors: Thrown when the request references a FHIRPath feature that is not supported.
UnsupportedFhirPathFeatureError(String) - Constructor for exception class au.csiro.pathling.errors.UnsupportedFhirPathFeatureError: Creates a new UnsupportedFhirPathFeatureError with the specified message.
unTickQuote(String) - Static method in class au.csiro.pathling.utilities.Strings: Removes surrounding tick quotes from a string.
UsedByReflection - Annotation Interface in au.csiro.pathling.annotations: Annotation to indicate that a method is called by name with reflection.

V

validate(T) - Static method in class au.csiro.pathling.validation.ValidationUtils: Validates a bean annotated with JSR-380 constraints using the default validation factory.
ValidationUtils - Class in au.csiro.pathling.validation: Utility classes to facilitate JRS-380 based validation.

W

wrapInUserInputError(Function<T, R>) - Static method in class au.csiro.pathling.utilities.Preconditions: Converts a function which throws a FHIRException to a function that throws an InvalidUserInputError in the same situation.

A B C D E F G I L M O P R S U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form