Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abbreviatedSynopsis() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Generates a generic synopsis like
<command name> [OPTIONS] [PARAM1 [PARAM2]...]
, omitting parts that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options). - abbreviateSynopsis() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Specify
true
to generate an abbreviated synopsis like"<main> [OPTIONS] [PARAMETERS...] [COMMAND]"
. - abbreviateSynopsis() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
- abbreviateSynopsis(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
- AbstractHandler() - Constructor for class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.
- AbstractParseResultHandler() - Constructor for class nz.org.riskscape.picocli.CommandLine.AbstractParseResultHandler
-
Deprecated.
- accept(OutputStream) - Method in interface nz.org.riskscape.engine.resource.CreateHandle.Callback
- accept(Tuple) - Method in interface nz.org.riskscape.engine.pipeline.Sink
-
Pass a tuple to the sink to consume.
- accept(Problem) - Method in interface nz.org.riskscape.problem.ProblemSink
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.BracketedExpression
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.Constant
- accept(ExpressionVisitor<T, R>, T) - Method in interface nz.org.riskscape.rl.ast.Expression
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.FunctionCall
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.Lambda
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.ParameterToken
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.SelectAllExpression
- accept(ExpressionVisitor<T, R>, T) - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- accumulate(Object) - Method in interface nz.org.riskscape.engine.rl.agg.Accumulator
-
Collect state in to this accumulator
- accumulate(T, Tuple) - Method in interface nz.org.riskscape.engine.pipeline.Collector
-
Give a tuple to the accumulator for accumulation.
- accumulate(T, Tuple) - Method in interface nz.org.riskscape.engine.pipeline.StreamingCollector
-
Give a tuple to the accumulator for accumulation.
- Accumulator - Interface in nz.org.riskscape.engine.rl.agg
-
Stores state during row-reduction as part of a
RealizedAggregateExpression
. - action(PrintStream, Runnable, Consumer<Integer>) - Method in class nz.org.riskscape.engine.cli.ExitCode
- add(String, Type) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- add(StepChain) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Return a new
PipelineDeclaration
with the given step chain added to the end of thisPipelineDeclaration
's list of chains - add(String, Resource, ConstructionCallback<T>) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Add a potentially lazily constructed identified object to this collection.
- add(String, Resource, ConstructionCallback<T>) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- add(String, Type) - Method in class nz.org.riskscape.engine.types.Struct
-
Returns this with the extra member added on TODO using some kind of optimized copying immutable map might cut down on garbage collection etc (if guava isn't already doing that)
- add(String, Type) - Method in class nz.org.riskscape.engine.types.Struct.StructBuilder
- add(Bookmark) - Method in interface nz.org.riskscape.engine.Project
-
Convenience for
getBookmarks().add(Bookmark)
- add(IdentifiedFunction) - Method in interface nz.org.riskscape.engine.Project
-
Convenience for
getFunctionSet().add(IdentifiedFunction)
- add(Manifest.OutputInfo) - Method in class nz.org.riskscape.engine.pipeline.Manifest
-
Add
Manifest.OutputInfo
to this manifest. - add(ResourceLoader) - Method in interface nz.org.riskscape.engine.resource.ResourceFactory
- add(CommandLine.Model.ArgSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified option spec or positional parameter spec to the list of configured arguments to expect.
- add(CommandLine.Model.ArgSpec, int) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Adds the specified
OptionSpec
orPositionalParamSpec
to the list of options and parameters that were matched on the command line. - add(PipelineDeclaration) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Return a new
PipelineDeclaration
that is the combination of this pipeline and the other - no merge or squishing or anything clever is going on - add(T) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Add a pre-constructed identified object to the collection.
- add(T) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- add(T, Resource) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- add(T, Resource) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Same as
IdentifiedCollection.add(nz.org.riskscape.engine.Identified)
but with specified source. - AddAggregationFunction - Class in nz.org.riskscape.engine.function.agg
- AddAggregationFunction(RiskscapeFunction, AggregationFunction) - Constructor for class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- addAggregationTo(AggregationFunction, RiskscapeFunction) - Static method in interface nz.org.riskscape.engine.rl.agg.AggregationFunction
- addAll(Collection<T>) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- addAll(Collection<T>) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Add all of the given objects to this collection, returning a list of any that were replaced
- addAll(Collection<T>, Resource) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
- addAll(Collection<T>, Resource) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- addAll(Pipeline) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addAll(Struct) - Method in class nz.org.riskscape.engine.types.Struct.StructBuilder
- addAllSubcommands(Map<String, CommandLine>) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Registers all specified subcommands with this Help.
- addArg(CommandLine.Model.ArgSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Adds the specified argument to the list of options and positional parameters that depend on this group.
- addArgGroup(CommandLine.Model.ArgGroupSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified argument group to the groups in this command.
- addDefaultAncestorRules(TypeRegistry) - Static method in class nz.org.riskscape.engine.types.TypeRegistry
- addDefaults(TypeRegistry) - Static method in class nz.org.riskscape.engine.types.TypeRegistry
- addDefaultVarianceRules(TypeRegistry) - Static method in class nz.org.riskscape.engine.types.TypeRegistry
- addDependency(PluginDescriptor) - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
-
Register a
PluginDescriptor
that is a dependency of thisPluginDescriptor
(according to getPluginDependencies). - addDependent(RealizedStep) - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- addEdge(String, String) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addEdge(String, String, String) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addEdge(String, String, Optional<String>) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addEdge(String, NamedStep) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addEdge(Edge, NamedStep) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addEdge(NamedStep, NamedStep) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addEdge(NamedStep, NamedStep, String) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addEdge(NamedStep, NamedStep, Optional<String>) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Adds an edge with the given parameters to the pipeline.
- addEmptyRow() - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Adds the required
char[]
slots for a new row to theCommandLine.Help.TextTable.columnValues
field. - addEquivalenceRule(EquivalenceRule) - Method in class nz.org.riskscape.engine.types.TypeRegistry
- addError(CommandLine.PicocliException) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
- addExtensionPoint(Class<? extends PluginFeature>) - Method in class nz.org.riskscape.engine.plugin.ExtensionPoints
-
Convenience method for adding an extension point by its feature class
- addFeature(PluginFeature) - Method in class nz.org.riskscape.engine.plugin.ExtensionPoints
-
Add a feature to this set of extension points, returning false if none of the extension points supported this feature.
- addFeature(T) - Method in class nz.org.riskscape.engine.plugin.ExtensionPoint
-
Add a feature to the list
- addFeatureIf(PluginFeature) - Method in class nz.org.riskscape.engine.plugin.ExtensionPoint
-
Add a feature of unknown type to the list
- addFunctions(Project, Consumer<Problem>) - Method in interface nz.org.riskscape.engine.function.FunctionProvider
- addMethodSubcommands() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Specify whether methods annotated with
@Command
should be registered as subcommands of their enclosing@Command
class. - addMethodSubcommands() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Reflects on the class of the user object and registers any command methods (class methods annotated with
@Command
) as subcommands. - addMethodSubcommands(CommandLine.IFactory) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Reflects on the class of the user object and registers any command methods (class methods annotated with
@Command
) as subcommands. - addMetrics(MetricRegistry, String) - Method in class nz.org.riskscape.engine.pipeline.DefaultCollection
- addMixin(String, Object) - Method in class nz.org.riskscape.picocli.CommandLine
-
Adds the options and positional parameters in the specified mixin to this command.
- addMixin(String, CommandLine.Model.CommandSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified mixin
CommandSpec
object to the map of mixins for this command. - addMixin(String, CommandLine.Model.CommandSpec, CommandLine.Model.IAnnotatedElement) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified mixin
CommandSpec
object to the map of mixins for this command. - addOption(CommandLine.Model.OptionSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified option spec to the list of configured arguments to expect.
- addOption(CommandLine.Model.OptionSpec) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Adds the specified
OptionSpec
to the list of options that were matched on the command line. - addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Delegates to the
option renderer
of this layout to obtain text values for the specifiedCommandLine.Model.OptionSpec
, and then calls theCommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][])
method to write these text values into the correct cells in the TextTable. - addOptions(List<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Calls
CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer)
for all non-hidden Options in the list. - addOrReplace(String, Type) - Method in class nz.org.riskscape.engine.types.Struct
- addParameter(String, Object) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Add a parameter value to parameters.
- addParameter(NamedStep, String, Object) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Convenience version of
that will construct the parameterKey to be <step-name>.<paramName></p>
- addParentCommandElement(CommandLine.Model.IAnnotatedElement) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified
{@literal @}ParentCommand
-annotated program element to the list of elements for this command. - addPattern(String, String, String) - Method in class nz.org.riskscape.picocli.CommandLine.RegexTransformer.Builder
-
Adds the specified negative replacement and synopsis replacement for the specified regular expression.
- addPluginResources(Plugin) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Populate the i18n subsystem with plugin resources from the given plugin
- addPositional(CommandLine.Model.PositionalParamSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified positional parameter spec to the list of configured arguments to expect.
- addPositionalParam(CommandLine.Model.PositionalParamSpec, int) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Adds the specified
PositionalParamSpec
to the list of parameters that were matched on the command line. - addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Delegates to the
parameter renderer
of this layout to obtain text values for the specified positional parameter, and then callsCommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][])
to write these text values into the correct cells in the TextTable. - addPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Calls
CommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer)
for all non-hidden Parameters in the list. - addProblemsTo(Collection<Problem>) - Method in class nz.org.riskscape.problem.ResultOrProblems
- addRowValues(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Delegates to
CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text...)
, after ensuring that multi-line values are layed out in the correct row and column. - addRowValues(CommandLine.Help.Ansi.Text...) - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
- addSpecElement(CommandLine.Model.IAnnotatedElement) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified
{@literal @}Spec
-annotated program element to the list of elements for this command. - addStep(String, Step) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addStep(NamedStep) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- addSubcommand(Object) - Method in class nz.org.riskscape.picocli.CommandLine
-
Registers a subcommand with the name obtained from the
@Command(name = "...")
annotation attribute of the specified command. - addSubcommand(String, Object) - Method in class nz.org.riskscape.picocli.CommandLine
-
Registers a subcommand with the specified name.
- addSubcommand(String, Object) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Deprecated.
- addSubcommand(String, Object, String...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Registers a subcommand with the specified name and all specified aliases.
- addSubcommand(String, CommandLine) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified subcommand with the specified name.
- addSubcommand(String, CommandLine.Model.CommandSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified subcommand with the specified name.
- addSubgroup(CommandLine.Model.ArgGroupSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Adds the specified group to the list of subgroups that this group is composed of.
- addToRhsIndex(Tuple, T) - Method in interface nz.org.riskscape.engine.join.LopsidedJoiner
-
Accumulate a rhs value in to the index
- addType(String, Resource, ConstructionCallback<Type>) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- addTypes(Project, Consumer<Problem>) - Method in interface nz.org.riskscape.engine.types.TypeProvider
- addUnmatched(String) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Adds the specified command line argument to the list of unmatched command line arguments.
- addUnmatched(Stack<String>) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Adds all elements of the specified command line arguments stack to the list of unmatched command line arguments.
- addUnmatchedArgsBinding(CommandLine.Model.UnmatchedArgsBinding) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Adds the specified
UnmatchedArgsBinding
to the list of model objects to capture unmatched arguments for this command. - addUnparsed(Map<String, List<?>>) - Method in class nz.org.riskscape.engine.data.Bookmark
- addVarianceRule(VarianceRule) - Method in class nz.org.riskscape.engine.types.TypeRegistry
- adjustLineBreaksForWideCJKCharacters() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.
- adjustLineBreaksForWideCJKCharacters(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
- affecting(Class<?>, String) - Method in class nz.org.riskscape.problem.Problem
-
Copy this Problem but add details of the specific thing that the problem affects.
- affecting(Object) - Method in class nz.org.riskscape.problem.Problem
- Affecting - Annotation Interface in nz.org.riskscape.engine.problem
- Affecting.Target - Enum Class in nz.org.riskscape.engine.problem
- affects(Class<?>) - Method in class nz.org.riskscape.problem.Problem
- aggregateFunctionNotSupportedInExpression(FunctionCall) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
- AggregationFunction - Interface in nz.org.riskscape.engine.rl.agg
-
A
RiskscapeFunction
sub-interface for a function that can be applied across manyTuple
s as part of aRealizedAggregateExpression
. - AggregationFunctionAdapter - Class in nz.org.riskscape.engine.function.agg
-
Adapts an
AggregationFunction
so that it can be called in a standardRealizedExpression
. - AggregationFunctionAdapter(AggregationFunction) - Constructor for class nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter
- aliases() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Alternative command names by which this subcommand is recognized on the command line.
- aliases() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the list of aliases for the command in this Help.
- aliases() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the alias command names of this subcommand.
- aliases(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets the alternative names by which this subcommand is recognized on the command line.
- allowedString() - Method in class nz.org.riskscape.engine.types.WithinSet
- allowInsecure - Variable in class nz.org.riskscape.engine.resource.Resource.Options
- alreadyIncluded(URI) - Method in interface nz.org.riskscape.config.ConfigProblems
-
Config tried to import some other bit of config, but it's already been added
- ALWAYS - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Visibility
- AncestorRule - Interface in nz.org.riskscape.engine.types.ancestor
-
An 'ancestor rule' is used when comparing two types to decide whether they have a common ancestor.
- AncestorType - Class in nz.org.riskscape.engine.types.ancestor
-
The result of computing an ancestor for two types.
- AncestorType(Type, AncestorType.Converter) - Constructor for class nz.org.riskscape.engine.types.ancestor.AncestorType
- AncestorType.Converter - Interface in nz.org.riskscape.engine.types.ancestor
-
Wrapper around
Function
to avoid nasty generics all over the shop - AncestorTypeList - Class in nz.org.riskscape.engine.types.ancestor
-
List version of
AncestorType
- AncestorTypeList(Type, AncestorTypeList.Converter) - Constructor for class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- AncestorTypeList.Converter - Interface in nz.org.riskscape.engine.types.ancestor
- and(String) - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- and(String, Type) - Method in class nz.org.riskscape.engine.types.Struct
-
Synonym of
Struct.add(String, Type)
to support change in builder API - and(String, Type) - Method in class nz.org.riskscape.engine.types.Struct.StructBuilder
-
Deprecated.use add
- and(Struct) - Method in class nz.org.riskscape.engine.types.Struct
-
Synonym of
Struct.add(String, Type)
to support change in builder API - AND - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- andExit(int) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.use
CommandLine.execute(String...)
instead, and callSystem.exit()
in the application. - andThen(SortBy) - Method in class nz.org.riskscape.engine.sort.SortBy
-
Builds a new SortBy clause where asNext is appended to the end of this
SortBy
chain. - anonMember(Expression) - Static method in class nz.org.riskscape.rl.ast.StructDeclaration
- anonymous(List<Type>) - Static method in class nz.org.riskscape.engine.function.ArgumentList
- ANONYMOUS - Static variable in class nz.org.riskscape.pipeline.PipelineMetadata
- ansi() - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.use
CommandLine.AbstractHandler.colorScheme()
instead - ansi() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns whether ANSI escape codes are enabled or not.
- ansi() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns the
Ansi
setting of this color scheme. - ansi() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Returns the
Ansi
setting of this color scheme builder. - ansi(CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Returns the
Ansi
setting of this color scheme builder. - AnsiHelper - Interface in nz.org.riskscape.cli
-
Helper interface that can make your code more succinct when producing Ansi text for display
- AnsiPrintStream - Class in nz.org.riskscape.cli
-
A more convenient print stream API to use for printing things out to the console, supporting ANSI styling if the underlying terminal supports it and fluid use (e.g.
- AnsiPrintStream(Terminal) - Constructor for class nz.org.riskscape.cli.AnsiPrintStream
-
Create a print stream wrapping the given terminal's stdout
- AnsiPrintStream(CommandLine.Help.Ansi, PrintStream) - Constructor for class nz.org.riskscape.cli.AnsiPrintStream
- any(Type...) - Static method in class nz.org.riskscape.engine.types.Nullable
- ANY_REQUIRED - Enum constant in enum class nz.org.riskscape.engine.query.TupleUtils.FindOption
- Anything - Class in nz.org.riskscape.engine.types
-
The simplest type, which offers zero type checking
- Anything() - Constructor for class nz.org.riskscape.engine.types.Anything
- ANYTHING - Static variable in class nz.org.riskscape.engine.types.Nullable
- ANYTHING - Static variable in class nz.org.riskscape.engine.types.Types
- AnythingRule - Class in nz.org.riskscape.engine.types.varule
- AnythingRule() - Constructor for class nz.org.riskscape.engine.types.varule.AnythingRule
- append(String) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Deprecated.use
CommandLine.Help.Ansi.Text.concat(String)
instead - append(List<? extends T>, T) - Static method in class nz.org.riskscape.util.ListUtils
-
Fluid, immutable list appending method that appends an element at the end of a given list, returning a new list
- append(CommandLine.Help.Ansi.Text) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Deprecated.use
CommandLine.Help.Ansi.Text.concat(Text)
instead - append(StepChain) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- append(StepChain) - Method in class nz.org.riskscape.pipeline.ast.StepChain
-
Returns a new StepChain with all the steps from the given chain appended to this chain
- append(StepDeclaration) - Method in class nz.org.riskscape.pipeline.ast.StepChain
-
Returns a new StepChain with the given step appended
- appendSource(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
- appendSource(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- appendSource(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepChain
- appendSource(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- appendSource(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepLink
- appendSource(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepReference
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.BracketedExpression
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.Constant
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.FunctionCall
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.Lambda
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.ParameterToken
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.SelectAllExpression
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- appendSource(StringBuilder) - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- appendString(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
- appendString(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- appendString(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepChain
- appendString(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- appendString(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepLink
- appendString(StringBuilder) - Method in class nz.org.riskscape.pipeline.ast.StepReference
- apply(Object) - Method in interface nz.org.riskscape.engine.types.eqrule.Coercer
- apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Returns a new Text object where all the specified styles are applied to the full length of the specified plain text.
- apply(List<Object>) - Method in interface nz.org.riskscape.engine.function.JavaFunction.Delegate
-
Apply the arguments to produce the result.
- apply(Tuple) - Method in interface nz.org.riskscape.engine.projection.FlatProjector
-
Transform
tuple
in to aTupleIterator
. - applyingDefault(String, Object) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
No '
' value was provided, using default value of ' ' - applyMarkup(String) - Method in interface nz.org.riskscape.cli.AnsiHelper
- applyStyles(String, List<CommandLine.Help.Ansi.IStyle>) - Method in interface nz.org.riskscape.cli.AnsiHelper
- applyStyles(String, CommandLine.Help.Ansi.IStyle...) - Method in interface nz.org.riskscape.cli.AnsiHelper
- applySystemProperties() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Replaces colors and styles in this scheme builder with ones specified in system properties, and returns this builder.
- arg(int) - Method in class nz.org.riskscape.engine.typexp.AST.ComplexType
- argCount() - Method in class nz.org.riskscape.engine.typexp.AST.ComplexType
- argGroups() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the argument groups in this command.
- args() - Method in class nz.org.riskscape.engine.typexp.AST.ComplexType
- args() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the options and positional parameters in this group; may be empty but not
null
. - args() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the list of options and positional parameters that depend on this group.
- args() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the list of all options and positional parameters configured for this command.
- ArgsProblems - Interface in nz.org.riskscape.engine
-
Factory for producing problems that involve arguments - either to a function or a pipeline step.
- Argument(Expression) - Constructor for class nz.org.riskscape.rl.ast.FunctionCall.Argument
- Argument(Expression, String) - Constructor for class nz.org.riskscape.rl.ast.FunctionCall.Argument
- Argument(Expression, Optional<Token>) - Constructor for class nz.org.riskscape.rl.ast.FunctionCall.Argument
- ArgumentList - Class in nz.org.riskscape.engine.function
- ArgumentList(List<FunctionArgument>) - Constructor for class nz.org.riskscape.engine.function.ArgumentList
- arity() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns how many arguments this option or positional parameter requires.
- arity() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns how many arguments this option or positional parameter requires.
- arity() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Specifies the minimum number of required parameters and the maximum number of accepted parameters.
- arity() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Specifies the minimum number of required parameters and the maximum number of accepted parameters.
- arity(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets how many arguments this option or positional parameter requires, and returns this builder.
- arity(CommandLine.Range) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets how many arguments this option or positional parameter requires, and returns this builder.
- aritySatisfiedByAttachedOptionParam() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.
- aritySatisfiedByAttachedOptionParam(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.
- AS_STRUCT - Static variable in class nz.org.riskscape.engine.types.EmptyList
- asBuiltin(String, IdentifiedFunction.Category) - Static method in class nz.org.riskscape.engine.function.JavaFunction
- ASC - Enum constant in enum class nz.org.riskscape.engine.sort.SortBy.Direction
- asCommandLineList() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns this
ParseResult
as a list ofCommandLine
objects, one for each matched command/subcommand. - asFunction(AggregationFunction) - Static method in interface nz.org.riskscape.engine.rl.agg.AggregationFunction
- asFunction(RealizableFunction, ArgumentList, Type) - Static method in interface nz.org.riskscape.engine.rl.RealizableFunction
-
Wrap a
RealizableFunction
in aRiskscapeFunction
. - asRelation() - Method in interface nz.org.riskscape.engine.coverage.TypedCoverage
-
Returns a tabular view of this data, or empty if it isn't possible.
- asStruct() - Method in class nz.org.riskscape.engine.types.CoverageType
- asStruct() - Method in class nz.org.riskscape.engine.types.EmptyList
- asStruct() - Method in class nz.org.riskscape.engine.types.Enumeration
- asStruct() - Method in class nz.org.riskscape.engine.types.FunctionType
- asStruct() - Method in class nz.org.riskscape.engine.types.LambdaType
- asStruct() - Method in class nz.org.riskscape.engine.types.LookupTableType
- asStruct() - Method in class nz.org.riskscape.engine.types.Nullable
- asStruct() - Method in class nz.org.riskscape.engine.types.RelationType
- asStruct() - Method in class nz.org.riskscape.engine.types.RSList
- asStruct() - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- asStruct() - Method in class nz.org.riskscape.engine.types.SimpleType
- asStruct() - Method in class nz.org.riskscape.engine.types.Struct
- asStruct() - Method in interface nz.org.riskscape.engine.types.Type
- asStruct() - Method in interface nz.org.riskscape.engine.types.WrappingType
- asStruct(RealizationContext, RealizedExpression) - Method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
- AST - Class in nz.org.riskscape.engine.typexp
-
AST base type plus subtypes for type expressions
- AST(Token) - Constructor for class nz.org.riskscape.engine.typexp.AST
- AST.ComplexType - Class in nz.org.riskscape.engine.typexp
-
A type that needs arguments given to it to be created, like a struct has an identier and an argument list.
- AST.Constant - Class in nz.org.riskscape.engine.typexp
-
A constant, literal value, like a piece of text or a number
- AST.Dictionary - Class in nz.org.riskscape.engine.typexp
-
A map like structure where keys are symbols and the values are types or constants
- AST.Symbol - Class in nz.org.riskscape.engine.typexp
-
A symbol is like an identifier - a string without quotes, a standalone token.
- AST.ValueList - Class in nz.org.riskscape.engine.typexp
-
Wraps a list of nodes so that it conforms to the AST interface
- atFileCommentChar() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- atFileCommentChar(Character) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- atomicType(Type, T) - Method in interface nz.org.riskscape.engine.types.TypeVisitor
-
Visit an atomic type - there is no further recursion possible here
- AUTO - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Only emit ANSI escape codes if the platform supports it and system property
"picocli.ansi"
is not set to any value other than"true"
(case insensitive). - AutoClosingException - Exception in nz.org.riskscape.engine.pipeline
- AutoClosingException(RealizedPipeline, List<Exception>) - Constructor for exception nz.org.riskscape.engine.pipeline.AutoClosingException
- autoProjectionNotFound(double, double) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When no auto projection could be found.
- autoWidth() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
- autoWidth(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
- auxiliaryTypes() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns auxiliary type information used when the
CommandLine.Model.ArgSpec.type()
is a genericCollection
,Map
or an abstract class. - auxiliaryTypes() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns auxiliary type information used when the
CommandLine.Model.ArgSpec.Builder.type()
is a genericCollection
,Map
or an abstract class. - auxiliaryTypes(Class<?>...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets auxiliary type information, and returns this builder.
B
- backslashesNotAllowedInUris(String) - Method in interface nz.org.riskscape.engine.FileProblems
-
An error when a uri value is specified and backslashes are found that can't be soundly converted to forward slashes
- badArity(Class<?>, Object, Range<Integer>, int) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
- badListLength(String, int) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
A list was provided, but it was expected to contain a certain number of elements
- badResource(Class<?>, URI) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
- badUri(String, String) - Method in interface nz.org.riskscape.engine.FileProblems
-
An otherwise bad URI, typically because URI.create threw a URISyntaxException
- badValue(Object, Object, Object) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
"Value '<value-provided>' for <named-thing> is invalid, it must be <some-constraint>" E.g.
- badWkt(String) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
The Well-Known Text format supplied by the user appears to be invalid.
- Base() - Constructor for class nz.org.riskscape.engine.IdentifiedCollection.Base
- Base(Class<T>) - Constructor for class nz.org.riskscape.engine.IdentifiedCollection.Base
- Base(Function<Geometry, Geometry>) - Constructor for class nz.org.riskscape.engine.geo.GeometryFixer.Base
- BaseExpressionConverter<T> - Class in nz.org.riskscape.rl.ast
-
A abstract
ExpressionVisitor
for converting expressions in a narrowly defined way. - BaseExpressionConverter() - Constructor for class nz.org.riskscape.rl.ast.BaseExpressionConverter
- BaseModel2 - Class in nz.org.riskscape.engine.model
-
The base Model2 implementation.
- BaseModel2(ModelFramework, BoundParameters, BoundParameters, List<? extends ModelParameter>) - Constructor for class nz.org.riskscape.engine.model.BaseModel2
- BaseResource - Class in nz.org.riskscape.engine.resource
-
Base class for
Resource
s. - BaseResource(URI) - Constructor for class nz.org.riskscape.engine.resource.BaseResource
- begin - Variable in class nz.org.riskscape.dsl.Token
- bfs(Type, T, BiConsumer<T, Type>) - Static method in interface nz.org.riskscape.engine.types.TypeVisitor
-
Convenience function for doing a breadth first search of a type, passing the given visit data to each seen type.
- bg(String) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
-
Parses the specified style markup and returns the associated style.
- bg_black - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bg_blue - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bg_cyan - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bg_green - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bg_magenta - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bg_red - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bg_white - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bg_yellow - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- BinaryFunction<T,
U> - Class in nz.org.riskscape.engine.function - BinaryFunction(Class<T>, Class<U>, Type, BiFunction<T, U, Object>) - Constructor for class nz.org.riskscape.engine.function.BinaryFunction
- BinaryFunction(FunctionArgument, FunctionArgument, Type, BiFunction<T, U, Object>) - Constructor for class nz.org.riskscape.engine.function.BinaryFunction
- BinaryFunction(Type, Type, Type, BiFunction<T, U, Object>) - Constructor for class nz.org.riskscape.engine.function.BinaryFunction
- BinaryOperation - Class in nz.org.riskscape.rl.ast
- BinaryOperation(Expression, Token, Expression) - Constructor for class nz.org.riskscape.rl.ast.BinaryOperation
- BinaryOperatorFunction<T> - Class in nz.org.riskscape.engine.function
-
Convenience
RiskscapeFunction
for adding metadata to a javaBinaryOperator
function, specifically meant for a riskscape languageBinaryOperation
- BinaryOperatorFunction(TokenTypes, BinaryOperator<T>, Class<T>) - Constructor for class nz.org.riskscape.engine.function.BinaryOperatorFunction
- BinaryOperatorFunction(TokenTypes, BinaryOperator<T>, Class<T>, Type) - Constructor for class nz.org.riskscape.engine.function.BinaryOperatorFunction
- BinaryPredicateFunction<T,
U> - Class in nz.org.riskscape.engine.function -
Convenience for adding
RiskscapeFunction
metadata to a javaBiPredicate
function - BinaryPredicateFunction(TokenTypes, Class<T>, Type, Class<U>, Type, BiPredicate<T, U>) - Constructor for class nz.org.riskscape.engine.function.BinaryPredicateFunction
- bind(Object, Class<T>) - Method in interface nz.org.riskscape.engine.bind.BindingContext
-
Bind a non-null value to a specific type, returning the bound value, or a failed result containing details why it didn't work.
- bind(Object, Parameter) - Method in interface nz.org.riskscape.engine.bind.BindingContext
-
Untyped version of bind that uses the parameter's type and wraps any problems with parameter context
- bind(BindingContext, Map<String, List<?>>) - Method in class nz.org.riskscape.engine.bind.ParameterSet
-
Attempt to bind the given raw, unbound, parameter values to a
BoundParameters
object. - bind(BindingContext, Parameter, String) - Method in interface nz.org.riskscape.engine.bind.ParameterBinder
-
Deprecated.use
ParameterBinder.bindValue(BindingContext, Object, Class)
instead. Older code can use the CompatBinder to as a simple way of avoiding the deprecation warning and conforming to the new API - bind(Parameter, String) - Method in interface nz.org.riskscape.engine.bind.BindingContext
-
Deprecated.use
BindingContext.bind(Object, Class)
instead - bindAll(List<?>, Class<T>) - Method in interface nz.org.riskscape.engine.bind.BindingContext
- bindAll(List<?>, Parameter) - Method in interface nz.org.riskscape.engine.bind.BindingContext
-
Untyped version of bindAll that uses the parameter's type and wraps any problems with parameter context
- BindingContext - Interface in nz.org.riskscape.engine.bind
-
Minimal interface for a class that can bind strings to objects according to
Parameter
s - bindValue(BindingContext, Object, Class<T>) - Method in interface nz.org.riskscape.engine.bind.ParameterBinder
-
Convert a value in to an object of a desired type.
- blink - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- bold - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- Bookmark - Class in nz.org.riskscape.engine.data
-
Bookmarks point to some resource to be used for risk modeling.
- Bookmark(String, String, String, URI, boolean) - Constructor for class nz.org.riskscape.engine.data.Bookmark
- Bookmark(String, String, String, URI, Map<String, List<String>>) - Constructor for class nz.org.riskscape.engine.data.Bookmark
- Bookmark.BookmarkBuilder - Class in nz.org.riskscape.engine.data
- BookmarkProblems - Interface in nz.org.riskscape.engine.data
- BookmarkResolver - Interface in nz.org.riskscape.engine.data
-
A
BookmarkResolver
can access the data that is being pointed to by aBookmark
. - BookmarkResolvers - Interface in nz.org.riskscape.engine.data
- Bookmarks - Interface in nz.org.riskscape.engine.data
- Bool - Class in nz.org.riskscape.engine.types
- Bool() - Constructor for class nz.org.riskscape.engine.types.Bool
- BOOLEAN - Static variable in class nz.org.riskscape.engine.types.Nullable
- BOOLEAN - Static variable in class nz.org.riskscape.engine.types.Types
- bootstrap(Engine.Writeable) - Method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- bootstrap(ExtensionPoints, Engine.Writeable) - Static method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- BoundParameters - Class in nz.org.riskscape.engine.bind
-
A set of parameter values that have been bound from a particular
ParameterSet
. - BoundParameters(ParameterSet, BindingContext, Map<String, List<?>>, Map<String, List<?>>, List<Problem>) - Constructor for class nz.org.riskscape.engine.bind.BoundParameters
- BracketedExpression - Class in nz.org.riskscape.rl.ast
- BracketedExpression(Expression, Optional<Pair<Token, Token>>) - Constructor for class nz.org.riskscape.rl.ast.BracketedExpression
- broaden(Function<StepDefinition, String>) - Static method in interface nz.org.riskscape.pipeline.StepNamingPolicy
- build() - Method in class nz.org.riskscape.engine.data.Bookmark.BookmarkBuilder
- build() - Method in class nz.org.riskscape.engine.types.Struct
-
Deprecated.
- build() - Method in class nz.org.riskscape.engine.types.Struct.StructBuilder
-
Finish defining a struct
- build() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Creates and returns a new
ColorScheme
with the values configured on this builder. - build() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns a valid
ArgGroupSpec
instance. - build() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns a valid
OptionSpec
instance. - build() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns a valid
PositionalParamSpec
instance. - build() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Creates and returns a new
ParseResult
instance for this builder's configuration. - build() - Method in class nz.org.riskscape.picocli.CommandLine.RegexTransformer.Builder
- build(String) - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
-
Construct a Riskscape
Type
from a type-expression. - build(String, Project, BoundParameters) - Method in interface nz.org.riskscape.engine.function.FunctionFramework
-
Builds a function from an INI file section.
- build(RealizedPipeline) - Static method in class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- build(Project, BoundParameters) - Method in interface nz.org.riskscape.engine.model.ModelFramework
-
Constructs a new model based on the given parameters.
- build(Type) - Method in interface nz.org.riskscape.engine.io.TypeIOBuilder
- build(Type, TypeIOBuilder) - Method in interface nz.org.riskscape.engine.io.TypeIOConstructor
- build(Type, TypeIOBuilder) - Method in class nz.org.riskscape.engine.types.SimpleType
- build(Type, Type, Function<Object, Object>) - Static method in interface nz.org.riskscape.engine.types.eqrule.Coercer
- buildCallingScopeType(Type...) - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
-
Builds a scope that includes the lambda args (based on the actual types that the lambda expression is realized with), and returns the scope type.
- buildComplexType(AST.ComplexType) - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
-
Construct a type from a complex type expression - e.g.
- builder() - Static method in class nz.org.riskscape.engine.data.Bookmark
- builder() - Static method in class nz.org.riskscape.engine.types.Struct
- builder() - Static method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns a new
CommandLine.Model.ArgGroupSpec.Builder
. - builder() - Static method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
- builder(String[]) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- builder(String, String...) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- builder(CommandLine.Model.CommandSpec) - Static method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Creates and returns a new
ParseResult.Builder
for the specified command spec. - builder(CommandLine.Model.IAnnotatedElement) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns a new
CommandLine.Model.ArgGroupSpec.Builder
associated with the specified annotated element. - builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
- builder(CommandLine.Model.OptionSpec) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns a Builder initialized from the specified
OptionSpec
. - builder(CommandLine.Model.PositionalParamSpec) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
-
Returns a Builder initialized from the specified
PositionalSpec
. - Builder() - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Constructs an empty color scheme builder with Ansi.AUTO.
- Builder() - Constructor for class nz.org.riskscape.picocli.CommandLine.RegexTransformer.Builder
-
Constructs an empty builder.
- Builder(CommandLine.Help.Ansi) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Constructs an empty color scheme builder with the specified Ansi value.
- Builder(CommandLine.Help.ColorScheme) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Constructs a color scheme builder with all attributes copied from the specified color scheme.
- Builder(CommandLine.RegexTransformer) - Constructor for class nz.org.riskscape.picocli.CommandLine.RegexTransformer.Builder
-
Constructs a builder populated with the values from the specified RegexTransformer.
- BuildInfo - Class in nz.org.riskscape.engine
-
Data holder for things that come from build.properties
- BuildInfo(String, String, Date) - Constructor for class nz.org.riskscape.engine.BuildInfo
- BuildInfo(Properties) - Constructor for class nz.org.riskscape.engine.BuildInfo
- buildOr() - Method in class nz.org.riskscape.engine.types.Struct.StructBuilder
-
Variation of build that returns a ResultOrProblems that can be used in user error reporting, rather than throwing an exception (on key duplicates)
- buildProject(URI, Consumer<Problem>) - Method in interface nz.org.riskscape.engine.Engine
-
Construct a project from resources at the given location.
- buildSimpleType(AST.Symbol) - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
-
Construct a type from a symbol.
- BUILT_IN - Static variable in interface nz.org.riskscape.engine.function.RiskscapeFunction
- builtin(String, IdentifiedFunction.Category) - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
C
- cachedGeometryFactories - Variable in class nz.org.riskscape.engine.SRIDSet
- cachedTransforms - Variable in class nz.org.riskscape.engine.SRIDSet
- calculateBounds() - Method in interface nz.org.riskscape.engine.relation.Relation
- call() - Method in interface nz.org.riskscape.problem.ProblemException.Call
- call(C, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(C, PrintStream, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(C, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(C, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(Class<C>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(Class<C>, CommandLine.IFactory, PrintStream, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(Class<C>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(Class<C>, CommandLine.IFactory, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - call(List<Object>) - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.BinaryFunction
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.BinaryOperatorFunction
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.ConstantFunction
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.JavaFunction
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.NullSafeFunction
- call(List<Object>) - Method in class nz.org.riskscape.engine.function.UnaryFunction
- call(List<Object>) - Method in interface nz.org.riskscape.engine.function.UntypedFunction
-
Execute the function with the given arguments.
- call(List<Object>) - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- calling(JavaFunction.Delegate) - Method in class nz.org.riskscape.engine.function.JavaFunction
- canAccept() - Method in interface nz.org.riskscape.engine.pipeline.Sink
-
If this sink is a bounded sink, then this method should return a best guess at whether accept will return true.
- canBind(Class<?>, Class<?>) - Method in interface nz.org.riskscape.engine.bind.ParameterBinder
- canBuild(Project, Map<String, List<?>>) - Method in interface nz.org.riskscape.engine.function.FunctionFramework
- canEqual(Object) - Method in class nz.org.riskscape.dsl.ConditionalParse
- canEqual(Object) - Method in class nz.org.riskscape.dsl.Token
- canEqual(Object) - Method in class nz.org.riskscape.dsl.Token.Location
- canEqual(Object) - Method in class nz.org.riskscape.engine.bind.BoundParameters
- canEqual(Object) - Method in class nz.org.riskscape.engine.bind.Parameter
- canEqual(Object) - Method in class nz.org.riskscape.engine.bind.ParameterSet
- canEqual(Object) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- canEqual(Object) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate.Choice
- canEqual(Object) - Method in class nz.org.riskscape.engine.BuildInfo
- canEqual(Object) - Method in class nz.org.riskscape.engine.data.Bookmark
- canEqual(Object) - Method in class nz.org.riskscape.engine.function.FunctionArgument
- canEqual(Object) - Method in class nz.org.riskscape.engine.i18n.HasMessages
- canEqual(Object) - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
- canEqual(Object) - Method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
- canEqual(Object) - Method in class nz.org.riskscape.engine.i18n.TranslationContext
- canEqual(Object) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- canEqual(Object) - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
- canEqual(Object) - Method in class nz.org.riskscape.engine.output.SinkParameters
- canEqual(Object) - Method in class nz.org.riskscape.engine.pipeline.Edge
- canEqual(Object) - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
- canEqual(Object) - Method in class nz.org.riskscape.engine.pipeline.ExecutionResult
- canEqual(Object) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- canEqual(Object) - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- canEqual(Object) - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- canEqual(Object) - Method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
- canEqual(Object) - Method in class nz.org.riskscape.engine.resource.CreateHandle
- canEqual(Object) - Method in class nz.org.riskscape.engine.resource.CreateRequest
- canEqual(Object) - Method in class nz.org.riskscape.engine.resource.Resource.Options
- canEqual(Object) - Method in class nz.org.riskscape.engine.resource.Resource.PseudoResource
- canEqual(Object) - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- canEqual(Object) - Method in class nz.org.riskscape.engine.sort.SortBy
- canEqual(Object) - Method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- canEqual(Object) - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
- canEqual(Object) - Method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- canEqual(Object) - Method in class nz.org.riskscape.engine.types.LookupTableType
- canEqual(Object) - Method in class nz.org.riskscape.engine.types.Referenced
- canEqual(Object) - Method in class nz.org.riskscape.engine.types.Value
- canEqual(Object) - Method in class nz.org.riskscape.engine.types.WithMetadata
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.ast.StepChain
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.ast.StepLink
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.ast.StepReference
- canEqual(Object) - Method in class nz.org.riskscape.pipeline.PipelineMetadata
- canEqual(Object) - Method in class nz.org.riskscape.problem.Problem
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.BracketedExpression
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.Constant
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.FunctionCall
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.Lambda
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.ParameterToken
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.SelectAllExpression
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- canEqual(Object) - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- canLoad(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceLoader
-
Tests if this
ResourceLoader
is able to load the target resource. - cannotBeNull(Object, Type, Type) - Method in interface nz.org.riskscape.engine.types.TypeProblems
-
Variant of
specific for nullability issues.</p>
- cannotParse(Object, String) - Static method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
General purpose error for invalid expressions that cannot be parsed.
- cannotRealize(Class<?>) - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
- cannotRealize(NamedStep) - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
-
Assigned to the result of
as the parent problem
. - canNotReplaceMember(String, StructDeclaration.Member, StructDeclaration.Member) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
- cannotReproject(Geometry, CoordinateReferenceSystem, CoordinateReferenceSystem) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When a
Geometry
cannot be re-projected from the sourceCoordinateReferenceSystem
to the target. - cannotWriteManifest(PipelineOutputStore, URI) - Method in interface nz.org.riskscape.engine.OutputProblems
-
A parent problem to use when the manifest cannot be written.
- CanonicalType - Class in nz.org.riskscape.engine.typeset
-
Uniquely represents a particular type within a
TypeSet
by an id. - CanonicalType(String, Type) - Constructor for class nz.org.riskscape.engine.typeset.CanonicalType
- canRender(Object) - Method in interface nz.org.riskscape.engine.i18n.ObjectRenderer
- CANT_PARSE - Enum constant in enum class nz.org.riskscape.problem.StandardCodes
- cantWriteTo(Path) - Method in interface nz.org.riskscape.engine.FileProblems
-
Produces an error like: Could not write to
- CARTESIAN - Static variable in interface nz.org.riskscape.engine.join.JoinCondition
- caseInsensitiveEnumValuesAllowed() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- caseInsensitiveEnumValuesAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- catching(List<Problem>, ProblemException.Call<T>) - Static method in exception nz.org.riskscape.problem.ProblemException
- catching(ProblemException.Call<T>) - Static method in exception nz.org.riskscape.problem.ProblemException
- caught(Throwable) - Static method in class nz.org.riskscape.problem.Problems
- CAUGHT_EXCEPTION - Enum constant in enum class nz.org.riskscape.problem.StandardCodes
- Cell(int, int) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.TextTable.Cell
-
Constructs a new Cell with the specified coordinates in the table.
- cellAt(int, int) - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Deprecated.use
CommandLine.Help.TextTable.textAt(int, int)
instead - CHAIN - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- CHAIN_TOKEN - Static variable in class nz.org.riskscape.pipeline.ast.StepChain
-
A handy constant for building AST in code (instead of parsing it)
- checkConsoleCompatibility() - Static method in class nz.org.riskscape.engine.OsUtils
-
Checks the current console for any compatibility problems that might cause the user headaches when running RiskScape.
- checkFeatureClass(Class<U>) - Method in class nz.org.riskscape.engine.plugin.ExtensionPoint
- checkForNull(Object) - Method in interface nz.org.riskscape.engine.types.Type
- checkForParameters(Expression) - Method in class nz.org.riskscape.rl.ExpressionParser
- checksum - Variable in class nz.org.riskscape.engine.pipeline.Manifest.OutputInfo
- checksum(MessageDigest) - Static method in class nz.org.riskscape.engine.pipeline.Manifest
-
Produces a checksum from the
MessageDigest
as aString
. - checksumNotSupported(PipelineOutputStore) - Method in interface nz.org.riskscape.engine.OutputProblems
-
When the user has asked for checksumming of results but the output store does not support this.
- checkValid(Function<StepDeclaration, String>) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Check that this
PipelineDeclaration
is valid. - ChildCommand - Interface in nz.org.riskscape.engine.cli
-
Runnable-esque interface for commands that want to be executed
- children - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem
-
A list of RenderedProblems for each child in source
- children(Type) - Static method in interface nz.org.riskscape.engine.types.TypeVisitor
-
Handy list constructor for a single child type with no metadata
- children(Type, Object) - Static method in interface nz.org.riskscape.engine.types.TypeVisitor
-
Handy list constructor for a single child type with metadata
- children(Type, Object, Type, Object) - Static method in interface nz.org.riskscape.engine.types.TypeVisitor
-
Handy list constructor for two child types with metadata
- children(Type, Type) - Static method in interface nz.org.riskscape.engine.types.TypeVisitor
-
Handy list constructor for two child types with no metadata
- Choice(Object, Optional<String>) - Constructor for class nz.org.riskscape.engine.bind.ParameterTemplate.Choice
- CLASS - Enum constant in enum class nz.org.riskscape.engine.problem.Affecting.Target
- clear() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- clear() - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Remove everything from the collection
- clear() - Method in class nz.org.riskscape.engine.SRIDSet
-
Clear all cached state from this SRIDSet See https://gitlab.catalyst.net.nz/riskscape/riskscape/-/issues/389 for some background
- clearExecutionResults() - Method in class nz.org.riskscape.picocli.CommandLine
-
Clears the execution result of a previous invocation from this
CommandLine
and all subcommands. - CliCommand<T> - Class in nz.org.riskscape.engine.spi
-
Marker interface for pluggable top level picocli command
- CliCommand(Class<T>) - Constructor for class nz.org.riskscape.engine.spi.CliCommand
- clone() - Method in class nz.org.riskscape.engine.data.Bookmark
- clone() - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
- clone() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- clone() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- clone() - Method in class nz.org.riskscape.engine.Tuple
-
Perform a tuple-aware clone of this tuple, performing a shallow copy of the entry array, unless the entry is itself a tuple, which will be recursively cloned
- clone() - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- clone() - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
- clone(Consumer<Parameter.MutableFields>) - Method in class nz.org.riskscape.engine.bind.Parameter
- cloneWithExpression(Expression) - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- close() - Method in interface nz.org.riskscape.engine.cli.EngineCommand
-
Closes the engine
- close() - Method in interface nz.org.riskscape.engine.Engine
-
Closes the engine and removes any temporary resources that it has created.
- close() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- close() - Method in class nz.org.riskscape.engine.function.NullSafeFunction
- close() - Method in interface nz.org.riskscape.engine.function.UntypedFunction
-
Clean up any resources that were allocated with this function.
- close() - Method in interface nz.org.riskscape.engine.output.PipelineOutputContainer
-
Finish writing to the output container.
- close() - Method in class nz.org.riskscape.engine.pipeline.ExecutablePipeline
- close() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
-
Closes the execution context and removes any temporary resources created within it.
- close() - Method in interface nz.org.riskscape.engine.pipeline.Realized
-
Clean up any resources allocated to this
Realized
thing. - close() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- close() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- close() - Method in interface nz.org.riskscape.engine.relation.TupleIterator
- close() - Method in class nz.org.riskscape.engine.restriction.DefaultRestrictor
- close() - Method in interface nz.org.riskscape.engine.rl.RealizedExpression
-
Destroy/release/abandon any resources associated with this expression.
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Anything
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Bool
- coerce(Object) - Method in class nz.org.riskscape.engine.types.CoverageType
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Date
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Decimal
- coerce(Object) - Method in class nz.org.riskscape.engine.types.EmptyList
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Enumeration
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Floating
- coerce(Object) - Method in class nz.org.riskscape.engine.types.FunctionType
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Geom
- coerce(Object) - Method in class nz.org.riskscape.engine.types.GeomType
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Integer
- coerce(Object) - Method in class nz.org.riskscape.engine.types.LambdaType
- coerce(Object) - Method in class nz.org.riskscape.engine.types.LookupTableType
- coerce(Object) - Method in class nz.org.riskscape.engine.types.MultiGeom
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Nothing
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Nullable
- coerce(Object) - Method in class nz.org.riskscape.engine.types.OfUnit
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Referenced
- coerce(Object) - Method in class nz.org.riskscape.engine.types.RelationType
- coerce(Object) - Method in class nz.org.riskscape.engine.types.RSList
- coerce(Object) - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Struct
- coerce(Object) - Method in class nz.org.riskscape.engine.types.Text
-
Convert the given value in to a string
- coerce(Object) - Method in interface nz.org.riskscape.engine.types.Type
-
Attempt to convert the given value in to one represented by this type.
- coerce(Object) - Method in class nz.org.riskscape.engine.types.WithinRange
- coerce(Object) - Method in class nz.org.riskscape.engine.types.WithinSet
- coerce(Object) - Method in class nz.org.riskscape.engine.types.WithMetadata
- coerce(Object) - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- coerce(Struct, Map<?, ?>) - Static method in class nz.org.riskscape.engine.Tuple
- coerce(Struct, Map<?, ?>, EnumSet<Tuple.CoerceOptions>) - Static method in class nz.org.riskscape.engine.Tuple
-
Build a tuple from the given map, applying the type's coercion to the result.
- Coercer - Interface in nz.org.riskscape.engine.types.eqrule
-
A function for transforming a value from one RiskScape type to another
- CoercionException - Exception in nz.org.riskscape.engine.types
- CoercionException(Object, Type) - Constructor for exception nz.org.riskscape.engine.types.CoercionException
- CoercionException(Object, Type, String, Object...) - Constructor for exception nz.org.riskscape.engine.types.CoercionException
- CoercionException(Object, Type, Throwable, String, Object...) - Constructor for exception nz.org.riskscape.engine.types.CoercionException
- collect(Collector<? super Tuple, A, R>) - Method in interface nz.org.riskscape.engine.relation.TupleIterator
-
Collect all values from this tuple iterator in to the given
Collector
, and ensures the iterator is closed. - collect(TupleIterator) - Method in class nz.org.riskscape.engine.pipeline.DefaultCollection
- collectErrors() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Returns true if exceptions during parsing should be collected instead of thrown.
- collectErrors(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Sets whether exceptions during parsing should be collected instead of thrown.
- Collector<T> - Interface in nz.org.riskscape.engine.pipeline
-
Realized interface for a functor that can arbitrarily transform one set of tuples in to another.
- Collector.Characteristic - Enum Class in nz.org.riskscape.engine.pipeline
-
A set of characteristics a collector can have which allow the
PipelineExecutor
to better optimise and organize execution. - COLON - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- colorScheme - Variable in class nz.org.riskscape.picocli.CommandLine.Help.Layout
- colorScheme() - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Returns the ColorScheme to use.
- colorScheme() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the
ColorScheme
model that this Help was constructed with. - column - Variable in class nz.org.riskscape.picocli.CommandLine.Help.TextTable.Cell
-
Table column index (zero based).
- Column(int, int, CommandLine.Help.Column.Overflow) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.Column
- columns() - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
The column definitions of this table.
- columnValues - Variable in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
The
char[]
slots of theTextTable
to copy text values into. - combine(Accumulator) - Method in interface nz.org.riskscape.engine.rl.agg.Accumulator
-
Combine two accumulators in to one that records the state from both in a manner that gives the same result as if each was reduced against a single
Accumulator
. - combine(T, T) - Method in interface nz.org.riskscape.engine.pipeline.Collector
-
Combine two accumulators, returning an accumulator that contains the accumulated state of both.
- combine(T, T) - Method in interface nz.org.riskscape.engine.pipeline.StreamingCollector
-
Combine two accumulators, returning an accumulator that contains the accumulated state of both.
- COMMA - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- command() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the command this option or positional parameter belongs to.
- commandLine() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the CommandLine constructed with this
CommandSpec
model. - commandLine(CommandLine) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets the CommandLine constructed with this
CommandSpec
model. - CommandLine - Class in nz.org.riskscape.picocli
- CommandLine(Object) - Constructor for class nz.org.riskscape.picocli.CommandLine
-
Constructs a new
CommandLine
interpreter with the specified object (which may be an annotated user object or aCommandSpec
) and a default factory. - CommandLine(Object, CommandLine.IFactory) - Constructor for class nz.org.riskscape.picocli.CommandLine
-
Constructs a new
CommandLine
interpreter with the specified object (which may be an annotated user object or aCommandSpec
) and object factory. - CommandLine.AbstractHandler<R,
T extends CommandLine.AbstractHandler<R, T>> - Class in nz.org.riskscape.picocli -
Deprecated.
- CommandLine.AbstractParseResultHandler<R> - Class in nz.org.riskscape.picocli
- CommandLine.ArgGroup - Annotation Interface in nz.org.riskscape.picocli
-
A
Command
may define one or moreArgGroups
: a group of options, positional parameters or a mixture of the two. - CommandLine.Command - Annotation Interface in nz.org.riskscape.picocli
- CommandLine.DefaultExceptionHandler<R> - Class in nz.org.riskscape.picocli
- CommandLine.DuplicateNameException - Exception in nz.org.riskscape.picocli
-
Exception indicating that multiple named elements have incorrectly used the same name.
- CommandLine.DuplicateOptionAnnotationsException - Exception in nz.org.riskscape.picocli
-
Exception indicating that multiple fields have been annotated with the same Option name.
- CommandLine.ExecutionException - Exception in nz.org.riskscape.picocli
-
Exception indicating a problem while invoking a command or subcommand.
- CommandLine.ExitCode - Class in nz.org.riskscape.picocli
-
Defines some exit codes used by picocli as default return values from the
execute
andexecuteHelpRequest
methods. - CommandLine.Help - Class in nz.org.riskscape.picocli
-
A collection of methods and inner classes that provide fine-grained control over the contents and layout of the usage help message to display to end users when help is requested or invalid input values were specified.
- CommandLine.Help.Ansi - Enum Class in nz.org.riskscape.picocli
-
Provides methods and inner classes to support using ANSI escape codes in usage help messages.
- CommandLine.Help.Ansi.IStyle - Interface in nz.org.riskscape.picocli
-
Defines the interface for an ANSI escape sequence.
- CommandLine.Help.Ansi.Style - Enum Class in nz.org.riskscape.picocli
-
A set of pre-defined ANSI escape code styles and colors, and a set of convenience methods for parsing text with embedded markup style names, as well as convenience methods for converting styles to strings with embedded escape codes.
- CommandLine.Help.Ansi.Text - Class in nz.org.riskscape.picocli
-
Encapsulates rich text with styles and colors.
- CommandLine.Help.ColorScheme - Class in nz.org.riskscape.picocli
-
All usage help message are generated with a color scheme that assigns certain styles and colors to common parts of a usage message: the command name, options, positional parameters and option parameters.
- CommandLine.Help.ColorScheme.Builder - Class in nz.org.riskscape.picocli
-
Builder class to create
ColorScheme
instances. - CommandLine.Help.Column - Class in nz.org.riskscape.picocli
- CommandLine.Help.Column.Overflow - Enum Class in nz.org.riskscape.picocli
-
Policy for handling text that is longer than the column width: span multiple columns, wrap to the next row, or simply truncate the portion that doesn't fit.
- CommandLine.Help.IOptionRenderer - Interface in nz.org.riskscape.picocli
-
When customizing online help for
Option
details, a customIOptionRenderer
can be used to create textual representation of an Option in a tabular format: one or more rows, each containing one or more columns. - CommandLine.Help.IParameterRenderer - Interface in nz.org.riskscape.picocli
-
When customizing online help for positional parameters details, a custom
IParameterRenderer
can be used to create textual representation of a Parameters field in a tabular format: one or more rows, each containing one or more columns. - CommandLine.Help.IParamLabelRenderer - Interface in nz.org.riskscape.picocli
-
When customizing online usage help for an option parameter or a positional parameter, a custom
IParamLabelRenderer
can be used to render the parameter name or label to a String. - CommandLine.Help.Layout - Class in nz.org.riskscape.picocli
-
Use a Layout to format usage help text for options and parameters in tabular format.
- CommandLine.Help.TextTable - Class in nz.org.riskscape.picocli
- CommandLine.Help.TextTable.Cell - Class in nz.org.riskscape.picocli
-
Helper class to index positions in a
Help.TextTable
. - CommandLine.Help.Visibility - Enum Class in nz.org.riskscape.picocli
-
Controls the visibility of certain aspects of the usage help message.
- CommandLine.HelpCommand - Class in nz.org.riskscape.picocli
-
Help command that can be installed as a subcommand on all application commands.
- CommandLine.IDefaultValueProvider - Interface in nz.org.riskscape.picocli
-
Provides default value for a command.
- CommandLine.IExceptionHandler - Interface in nz.org.riskscape.picocli
- CommandLine.IExceptionHandler2<R> - Interface in nz.org.riskscape.picocli
- CommandLine.IExecutionExceptionHandler - Interface in nz.org.riskscape.picocli
-
Classes implementing this interface know how to handle Exceptions that occurred while executing the
Runnable
,Callable
orMethod
user object of the command. - CommandLine.IExecutionStrategy - Interface in nz.org.riskscape.picocli
-
Implementations are responsible for "executing" the user input and returning an exit code.
- CommandLine.IExitCodeExceptionMapper - Interface in nz.org.riskscape.picocli
-
Interface that provides the appropriate exit code that will be returned from the
execute
method for an exception that occurred during parsing or while invoking the command's Runnable, Callable, or Method. - CommandLine.IExitCodeGenerator - Interface in nz.org.riskscape.picocli
-
@Command
-annotated classes can implement this interface to specify an exit code that will be returned from theexecute
method when the command is successfully invoked. - CommandLine.IFactory - Interface in nz.org.riskscape.picocli
-
Factory for instantiating classes that are registered declaratively with annotation attributes, like
CommandLine.Command.subcommands()
,CommandLine.Option.converter()
,CommandLine.Parameters.converter()
andCommandLine.Command.versionProvider()
. - CommandLine.IHelpCommandInitializable - Interface in nz.org.riskscape.picocli
-
Deprecated.use
CommandLine.IHelpCommandInitializable2
instead - CommandLine.IHelpCommandInitializable2 - Interface in nz.org.riskscape.picocli
-
Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.
- CommandLine.IHelpFactory - Interface in nz.org.riskscape.picocli
-
Creates the
CommandLine.Help
instance used to render the usage help message. - CommandLine.IHelpSectionRenderer - Interface in nz.org.riskscape.picocli
-
Renders a section of the usage help message.
- CommandLine.INegatableOptionTransformer - Interface in nz.org.riskscape.picocli
-
Determines the option name transformation of negatable boolean options.
- CommandLine.InitializationException - Exception in nz.org.riskscape.picocli
-
Exception indicating a problem during
CommandLine
initialization. - CommandLine.IParameterConsumer - Interface in nz.org.riskscape.picocli
-
Options or positional parameters can be assigned a
IParameterConsumer
that implements custom logic to process the parameters for this option or this position. - CommandLine.IParameterExceptionHandler - Interface in nz.org.riskscape.picocli
-
Classes implementing this interface know how to handle
ParameterExceptions
(usually from invalid user input). - CommandLine.IParseResultHandler - Interface in nz.org.riskscape.picocli
-
Deprecated.Use
CommandLine.IExecutionStrategy
instead. - CommandLine.IParseResultHandler2<R> - Interface in nz.org.riskscape.picocli
-
Deprecated.use
CommandLine.IExecutionStrategy
instead, seeCommandLine.execute(String...)
- CommandLine.ITypeConverter<K> - Interface in nz.org.riskscape.picocli
- CommandLine.IVersionProvider - Interface in nz.org.riskscape.picocli
-
Provides version information for a command.
- CommandLine.MaxValuesExceededException - Exception in nz.org.riskscape.picocli
-
Exception indicating that more values were specified for an option or parameter than its
arity
allows. - CommandLine.MissingParameterException - Exception in nz.org.riskscape.picocli
-
Exception indicating that a required parameter was not specified.
- CommandLine.MissingTypeConverterException - Exception in nz.org.riskscape.picocli
-
Exception indicating that an annotated field had a type for which no
CommandLine.ITypeConverter
was registered. - CommandLine.Mixin - Annotation Interface in nz.org.riskscape.picocli
- CommandLine.Model - Class in nz.org.riskscape.picocli
-
This class provides a namespace for classes and interfaces that model concepts and attributes of command line interfaces in picocli.
- CommandLine.Model.ArgGroupSpec - Class in nz.org.riskscape.picocli
-
The
ArgGroupSpec
class models agroup
of arguments (options, positional parameters or a mixture of the two). - CommandLine.Model.ArgGroupSpec.Builder - Class in nz.org.riskscape.picocli
-
Builder responsible for creating valid
ArgGroupSpec
objects. - CommandLine.Model.ArgSpec - Class in nz.org.riskscape.picocli
-
Models the shared attributes of
CommandLine.Model.OptionSpec
andCommandLine.Model.PositionalParamSpec
. - CommandLine.Model.CommandSpec - Class in nz.org.riskscape.picocli
-
The
CommandSpec
class models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command. - CommandLine.Model.IAnnotatedElement - Interface in nz.org.riskscape.picocli
-
Internal interface to allow annotation processors to construct a command model at compile time.
- CommandLine.Model.IGetter - Interface in nz.org.riskscape.picocli
-
Customizable getter for obtaining the current value of an option or positional parameter.
- CommandLine.Model.IOrdered - Interface in nz.org.riskscape.picocli
- CommandLine.Model.IScope - Interface in nz.org.riskscape.picocli
-
The scope of a binding is the context where the current value should be gotten from or set to.
- CommandLine.Model.ISetter - Interface in nz.org.riskscape.picocli
-
Customizable setter for modifying the value of an option or positional parameter.
- CommandLine.Model.ITypeInfo - Interface in nz.org.riskscape.picocli
-
Encapculates type information for an option or parameter to make this information available both at runtime and at compile time (when
Class
values are not available). - CommandLine.Model.Messages - Class in nz.org.riskscape.picocli
-
Utility class for getting resource bundle strings.
- CommandLine.Model.MethodParam - Class in nz.org.riskscape.picocli
-
Command method parameter, similar to java.lang.reflect.Parameter (not available before Java 8).
- CommandLine.Model.OptionSpec - Class in nz.org.riskscape.picocli
-
The
OptionSpec
class models aspects of a named option of a command, including whether it is required or optional, the option parameters supported (or required) by the option, and attributes for the usage help message describing the option. - CommandLine.Model.OptionSpec.Builder - Class in nz.org.riskscape.picocli
-
Builder responsible for creating valid
OptionSpec
objects. - CommandLine.Model.ParserSpec - Class in nz.org.riskscape.picocli
-
Models parser configuration specification.
- CommandLine.Model.PositionalParamSpec - Class in nz.org.riskscape.picocli
-
The
PositionalParamSpec
class models aspects of a positional parameter of a command, including whether it is required or optional, and attributes for the usage help message describing the positional parameter. - CommandLine.Model.PositionalParamSpec.Builder - Class in nz.org.riskscape.picocli
-
Builder responsible for creating valid
PositionalParamSpec
objects. - CommandLine.Model.UnmatchedArgsBinding - Class in nz.org.riskscape.picocli
-
This class allows applications to specify a custom binding that will be invoked for unmatched arguments.
- CommandLine.Model.UsageMessageSpec - Class in nz.org.riskscape.picocli
-
Models the usage help message specification and can be used to customize the usage help message.
- CommandLine.MutuallyExclusiveArgsException - Exception in nz.org.riskscape.picocli
-
Exception indicating that the user input included multiple arguments from a mutually exclusive group.
- CommandLine.Option - Annotation Interface in nz.org.riskscape.picocli
- CommandLine.OverwrittenOptionException - Exception in nz.org.riskscape.picocli
-
Exception indicating that an option for a single-value option field has been specified multiple times on the command line.
- CommandLine.ParameterException - Exception in nz.org.riskscape.picocli
-
Exception indicating something went wrong while parsing command line options.
- CommandLine.ParameterIndexGapException - Exception in nz.org.riskscape.picocli
-
Exception indicating that there was a gap in the indices of the fields annotated with
CommandLine.Parameters
. - CommandLine.Parameters - Annotation Interface in nz.org.riskscape.picocli
- CommandLine.ParentCommand - Annotation Interface in nz.org.riskscape.picocli
- CommandLine.ParseResult - Class in nz.org.riskscape.picocli
-
Encapsulates the result of parsing an array of command line arguments.
- CommandLine.ParseResult.Builder - Class in nz.org.riskscape.picocli
-
Builds immutable
ParseResult
instances. - CommandLine.ParseResult.GroupMatch - Class in nz.org.riskscape.picocli
-
A group's multiplicity specifies how many matches of a group may appear on the command line.
- CommandLine.ParseResult.GroupMatchContainer - Class in nz.org.riskscape.picocli
-
Provides information about an
CommandLine.ArgGroup
that was matched on the command line. - CommandLine.PicocliException - Exception in nz.org.riskscape.picocli
-
Base class of all exceptions thrown by
picocli.CommandLine
. - CommandLine.PropertiesDefaultProvider - Class in nz.org.riskscape.picocli
-
IDefaultValueProvider
implementation that loads default values for command line options and positional parameters from a properties file orProperties
object. - CommandLine.Range - Class in nz.org.riskscape.picocli
-
Describes the number of parameters required and accepted by an option or a positional parameter.
- CommandLine.RegexTransformer - Class in nz.org.riskscape.picocli
-
A regular expression-based option name transformation for negatable options.
- CommandLine.RegexTransformer.Builder - Class in nz.org.riskscape.picocli
-
Builder for creating
RegexTransformer
objects. - CommandLine.RunAll - Class in nz.org.riskscape.picocli
-
Command line execution strategy that prints help if requested, and otherwise executes the top-level command and all subcommands as
Runnable
,Callable
orMethod
. - CommandLine.RunFirst - Class in nz.org.riskscape.picocli
-
Command line execution strategy that prints help if requested, and otherwise executes the top-level
Runnable
orCallable
command. - CommandLine.RunLast - Class in nz.org.riskscape.picocli
-
Command line execution strategy that prints help if requested, and otherwise executes the most specific
Runnable
orCallable
subcommand. - CommandLine.Spec - Annotation Interface in nz.org.riskscape.picocli
-
Fields annotated with
@Spec
will be initialized with theCommandSpec
for the command the field is part of. - CommandLine.TypeConversionException - Exception in nz.org.riskscape.picocli
-
Exception thrown by
CommandLine.ITypeConverter
implementations to indicate a String could not be converted. - CommandLine.Unmatched - Annotation Interface in nz.org.riskscape.picocli
-
Fields annotated with
@Unmatched
will be initialized with the list of unmatched command line arguments, if any. - CommandLine.UnmatchedArgumentException - Exception in nz.org.riskscape.picocli
-
Exception indicating that a command line argument could not be mapped to any of the fields annotated with
CommandLine.Option
orCommandLine.Parameters
. - commandList() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a 2-column list with command names and the first line of their header or (if absent) description.
- commandListHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the subcommands list.
- commandListHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the subcommand list.
- commandListHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the command list; an empty string if there are no commands, otherwise the result of
String.format(commandListHeading, params)
. - commandListHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional heading preceding the subcommand list.
- commandNamesText(String) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a
Text
object containing the command name and all aliases, separated with the specified separator. - commands(CommandLine.Help.Ansi.IStyle...) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Adds the specified styles to the registered styles for commands in this color scheme builder and returns this builder.
- commandSpec() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the
CommandSpec
model that this Help was constructed with. - commandSpec() - Method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns the CommandSpec of this object, never
null
. - commandSpec() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the
CommandSpec
for the matched command. - commandStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Returns the registered styles for commands in this color scheme builder.
- commandStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns the registered styles for commands in this color scheme.
- commandText(String) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns a Text with all command styles applied to the specified command string.
- COMMENT - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- COMMENT_INLINE - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- compareTo(CommandLine.Range) - Method in class nz.org.riskscape.picocli.CommandLine.Range
- completionCandidates() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the completion candidates for this option or positional parameter, or
null
. - completionCandidates() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the explicitly set completion candidates for this option or positional parameter, valid enum constant names, or
null
if this option or positional parameter does not have any completion candidates and its type is not an enum. - completionCandidates() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Use this attribute to specify an
Iterable<String>
class that generates completion candidates for this option. - completionCandidates() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Use this attribute to specify an
Iterable<String>
class that generates completion candidates for this positional parameter. - completionCandidates(Iterable<String>) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the completion candidates for this option or positional parameter, and returns this builder.
- ComplexType(Token, AST.ValueList) - Constructor for class nz.org.riskscape.engine.typexp.AST.ComplexType
- ComplexTypeConstructor - Interface in nz.org.riskscape.engine.typexp
-
Functional interface that redeclares
TypeConstructor.construct(TypeBuilder, AST.ComplexType)
- component - Variable in class nz.org.riskscape.engine.pipeline.Manifest.VersionInfo
- compose(BiFunction<AncestorType.Converter, Object, Object>) - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
-
Return a new
AncestorType
with the same type, but with a converter that composes the functionality of the existing convert functionality - composeFailure(Problem) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Compose a failed result with a new type and a parent error message.
- composeProblems(String, Object...) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Deprecated.For new code, use the i18n Problem-based method below instead
- composeProblems(BiFunction<Problem.Severity, List<Problem>, Problem>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Variant of
ResultOrProblems.composeProblems(Problem)
that allows the problem to be constructed via a callback. - composeProblems(Problem) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
If this result has problems, then this method will return a new ResultOrProblems with a single problem with a new message that has this objects problems as children.
- composite(List<Problem>, String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- composite(Problem.Severity, List<Problem>, String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- compoundType(Type, List<Pair<Type, ?>>, T) - Method in interface nz.org.riskscape.engine.types.TypeVisitor
-
Visit a compound type, allowing possible recursion via the list of children.
- computeAncestor(TypeRules, Type, Type) - Method in interface nz.org.riskscape.engine.types.ancestor.AncestorRule
-
Works out if there's a common ancestor between type1 and type2
- computeAncestor(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.ancestor.NullableAncestorRule
- computeAncestor(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.ancestor.NumberTypeAncestorRule
- computeAncestor(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.ancestor.TypeSafeAncestorRule
- computeAncestor(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.ancestor.WrappedTypeAncestorRule
- computeAncestorNoConversion(Type, Type) - Method in class nz.org.riskscape.engine.typeset.TypeSet
-
Equivalent of the old Types#computeAncestor method.
- computeAncestors(List<Type>) - Method in class nz.org.riskscape.engine.typeset.TypeSet
-
A list version of computeAncestorType that uses a recursive algorithm to pair-wise 'unify' all the bits in the list to a single type and a conversion function if the values need to change
- computeAncestorsRecursive(List<Type>) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- computeAncestorType(Type, Type) - Method in interface nz.org.riskscape.engine.typeset.TypeRules
-
Compute the most common type between two types by comparing their ancestry using registered
AncestorRule
s - computeAncestorType(Type, Type) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- computeSafeAncestor(TypeRules, Referenced, Referenced) - Method in class nz.org.riskscape.engine.types.ancestor.ReferencedAncestorRule
- computeSafeAncestor(TypeRules, RSList, RSList) - Method in class nz.org.riskscape.engine.types.ancestor.RSListAncestorRule
- computeSafeAncestor(TypeRules, Struct, Struct) - Method in class nz.org.riskscape.engine.types.ancestor.StructMemberAncestorRule
- computeSafeAncestor(TypeRules, T1, T2) - Method in class nz.org.riskscape.engine.types.ancestor.TypeSafeAncestorRule
- concat(String) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns a copy of this
Text
instance with the specified text concatenated to the end. - concat(List<? extends T>, List<? extends T>) - Static method in class nz.org.riskscape.util.ListUtils
-
Fluid, immutable list concatenation method that concatenates two lists, returning a new list with the contents of list1 and list2 appended in order.
- concat(CommandLine.Help.Ansi.Text) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns a copy of this
Text
instance with the specified text concatenated to the end. - concatenate(List<SortBy>) - Static method in class nz.org.riskscape.engine.sort.SortBy
- concatenate(SortBy...) - Static method in class nz.org.riskscape.engine.sort.SortBy
-
Convenience version of
SortBy.concatenate(List)
- ConditionalParse<T> - Class in nz.org.riskscape.dsl
-
Used to represent a parsing operation that's conditional on a sequence of token possibilities.
- ConditionalParse(String, List<Set<? extends TokenType>>, Supplier<T>) - Constructor for class nz.org.riskscape.dsl.ConditionalParse
- Config - Interface in nz.org.riskscape.config
-
Simple interface for raw application configuration values grouped in to sections, a la ini files, but abstracted a little.
- ConfigProblems - Interface in nz.org.riskscape.config
- ConfigSection - Interface in nz.org.riskscape.config
-
A named collection of String key value pairs.
- Constant - Class in nz.org.riskscape.rl.ast
- Constant(Token) - Constructor for class nz.org.riskscape.rl.ast.Constant
- Constant(Token, Object) - Constructor for class nz.org.riskscape.engine.typexp.AST.Constant
- ConstantFunction - Class in nz.org.riskscape.engine.function
-
A RiskscapeFunction that always returns the same value
- ConstantFunction(Object, Type) - Constructor for class nz.org.riskscape.engine.function.ConstantFunction
- constantRequired(Expression) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Something required a constant expression, but was given a non-constant expression, e.g.
- construct(TypeBuilder, AST.ComplexType) - Method in interface nz.org.riskscape.engine.typexp.ComplexTypeConstructor
- construct(TypeBuilder, AST.ComplexType) - Method in interface nz.org.riskscape.engine.typexp.TypeConstructor
-
Attempt to build the type represented by this
TypeConstructor
- construct(TypeBuilder, AST.Symbol) - Method in class nz.org.riskscape.engine.types.SimpleType
- construct(TypeBuilder, AST.Symbol) - Method in interface nz.org.riskscape.engine.typexp.SimpleTypeConstructor
- construct(TypeBuilder, AST.Symbol) - Method in interface nz.org.riskscape.engine.typexp.TypeConstructor
-
Attempt to build the type represented by this
TypeConstructor
- ConstructionCallback<T> - Interface in nz.org.riskscape.engine
-
Functional interface for a factory that wants to register an object to an
IdentifiedCollection
without completely creating it. - ConstructorFeature<A,
T> - Class in nz.org.riskscape.engine.plugin -
Useful base class for features that just return a new instance of something of a particular type
- ConstructorFeature(Class<T>) - Constructor for class nz.org.riskscape.engine.plugin.ConstructorFeature
- consumeIf(Set<? extends TokenType>) - Method in class nz.org.riskscape.dsl.Lexer
- consumeIf(TokenType) - Method in class nz.org.riskscape.dsl.Lexer
- consumeParameters(Stack<String>, CommandLine.Model.ArgSpec, CommandLine.Model.CommandSpec) - Method in interface nz.org.riskscape.picocli.CommandLine.IParameterConsumer
-
Consumes as many of the specified command line arguments as needed by popping them off the specified Stack.
- container() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatch
-
Returns the container
GroupMatchContainer
of this match. - containerNotWritable(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceProblems
- ContainingType - Interface in nz.org.riskscape.engine.types
-
An interface for
Type
s that are containers for other types, e.g. - ContainingTypeRule - Class in nz.org.riskscape.engine.types.varule
-
Two
ContainingType
s of the same type (e.g. - ContainingTypeRule() - Constructor for class nz.org.riskscape.engine.types.varule.ContainingTypeRule
- contains(int) - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns
true
if this Range includes the specified value,false
otherwise. - contains(String) - Method in class nz.org.riskscape.engine.bind.ParameterSet
- contains(Struct.StructMember) - Method in class nz.org.riskscape.engine.types.Struct
- containsKey(String) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- containsKey(String) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
- contextOnly(ArgumentList, Type, Function<RealizationContext, UntypedFunction>) - Static method in interface nz.org.riskscape.engine.rl.RealizableFunction
-
Returns a
RiskscapeFunction
that isRealizableFunction
, where realization is needed just so the implementation can have access to theRealizationContext
- convert(String) - Method in interface nz.org.riskscape.picocli.CommandLine.ITypeConverter
-
Converts the specified command line argument value to some domain object.
- converter() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Optionally specify one or more
CommandLine.ITypeConverter
classes to use to convert the command line argument into a strongly typed value (or key-value pair for map fields). - converter() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Optionally specify one or more
CommandLine.ITypeConverter
classes to use to convert the command line argument into a strongly typed value (or key-value pair for map fields). - converters() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns one or more
type converters
to use to convert the command line argument into a strongly typed value (or key-value pair for map fields). - converters() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns one or more
type converters
to use to convert the command line argument into a strongly typed value (or key-value pair for map fields). - converters(CommandLine.ITypeConverter<?>...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets option/positional param-specific converter (or converters for Maps), and returns this builder.
- copy(CommandLine.Model.CommandSpec, CommandLine.Model.Messages) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns a copy of the specified Messages object with the CommandSpec replaced by the specified one.
- couldNotCoerce(Type, Type) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- couldNotConvert(String, Class<?>, String) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
A problem suitable for wrapping a more specific parameter binding error
- couldNotResolve(String) - Method in interface nz.org.riskscape.engine.data.BookmarkProblems
-
Could not infer the format from the given bookmark location
- counter(String) - Method in interface nz.org.riskscape.engine.Diagnostics
-
Returns the given counter, creating it if it didn't exist
- countIndents() - Method in class nz.org.riskscape.dsl.Token
- COVARIANT - Enum constant in enum class nz.org.riskscape.engine.types.varule.Variance
-
The rule says that values of source type can safely be assigned to the target, even though they are not an exact match.
- CoverageType - Class in nz.org.riskscape.engine.types
-
Represents a
TypedCoverage
using Riskscape's type system. - CoverageType(Type) - Constructor for class nz.org.riskscape.engine.types.CoverageType
- CR - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- CR_LF - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- create() - Method in interface nz.org.riskscape.engine.ConstructionCallback
-
Attempt to create the object, or give reasons why it failed
- create() - Static method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Creates and returns a new
CommandSpec
without any associated user object. - create(Class<K>) - Method in interface nz.org.riskscape.picocli.CommandLine.IFactory
-
Returns an instance of the specified class.
- create(Object, List<Type>, Type, UntypedFunction) - Static method in interface nz.org.riskscape.engine.function.RiskscapeFunction
-
Create a
RiskscapeFunction
from the given types and untyped function. - create(String, Type) - Static method in class nz.org.riskscape.engine.function.ArgumentList
-
Create an unary argument list.
- create(String, Type, String, Type) - Static method in class nz.org.riskscape.engine.function.ArgumentList
-
Create a binary argument list.
- create(String, Type, String, Type, String, Type) - Static method in class nz.org.riskscape.engine.function.ArgumentList
-
Create a ternary argument list.
- create(String, Type, String, Type, String, Type, String, Type) - Static method in class nz.org.riskscape.engine.function.ArgumentList
-
Create a quarternary argument list.
- create(URI, RealizedPipeline, Function<PipelineOutputStore, PipelineOutputOptions>) - Method in interface nz.org.riskscape.engine.output.PipelineOutputStores
-
Create a new container for storing pipeline results
- create(URI, RealizedPipeline, PipelineOutputOptions) - Method in interface nz.org.riskscape.engine.output.PipelineOutputStore
-
Creates a
PipelineOutputContainer
to store outputs from executing the given pipeline. - create(CreateRequest) - Method in interface nz.org.riskscape.engine.resource.ResourceFactory
-
Make a request to store a resource according to the given request.
- create(CreateRequest, String, String) - Method in interface nz.org.riskscape.engine.resource.ResourceFactory
-
Convenience version of create that calls
ResourceFactory.create(CreateRequest)
with a new request, derived from the given request and the given name and content type. - create(Type) - Static method in class nz.org.riskscape.engine.types.RSList
- create(Type, Type) - Static method in class nz.org.riskscape.engine.types.LookupTableType
- create(Type, Type, Expression, Supplier<Accumulator>) - Static method in interface nz.org.riskscape.engine.rl.agg.RealizedAggregateExpression
-
Create a
RealizedAggregateExpression
from the given parameters - create(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Method in interface nz.org.riskscape.picocli.CommandLine.IHelpFactory
-
Returns a
Help
instance to assist in rendering the usage help message - create(Lambda) - Static method in class nz.org.riskscape.engine.types.LambdaType
-
Create a type that matches a
Lambda
expression. - createDefault() - Static method in class nz.org.riskscape.picocli.CommandLine.RegexTransformer
-
Returns the
RegexTransformer
used by default for negatable options. - createDefaultLayout() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a
Layout
instance configured with the user preferences captured in this Help instance. - createDefaultOptionRenderer() - Method in class nz.org.riskscape.picocli.CommandLine.Help
- createDefaultParameterRenderer() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a new default ParameterRenderer which converts positional parameters to four columns of text to match the default TextTable column layout.
- createDefaultParamLabelRenderer() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a new default param label renderer that separates option parameters from their option name with the specified separator string, and, unless
CommandLine.Model.ArgSpec.hideParamSyntax()
is true, surrounds optional parameters with'['
and']'
characters and uses ellipses ("...") to indicate that any number of a parameter are allowed. - createDetailedSynopsisCommandText() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a Text object containing a partial detailed synopsis showing only the subcommands, starting with a
" "
space. - createDetailedSynopsisGroupsText(Set<CommandLine.Model.ArgSpec>) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a Text object containing a partial detailed synopsis showing only the options and positional parameters in the specified validating groups, starting with a
" "
space. - createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec>, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a Text object containing a partial detailed synopsis showing only the options, starting with a
" "
space. - createDetailedSynopsisPositionalsText(Collection<CommandLine.Model.ArgSpec>) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a
" "
space. - CreateException - Exception in nz.org.riskscape.engine.resource
-
Thrown from
ResourceFactory.create(CreateRequest)
and friends when something goes wrong with storing some data - CreateException(Throwable) - Constructor for exception nz.org.riskscape.engine.resource.CreateException
- CreateException(Problem) - Constructor for exception nz.org.riskscape.engine.resource.CreateException
- CreateException(Problem, Throwable) - Constructor for exception nz.org.riskscape.engine.resource.CreateException
- CreateHandle - Class in nz.org.riskscape.engine.resource
-
A sort of transaction handle for saving resources to allow various housekeeping to be applied by various protocols that allow storage.
- CreateHandle(CreateRequest) - Constructor for class nz.org.riskscape.engine.resource.CreateHandle
- CreateHandle.Callback - Interface in nz.org.riskscape.engine.resource
- createHeading(String, Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a String that can be used as a help section heading.
- createLabelRenderer(CommandLine.Model.CommandSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
- createMinimalOptionRenderer() - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a new minimal OptionRenderer which converts
Options
to a single row with two columns of text: an option name and a description. - createMinimalParameterRenderer() - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a new minimal ParameterRenderer which converts positional parameters to a single row with two columns of text: an option name and a description.
- createMinimalParamLabelRenderer() - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a value renderer that returns the
paramLabel
if defined or the field name otherwise. - createNestedContext(String) - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- CreateRequest - Class in nz.org.riskscape.engine.resource
-
Parameters for creating a resource via the
ResourceFactory
- CreateRequest(URI, String, String) - Constructor for class nz.org.riskscape.engine.resource.CreateRequest
- CreateRequest(URI, String, String, boolean) - Constructor for class nz.org.riskscape.engine.resource.CreateRequest
- createRhsIndex() - Method in interface nz.org.riskscape.engine.join.LopsidedJoiner
- createShortOptionArityAndNameComparator() - Static method in class nz.org.riskscape.picocli.CommandLine.Help
- createShortOptionNameComparator() - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Sorts
OptionSpecs
by their option name in case-insensitive alphabetic order. - createSinkForStep(SinkParameters) - Method in interface nz.org.riskscape.engine.output.PipelineOutputContainer
-
Create a
Sink
for the given terminalStep. - createTemporaryWriter() - Method in interface nz.org.riskscape.engine.io.TupleStorage
- createTextTable(Map<?, ?>) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a 2-column
TextTable
containing data from the specified map: the keys are put in the left column and the map values are in the right column. - crsById - Variable in class nz.org.riskscape.engine.SRIDSet
- crsMixtureReprojected(Object, CoordinateReferenceSystem) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
The data for {0} contained a mixture of CRSs, so has been reprojected to CRS {1}.
- CSI - Static variable in interface nz.org.riskscape.picocli.CommandLine.Help.Ansi.IStyle
-
The Control Sequence Introducer (CSI) escape sequence "\u001b[".
- CustomCode - Class in nz.org.riskscape.engine
-
A unique/one-off custom code to use as a Problem's code.
- CustomCode(String, Object) - Constructor for class nz.org.riskscape.engine.CustomCode
- customSynopsis() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Specify one or more custom synopsis lines to display instead of an auto-generated synopsis.
- customSynopsis() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional custom synopsis lines to use instead of the auto-generated synopsis.
- customSynopsis(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns command custom synopsis as a string.
- customSynopsis(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.
- cycleDetected(String, int, String, int) - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
-
There was a cycle in your pipeline
D
- Date - Class in nz.org.riskscape.engine.types
- Date() - Constructor for class nz.org.riskscape.engine.types.Date
- DATE - Static variable in class nz.org.riskscape.engine.types.Nullable
- DATE - Static variable in class nz.org.riskscape.engine.types.Types
- debug(String, Object...) - Method in interface nz.org.riskscape.engine.typeset.TypeRules
-
Print some debug info to the TypeRules logger - this should be decorated with some extra context that helps put a particular rule checks logging more easily interpreted
- debug(String, Object...) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- debugString(List<Problem>) - Static method in class nz.org.riskscape.problem.Problem
-
Variation of
Problem.debugString(Problem)
that dumps out a list of problems - debugString(Problem) - Static method in class nz.org.riskscape.problem.Problem
- Decimal - Class in nz.org.riskscape.engine.types
-
Permissive Decimal type that will convert any
Number
in to a BigDecimal viaNumber.doubleValue()
. - Decimal() - Constructor for class nz.org.riskscape.engine.types.Decimal
- DECIMAL - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- DECIMAL - Static variable in class nz.org.riskscape.engine.types.Nullable
- DECIMAL - Static variable in class nz.org.riskscape.engine.types.Types
- DEFAULT - Static variable in interface nz.org.riskscape.engine.geo.GeometryFixer
-
A
GeometryFixer
based on the JTS GeometryFixer. - DEFAULT_COMMAND_NAME - Static variable in class nz.org.riskscape.picocli.CommandLine.Help
-
Constant String holding the default program name, value defined in
CommandLine.Model.CommandSpec.DEFAULT_COMMAND_NAME
. - DEFAULT_COMMAND_NAME - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Constant String holding the default program name:
"<main class>"
. - DEFAULT_CRS - Static variable in interface nz.org.riskscape.engine.coverage.TypedCoverage
-
A default
CoordinateReferenceSystem
to return fromTypedCoverage.getCoordinateReferenceSystem()
when none is provided with the data. - DEFAULT_FALLBACK_VALUE - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- DEFAULT_INPUT_ALREADY_CHAINED - Enum constant in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Attempt to chain to a step's named input twice (when we infer the input name)
- DEFAULT_MEMBER_NAME - Static variable in class nz.org.riskscape.engine.types.SimpleType
- DEFAULT_PRIORITY - Static variable in interface nz.org.riskscape.engine.function.FunctionFramework
-
The most neutral of priorities
- DEFAULT_QUOTES - Static variable in interface nz.org.riskscape.dsl.TokenMatcher
- DEFAULT_SEPARATOR - Static variable in class nz.org.riskscape.picocli.CommandLine.Help
-
Constant String holding the default string that separates options from option parameters, value defined in
CommandLine.Model.ParserSpec.DEFAULT_SEPARATOR
. - DEFAULT_USAGE_WIDTH - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Constant holding the default usage message width:
80
. - defaultArity(Class<?>) - Static method in class nz.org.riskscape.picocli.CommandLine.Range
-
Deprecated.use
CommandLine.Range.defaultArity(Field)
instead - defaultArity(Field) - Static method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns the default arity
Range
: for interactive options/positional parameters, this is 0; foroptions
this is 0 for booleans and 1 for other types, forparameters
booleans have arity 0, arrays or Collections have arity "0..*", and other types have arity 1. - DefaultCollection<T> - Class in nz.org.riskscape.engine.pipeline
-
Implements a simple single-threaded collection of results from a Collector
- DefaultCollection(Collector<T>) - Constructor for class nz.org.riskscape.engine.pipeline.DefaultCollection
- defaultColorScheme(CommandLine.Help.Ansi) - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Creates and returns a new
CommandLine.Help.ColorScheme
initialized with picocli default values: commands are bold, options and parameters use a yellow foreground, and option parameters use italic. - defaultExceptionHandler() - Static method in class nz.org.riskscape.picocli.CommandLine
-
Convenience method that returns
new DefaultExceptionHandler<List<Object>>()
. - DefaultExceptionHandler() - Constructor for class nz.org.riskscape.picocli.CommandLine.DefaultExceptionHandler
-
Deprecated.
- defaultFactory() - Static method in class nz.org.riskscape.picocli.CommandLine
-
Returns the default
CommandLine.IFactory
implementation used if no factory was specified in theCommandLine constructor
. - defaultFunction - Variable in class nz.org.riskscape.engine.bind.Parameter.MutableFields
- DefaultRestrictor - Class in nz.org.riskscape.engine.restriction
- DefaultRestrictor(Struct, Predicate<Tuple>) - Constructor for class nz.org.riskscape.engine.restriction.DefaultRestrictor
- DefaultRestrictor(Struct, Predicate<Tuple>, Runnable) - Constructor for class nz.org.riskscape.engine.restriction.DefaultRestrictor
- defaultValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the default value of this option or positional parameter, before splitting and type conversion.
- defaultValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the default value to assign if this option or positional parameter was not specified on the command line, before splitting and type conversion.
- defaultValue() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Returns the default value of this option, before splitting and type conversion.
- defaultValue() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Returns the default value of this positional parameter, before splitting and type conversion.
- defaultValue(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the default value of this option or positional parameter to the specified value, and returns this builder.
- defaultValue(CommandLine.Model.ArgSpec) - Method in interface nz.org.riskscape.picocli.CommandLine.IDefaultValueProvider
-
Returns the default value for an option or positional parameter or
null
. - defaultValue(CommandLine.Model.ArgSpec) - Method in class nz.org.riskscape.picocli.CommandLine.PropertiesDefaultProvider
- defaultValueProvider() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Class that can provide default values dynamically at runtime.
- defaultValueProvider() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the default value provider for this command.
- defaultValueProvider(CommandLine.IDefaultValueProvider) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets default value provider for this command.
- defaultValueString() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the default value String for the purpose of displaying it in the description, without interpolating variables.
- defaultValueString(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the default value String displayed in the description; interpolating variables if specified.
- dependsOn - Variable in class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- deprecated(Object, Object) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
When thing has be deprecated but is used.
- DESC - Enum constant in enum class nz.org.riskscape.engine.sort.SortBy.Direction
- describeMismatch(TypeSet, Struct, Struct) - Static method in class nz.org.riskscape.engine.types.eqrule.PartialStructRule
-
Drills down into why a struct mismatch occurred.
- description() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Optional text to display between the synopsis line(s) and the list of options.
- description() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the description of this option, used when generating the usage documentation.
- description() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the description of this option or positional parameter, after all variables have been rendered, including the
${DEFAULT-VALUE}
and${COMPLETION-CANDIDATES}
variables. - description() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.
- description() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Description of this option, used when generating the usage documentation.
- description() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Description of the parameter(s), used when generating the usage documentation.
- description(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns command description text as a string.
- description(String) - Method in class nz.org.riskscape.engine.data.Bookmark.BookmarkBuilder
- description(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the description of this option, used when generating the usage documentation, and returns this builder.
- description(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.
- descriptionHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the description section.
- descriptionHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the description section.
- descriptionHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the description text; an empty string if there is no description, otherwise the result of
String.format(descriptionHeading, params)
. - descriptionHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the heading preceding the description section.
- descriptionKey() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the description key of this arg spec, used to get the description from a resource bundle.
- descriptionKey() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the description key of this arg spec, used to get the description from a resource bundle.
- descriptionKey() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
ResourceBundle key for this option.
- descriptionKey() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
ResourceBundle key for this option.
- descriptionKey(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the description key that is used to look up the description in a resource bundle, and returns this builder.
- detailedSynopsis(int, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Generates a detailed synopsis message showing all options and parameters.
- detailedSynopsis(Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Deprecated.
- determineCollectionClass() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- DEVNULL - Static variable in interface nz.org.riskscape.engine.pipeline.Sink
-
A sink that throws tuples away
- DEVNULL - Static variable in interface nz.org.riskscape.engine.pipeline.SinkConstructor
-
Constructor for a sink that throws tuples away.
- DEVNULL - Static variable in interface nz.org.riskscape.problem.ProblemSink
- Diagnostics - Interface in nz.org.riskscape.engine
- Dictionary(Token, Map<AST.Symbol, AST>) - Constructor for class nz.org.riskscape.engine.typexp.AST.Dictionary
- DIVIDE - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- doesNotMatchType() - Method in interface nz.org.riskscape.engine.data.InputDataProblems
- DOUBLE_COLON - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- drainWarnings(Consumer<Problem>) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- drainWarnings(Consumer<Problem>) - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- drainWarnings(Consumer<Problem>) - Method in interface nz.org.riskscape.engine.Reference
- drainWarnings(Consumer<Problem>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Removes any warnings or lower from a successful
ResultOrProblems
so that get() doesn't produce a warning - drainWarnings(Consumer<Problem>, BiFunction<Problem.Severity, List<Problem>, Problem>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Removes any warnings or lower from a successful
ResultOrProblems
so that get() doesn't produce a warning. - duplicateKey(Object, String, String) - Method in interface nz.org.riskscape.config.ConfigProblems
- duplicateKeys(Set<Struct.StructMember>) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- DuplicateKeysException - Exception in nz.org.riskscape.engine.types
- DuplicateKeysException(Set<Struct.StructMember>) - Constructor for exception nz.org.riskscape.engine.types.DuplicateKeysException
- DuplicateNameException(String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.DuplicateNameException
- DuplicateOptionAnnotationsException(String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.DuplicateOptionAnnotationsException
- duplicateSection(String, URI, URI) - Method in interface nz.org.riskscape.config.ConfigProblems
- duplicateSelectAll(Token) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
A second * has been put in a struct
E
- Edge - Class in nz.org.riskscape.engine.pipeline
- Edge(NamedStep, NamedStep) - Constructor for class nz.org.riskscape.engine.pipeline.Edge
- Edge(NamedStep, NamedStep, String) - Constructor for class nz.org.riskscape.engine.pipeline.Edge
- Edge(NamedStep, NamedStep, Optional<String>) - Constructor for class nz.org.riskscape.engine.pipeline.Edge
- EDGE_ALREADY_EXISTS - Enum constant in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Attempt to add an edge that has already been added
- ELLIPSIS - Static variable in interface nz.org.riskscape.cli.Terminal
-
Ellipsis character
...
- empty() - Static method in class nz.org.riskscape.engine.pipeline.Pipeline
- empty(URI) - Static method in interface nz.org.riskscape.config.Config
- empty(Type) - Static method in interface nz.org.riskscape.engine.coverage.TypedCoverage
- empty(CommandLine.Model.Messages) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns
true
if the specifiedMessages
isnull
or has anull ResourceBundle
. - Empty(Type) - Constructor for class nz.org.riskscape.engine.coverage.TypedCoverage.Empty
- EMPTY - Enum constant in enum class nz.org.riskscape.engine.pipeline.NestedPipelineStep.State
-
NestedPipelineStep.getNestedPipeline()
will return null - EMPTY - Static variable in interface nz.org.riskscape.config.Config
-
A config object that contains nothing and came from nowhere.
- EMPTY - Static variable in class nz.org.riskscape.engine.bind.ParameterSet
-
Somewhat useful constant to represent an empty parameter set
- EMPTY - Static variable in class nz.org.riskscape.engine.bind.ParameterTemplate
- EMPTY - Static variable in interface nz.org.riskscape.engine.relation.TupleIterator
-
An always empty
TupleIterator
, a bit likeCollections.emptyIterator()
- EMPTY - Static variable in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
An empty
PipelineDeclaration
. - EMPTY - Static variable in class nz.org.riskscape.pipeline.ast.StepChain
-
A special "empty" instance of a
StepChain
that can be used in place of null in various situations. - EMPTY_PROJECT_LOCATION - Static variable in interface nz.org.riskscape.engine.Engine
-
Null-equivalent to give to buildProject to signal you want to create an empty project
- EMPTY_STRUCT - Static variable in class nz.org.riskscape.engine.types.Struct
- EMPTY_TEXT - Static variable in interface nz.org.riskscape.cli.Terminal
-
Convenient constant to use in place of null for empty, un-styled, text
- EMPTY_TUPLE - Static variable in class nz.org.riskscape.engine.Tuple
-
'Helpful' constant for an empty tuple - built from
Struct.EMPTY_STRUCT
- emptyInput(String, Struct) - Static method in class nz.org.riskscape.engine.pipeline.RealizedStep
- EmptyList - Class in nz.org.riskscape.engine.types
-
A special case of a list type, which is always empty.
- EmptyListRule - Class in nz.org.riskscape.engine.types.varule
- EmptyListRule() - Constructor for class nz.org.riskscape.engine.types.varule.EmptyListRule
- emptyProject() - Method in interface nz.org.riskscape.engine.Engine
- EmptyRelation - Class in nz.org.riskscape.engine.relation
-
A relation that has no values, just a type.
- EmptyRelation(Struct) - Constructor for class nz.org.riskscape.engine.relation.EmptyRelation
- emptyStringNotValid() - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Special case parsing error for when the user gives us an empty string
- enabled() - Method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Returns
true
if ANSI escape codes should be emitted,false
otherwise. - end - Variable in class nz.org.riskscape.dsl.Token
- endOfOptionsDelimiter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- endOfOptionsDelimiter(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- Engine - Interface in nz.org.riskscape.engine
-
An Engine is the central part of the application that offers core services for doing data processing.
- Engine.Writeable - Interface in nz.org.riskscape.engine
-
An extension of the Engine interface with extra methods that are only safe to call during engine bootstrapping
- EngineBootstrapper - Class in nz.org.riskscape.engine.spi
-
Bit of code that adds something to an engine instance when it's created.
- EngineBootstrapper(String, Consumer<Engine.Writeable>) - Constructor for class nz.org.riskscape.engine.spi.EngineBootstrapper
- EngineCollection - Class in nz.org.riskscape.engine.spi
-
An engine collection allows new IdentifiedCollections to be plugged in, accessible via
IdentifiedLocator.getCollection(Class)
- EngineCollection(Class<IdentifiedCollection<Identified>>) - Constructor for class nz.org.riskscape.engine.spi.EngineCollection
- EngineCommand - Interface in nz.org.riskscape.engine.cli
-
Interface for commands to implement if they want access to a riskscape engine during execution.
- ensureLocal(Resource.Options) - Method in class nz.org.riskscape.engine.resource.BaseResource
- ensureLocal(Resource.Options) - Method in interface nz.org.riskscape.engine.resource.Resource
-
Returns a
Path
to a local representation of the resource if the resource loader supports this and is allowable given the options. - ensureLocalNotSupported(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceProblems
- enumClass - Variable in class nz.org.riskscape.dsl.Lexer.Tokens
- Enumeration - Class in nz.org.riskscape.engine.types
-
Riskscape type that maps a set of numbers to a set of well-known strings.
- eof(Lexer.Tokens<?>, String) - Static method in class nz.org.riskscape.dsl.Token
- EOF - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- EOF_IN_STRING - Enum constant in enum class nz.org.riskscape.dsl.LexerException.ProblemCodes
- eofToken - Variable in class nz.org.riskscape.dsl.Lexer.Tokens
- EPSG2193_NZTM - Static variable in class nz.org.riskscape.engine.SRIDSet
-
CRS for use on mainland New Zealand
- EPSG4326_LATLON - Static variable in class nz.org.riskscape.engine.SRIDSet
-
World coordinate system in lat/lon (y/x).
- EPSG4326_LONLAT - Static variable in class nz.org.riskscape.engine.SRIDSet
-
World coordinate system in lon/lat (x/y).
- epsgToCrs(String) - Static method in class nz.org.riskscape.engine.SRIDSet
- epsgToCrsWithForceXY(String) - Static method in class nz.org.riskscape.engine.SRIDSet
-
Similar to
SRIDSet.epsgToCrs(java.lang.String)
except that aCoordinateReferenceSystem
with an XY axis order will be returned regardless of how the CRS is defined. - EQUAL - Enum constant in enum class nz.org.riskscape.engine.types.varule.Variance
-
The rule says that values of source type can safely be assigned to the target, and appear to be an exact match.
- EqualityRule - Class in nz.org.riskscape.engine.types.varule
- EqualityRule() - Constructor for class nz.org.riskscape.engine.types.varule.EqualityRule
- equals(Object) - Method in class nz.org.riskscape.dsl.ConditionalParse
- equals(Object) - Method in class nz.org.riskscape.dsl.Token
- equals(Object) - Method in class nz.org.riskscape.dsl.Token.Location
- equals(Object) - Method in class nz.org.riskscape.engine.bind.BoundParameters
- equals(Object) - Method in class nz.org.riskscape.engine.bind.Parameter
- equals(Object) - Method in class nz.org.riskscape.engine.bind.ParameterSet
- equals(Object) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate.Choice
- equals(Object) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- equals(Object) - Method in class nz.org.riskscape.engine.BuildInfo
- equals(Object) - Method in class nz.org.riskscape.engine.data.Bookmark
- equals(Object) - Method in class nz.org.riskscape.engine.function.FunctionArgument
- equals(Object) - Method in class nz.org.riskscape.engine.i18n.HasMessages
- equals(Object) - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
- equals(Object) - Method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
- equals(Object) - Method in class nz.org.riskscape.engine.i18n.TranslationContext
- equals(Object) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- equals(Object) - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
- equals(Object) - Method in class nz.org.riskscape.engine.output.SinkParameters
- equals(Object) - Method in class nz.org.riskscape.engine.pipeline.Edge
- equals(Object) - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
- equals(Object) - Method in class nz.org.riskscape.engine.pipeline.ExecutionResult
- equals(Object) - Method in class nz.org.riskscape.engine.pipeline.NamedStep
- equals(Object) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- equals(Object) - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- equals(Object) - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- equals(Object) - Method in class nz.org.riskscape.engine.problem.ProblemFactoryProxy.JavaMethodCode
- equals(Object) - Method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
- equals(Object) - Method in class nz.org.riskscape.engine.resource.CreateHandle
- equals(Object) - Method in class nz.org.riskscape.engine.resource.CreateRequest
- equals(Object) - Method in class nz.org.riskscape.engine.resource.Resource.Options
- equals(Object) - Method in class nz.org.riskscape.engine.resource.Resource.PseudoResource
- equals(Object) - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- equals(Object) - Method in class nz.org.riskscape.engine.sort.SortBy
- equals(Object) - Method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- equals(Object) - Method in class nz.org.riskscape.engine.Tuple
- equals(Object) - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
- equals(Object) - Method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- equals(Object) - Method in class nz.org.riskscape.engine.types.CoverageType
- equals(Object) - Method in class nz.org.riskscape.engine.types.Enumeration
- equals(Object) - Method in class nz.org.riskscape.engine.types.LambdaType
- equals(Object) - Method in class nz.org.riskscape.engine.types.LookupTableType
- equals(Object) - Method in class nz.org.riskscape.engine.types.Nullable
- equals(Object) - Method in class nz.org.riskscape.engine.types.Referenced
- equals(Object) - Method in class nz.org.riskscape.engine.types.RelationType
- equals(Object) - Method in class nz.org.riskscape.engine.types.RSList
- equals(Object) - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- equals(Object) - Method in class nz.org.riskscape.engine.types.SimpleType
- equals(Object) - Method in class nz.org.riskscape.engine.types.Struct
- equals(Object) - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- equals(Object) - Method in class nz.org.riskscape.engine.types.Value
- equals(Object) - Method in class nz.org.riskscape.engine.types.WithinRange
- equals(Object) - Method in class nz.org.riskscape.engine.types.WithinSet
- equals(Object) - Method in class nz.org.riskscape.engine.types.WithMetadata
- equals(Object) - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- equals(Object) - Method in class nz.org.riskscape.engine.util.Pair
- equals(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
- equals(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
- equals(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
- equals(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- equals(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
- equals(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Range
- equals(Object) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- equals(Object) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- equals(Object) - Method in class nz.org.riskscape.pipeline.ast.StepChain
- equals(Object) - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
- equals(Object) - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- equals(Object) - Method in class nz.org.riskscape.pipeline.ast.StepLink
- equals(Object) - Method in class nz.org.riskscape.pipeline.ast.StepReference
- equals(Object) - Method in class nz.org.riskscape.pipeline.PipelineMetadata
- equals(Object) - Method in class nz.org.riskscape.problem.Problem
- equals(Object) - Method in class nz.org.riskscape.problem.ResultOrProblems
- equals(Object) - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- equals(Object) - Method in class nz.org.riskscape.rl.ast.BracketedExpression
- equals(Object) - Method in class nz.org.riskscape.rl.ast.Constant
- equals(Object) - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- equals(Object) - Method in class nz.org.riskscape.rl.ast.FunctionCall
- equals(Object) - Method in class nz.org.riskscape.rl.ast.Lambda
- equals(Object) - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- equals(Object) - Method in class nz.org.riskscape.rl.ast.ParameterToken
- equals(Object) - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- equals(Object) - Method in class nz.org.riskscape.rl.ast.SelectAllExpression
- equals(Object) - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- equals(Object) - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- EQUALS - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- equalsImpl(CommandLine.Model.ArgSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
- EquivalenceRule - Interface in nz.org.riskscape.engine.types.eqrule
-
An equivalence rule allows type-safe coercion to be applied to the Riskscape Expression language in a pluggable way.
- err() - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Returns the stream to print diagnostic messages to.
- error(String) - Static method in class nz.org.riskscape.problem.ResultOrProblems
-
Shortcut to ResultOrProblems.failed(Problem.error)
- error(String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- error(String, Object...) - Static method in class nz.org.riskscape.problem.ResultOrProblems
-
Shortcut to ResultOrProblems.failed(Problem.error)
- error(Throwable, String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- error(RiskscapeException) - Static method in class nz.org.riskscape.problem.ResultOrProblems
- error(ProblemCode, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Create an problem with
Problem.Severity.ERROR
with a particularProblemCode
and message arguments. - ERROR - Enum constant in enum class nz.org.riskscape.engine.geo.GeometryValidation
-
Geometry validity is check.
- ERROR - Enum constant in enum class nz.org.riskscape.problem.Problem.Severity
- errors() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
If
CommandLine.Model.ParserSpec.collectErrors
istrue
, returns the list of exceptions that were encountered during parsing, otherwise, returns an empty list. - errorWith(ProblemCode, Object, Object...) - Static method in class nz.org.riskscape.problem.Problems
-
Creates a Problem for an error found with a given object.
- errorWriting(String, String) - Method in interface nz.org.riskscape.engine.OutputProblems
- estimateSize() - Method in class nz.org.riskscape.engine.Tuple
-
Estimate the number of bytes used to store this
Tuple
when serialized. - estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Anything
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Bool
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.CoverageType
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Date
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Decimal
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.EmptyList
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Enumeration
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Floating
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.FunctionType
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Geom
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Integer
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.LambdaType
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.LookupTableType
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Nothing
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Nullable
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.RelationType
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.RSList
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Struct
- estimateSize(Object) - Method in class nz.org.riskscape.engine.types.Text
- estimateSize(Object) - Method in interface nz.org.riskscape.engine.types.Type
-
Estimate the number of bytes used to serialize the given value to an output stream.
- estimateSize(Object) - Method in interface nz.org.riskscape.engine.types.WrappingType
- estimateSize(Object) - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- evaluate(Object) - Method in interface nz.org.riskscape.engine.rl.RealizedExpression
-
Evaluate this expression against the given object
- evaluate(Point) - Method in class nz.org.riskscape.engine.coverage.TypedCoverage.Empty
- evaluate(Point) - Method in interface nz.org.riskscape.engine.coverage.TypedCoverage
-
Get values from coverage at point.
- evaluateConstant(RealizationContext, Class<T>, Type) - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
-
Attempts to realize and evaluate this argument's expression against an empty
Struct
, returning useful problems if the expression wasn't constant or if the returned type doesn't match the expected java type. - evaluateConstant(RealizationContext, FunctionCall, Class<T>) - Method in class nz.org.riskscape.engine.function.FunctionArgument
-
Helper method for a
RealizableFunction
to extract a constant from the arguments with various error handling along the way. - evaluateConstant(RealizationContext, FunctionCall, String, Class<T>, Type) - Method in class nz.org.riskscape.engine.function.ArgumentList
-
Deprecated.
- evaluateValues(Object...) - Method in interface nz.org.riskscape.engine.rl.RealizedExpression
-
Convenience form of
RealizedExpression.evaluate(java.lang.Object)
for expressions that you know accept aStruct
input type. - exclusive() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.ArgGroup
-
Determines whether this is a mutually exclusive group;
true
by default. - exclusive() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns whether this is a mutually exclusive group;
true
by default. - exclusive() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns whether this is a mutually exclusive group;
true
by default. - exclusive(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets whether this is a mutually exclusive group;
true
by default. - ExecutablePipeline - Class in nz.org.riskscape.engine.pipeline
- ExecutablePipeline(RealizedPipeline) - Constructor for class nz.org.riskscape.engine.pipeline.ExecutablePipeline
- execute(String...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Convenience method to allow command line application authors to avoid some boilerplate code in their application.
- execute(PipelineJobContext) - Method in interface nz.org.riskscape.engine.pipeline.PipelineExecutor
-
Start running the realized pipeline.
- execute(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractParseResultHandler
-
Deprecated.
- execute(CommandLine.ParseResult) - Method in interface nz.org.riskscape.picocli.CommandLine.IExecutionStrategy
-
"Executes" the user input and returns an exit code.
- executeHelpRequest(CommandLine.ParseResult) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Helper method that may be useful when processing the
ParseResult
that results from successfully parsing command line arguments. - ExecutionContext - Interface in nz.org.riskscape.engine.pipeline
-
Various bits associated with the realization and execution of a pipeline
- ExecutionException(CommandLine, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.ExecutionException
- ExecutionException(CommandLine, String, Throwable) - Constructor for exception nz.org.riskscape.picocli.CommandLine.ExecutionException
- executionFailed() - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
-
Problem associated with an
ExecutionException
- ExecutionOptions - Class in nz.org.riskscape.engine.pipeline
-
Various options that apply to
PipelineExecutor#execute(RealizedPipeline, ExecutionOptions)
- ExecutionOptions() - Constructor for class nz.org.riskscape.engine.pipeline.ExecutionOptions
- ExecutionResult - Class in nz.org.riskscape.engine.pipeline
-
Returned from
PipelineExecutor#execute(RealizedPipeline, ExecutionOptions)
. - ExecutionResult(PipelineJobContext) - Constructor for class nz.org.riskscape.engine.pipeline.ExecutionResult
- exit(int) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Calls
System.exit(int)
with the specified exit code. - exitCode() - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Returns the exit code to use as the termination status, or
null
(the default) if the handler should not callSystem.exit(int)
after processing completes. - ExitCode - Class in nz.org.riskscape.engine.cli
-
Return this from a
ChildCommand
command to indicate special exit instructions from the program - ExitCode(int) - Constructor for class nz.org.riskscape.engine.cli.ExitCode
- ExitCode(int, String) - Constructor for class nz.org.riskscape.engine.cli.ExitCode
- exitCodeList() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the values to be displayed in the exit codes section as a list of
"key:value"
pairs: keys are exit codes, values are descriptions. - exitCodeList() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a 2-column list with exit codes and their description.
- exitCodeList() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns an unmodifiable map with values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
- exitCodeList(Map<String, String>) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
- exitCodeListHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the exit codes section, may contain
"%n"
line separators. - exitCodeListHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the exit codes section, may contain
"%n"
line separators. - exitCodeListHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the exit code list text; the result of
String.format(exitCodeHeading, params)
. - exitCodeListHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional heading preceding the exit codes section, may contain
"%n"
line separators. - exitCodeOnExecutionException() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
- exitCodeOnExecutionException() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
- exitCodeOnExecutionException(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
- exitCodeOnInvalidInput() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Exit code for command line usage error.
- exitCodeOnInvalidInput() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns exit code for command line usage error.
- exitCodeOnInvalidInput(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets exit code for command line usage error.
- exitCodeOnSuccess() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Exit code for successful termination.
- exitCodeOnSuccess() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns exit code for successful termination.
- exitCodeOnSuccess(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets exit code for successful termination.
- exitCodeOnUsageHelp() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Exit code for successful termination after printing usage help on user request.
- exitCodeOnUsageHelp() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns exit code for successful termination after printing usage help on user request.
- exitCodeOnUsageHelp(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets exit code for successful termination after printing usage help on user request.
- exitCodeOnVersionHelp() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Exit code for successful termination after printing version help on user request.
- exitCodeOnVersionHelp() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns exit code for successful termination after printing version help on user request.
- exitCodeOnVersionHelp(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets exit code for successful termination after printing version help on user request.
- ExitException - Exception in nz.org.riskscape.engine.cli
-
Throw when there is some issue with the command that deserves an error message to the user along with potentially a non-zero exit
- ExitException(int, String, Object...) - Constructor for exception nz.org.riskscape.engine.cli.ExitException
- ExitException(int, String, List<Problem>) - Constructor for exception nz.org.riskscape.engine.cli.ExitException
- ExitException(int, Throwable, String, Object...) - Constructor for exception nz.org.riskscape.engine.cli.ExitException
- ExitException(int, Problem) - Constructor for exception nz.org.riskscape.engine.cli.ExitException
- ExitException(Problem) - Constructor for exception nz.org.riskscape.engine.cli.ExitException
- ExitException(Problem, Throwable) - Constructor for exception nz.org.riskscape.engine.cli.ExitException
- expandAtFiles() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- expandAtFiles(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- expect(Set<? extends TokenType>) - Method in class nz.org.riskscape.dsl.Lexer
- expect(TokenType...) - Method in class nz.org.riskscape.dsl.Lexer
- expectAST(Class<T>, AST, Function<AST, RuntimeException>) - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
- expectConstant(AST, Function<AST, RuntimeException>) - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
-
Helper method for
TypeConstructor
s that expects anAST
to be anAST.Constant
and return its java value. - expectConstantsOfType(AST.ComplexType, Type, List<AST>, int) - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
-
Helper method for
TypeConstructor
s that expects the tail of an argument list to all be constants that coerce to a particular riskscape type. - expectType(AST, Function<AST, RuntimeException>) - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
-
Helper method for
TypeConstructor
s for expecting anAST
to be either aAST.Symbol
or aAST.ComplexType
. - Expression - Interface in nz.org.riskscape.rl.ast
-
An as yet Unrealized expression AST.
- ExpressionConverter<T> - Class in nz.org.riskscape.rl.ast
-
A
ExpressionVisitor
for converting expressions in some way. - ExpressionConverter() - Constructor for class nz.org.riskscape.rl.ast.ExpressionConverter
- ExpressionParser - Class in nz.org.riskscape.rl
-
Builds a Riskscape Language Expression AST from a string.
- ExpressionParser() - Constructor for class nz.org.riskscape.rl.ExpressionParser
- ExpressionProblems - Interface in nz.org.riskscape.rl.ast
-
Factory for creating problems involving an expression
- ExpressionRealizer - Interface in nz.org.riskscape.engine.rl
-
Produces realized (and evaluation-ready) expressions from an AST and an input type as scope.
- ExpressionRealizer.ProblemCodes - Enum Class in nz.org.riskscape.engine.rl
-
Standard set of problem codes for describing problems during expression realization
- Expressions - Class in nz.org.riskscape.rl.ast
- Expressions() - Constructor for class nz.org.riskscape.rl.ast.Expressions
- ExpressionVisitor<T,
R> - Interface in nz.org.riskscape.rl.ast - ExtensionPoint<T extends PluginFeature> - Class in nz.org.riskscape.engine.plugin
-
An ExtensionPoint is an official advertised place that allows a
Plugin
to advertise aPluginFeature
SPI and a place where implementing features should be registered by the plugin system during startup. - ExtensionPoint(Class<T>) - Constructor for class nz.org.riskscape.engine.plugin.ExtensionPoint
- ExtensionPoints - Class in nz.org.riskscape.engine.plugin
- ExtensionPoints() - Constructor for class nz.org.riskscape.engine.plugin.ExtensionPoints
- extractExitCodeGenerators(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractParseResultHandler
-
Deprecated.
- extractExitCodeGenerators(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.RunAll
- extractExitCodeGenerators(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.RunFirst
- extractExitCodeGenerators(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.RunLast
F
- failed(Collection<ResultOrProblems<?>>) - Static method in class nz.org.riskscape.problem.ResultOrProblems
-
Create a new failed
ResultOrProblems
that collects all problems from a set of otherResultOrProblems
. - failed(List<Problem>) - Static method in class nz.org.riskscape.problem.ResultOrProblems
- failed(Problem...) - Static method in class nz.org.riskscape.problem.ResultOrProblems
- failed(ResultOrProblems<?>, ResultOrProblems<?>...) - Static method in class nz.org.riskscape.problem.ResultOrProblems
-
Create a new failed
ResultOrProblems
that collects all problems from a set of otherResultOrProblems
. - failedDependencies(String) - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
-
Step could not be realized because of failed dependencies
- FailedObjectException - Exception in nz.org.riskscape.engine
-
Thrown from an
IdentifiedCollection
when an object is looked up that couldn't (or wasn't) successfully created. - FailedObjectException(String, Class<?>, List<Problem>) - Constructor for exception nz.org.riskscape.engine.FailedObjectException
- FailedObjectException(String, Class<?>, Resource, List<Problem>) - Constructor for exception nz.org.riskscape.engine.FailedObjectException
- failedObjectLookedUp(String, Class<?>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Version of
GeneralProblems.failedResourceLookedUp(String, Resource, Class)
where no resource (or the unknown resource) is available. - failedResourceLookedUp(String, Resource, Class<?>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Produces an error for when a user has referenced and object by its id, but it has errors associated with it that mean it can't be used.
- failedToBuild(Object) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Failed to construct
from the input provided - failedToRealize(Expression, Type) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Wraps other problems to give the context for realization failing
- failedToValidate(Class<? extends Identified>, String, Resource) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
When an
Identified
object has failed validation - failedToValidate(String, Resource) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- faint - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fallbackValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns the fallback value for this option: the value that is assigned for options with an optional parameter if the option was specified on the command line without parameter.
- fallbackValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns the fallback value for this option: the value that is assigned for options with an optional parameter (for example,
arity = "0..1"
) if the option was specified on the command line without parameter. - fallbackValue() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
For options with an optional parameter (for example,
arity = "0..1"
), this value is assigned to the annotated element if the option is specified on the command line without an option parameter. - fallbackValue(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Sets the fallback value for this option: the value that is assigned for options with an optional parameter if the option was specified on the command line without parameter, and returns this builder.
- FALSE - Static variable in class nz.org.riskscape.rl.ast.Constant
- fatal(Throwable, String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- FATAL - Enum constant in enum class nz.org.riskscape.problem.Problem.Severity
- fetch(int) - Method in class nz.org.riskscape.engine.Tuple
- fetch(String) - Method in class nz.org.riskscape.engine.Tuple
-
Return a value from the tuple, with an implicit cast to the receiving type
- fetch(Struct.StructMember) - Method in class nz.org.riskscape.engine.Tuple
-
Return a value from the tuple, with an implicit cast to the receiving type
- fetchChild(String) - Method in class nz.org.riskscape.engine.Tuple
-
TBD is this actually necessary?
- fg(String) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
-
Parses the specified style markup and returns the associated style.
- fg_black - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fg_blue - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fg_cyan - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fg_green - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fg_magenta - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fg_red - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fg_white - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- fg_yellow - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- filename - Variable in class nz.org.riskscape.engine.pipeline.Manifest.OutputInfo
- FileProblems - Interface in nz.org.riskscape.engine
-
Factory for producing problems that involve a specific file, e.g.
- fillInStackTrace() - Method in exception nz.org.riskscape.problem.ProblemException
- filter(Collection<ParameterProperty>, Class<T>) - Static method in interface nz.org.riskscape.engine.bind.ParameterProperty
- filterAffected(Collection<? extends Problem>, Class<?>) - Static method in class nz.org.riskscape.problem.Problem
-
Filters the list of Problems (and their children) based on the affected class, e.g.
- filterProblems(Class<?>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Filters the Problems based on the class of thing the problem affects, e.g.
- finalize() - Method in class nz.org.riskscape.engine.plugin.Plugin
- find(Class<T>) - Method in interface nz.org.riskscape.engine.types.Type
-
Type-safe way to find a particular Type by recursing through this type and any types that it wraps.
- find(BiPredicate<StepChain, StepDeclaration>) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
General purpose step-finding method.
- find(Predicate<StepDeclaration>) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Convenience version of
PipelineDeclaration.find(BiPredicate)
that drops the chain from the predicate - find(Type, Class<T>) - Static method in class nz.org.riskscape.engine.types.WithMetadata
- findAll(BiPredicate<StepChain, StepDeclaration>) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
General purpose step-finding method.
- findAllowNull(Class<T>) - Method in interface nz.org.riskscape.engine.types.Type
-
Convenience for
Nullable.strip(this).find(type)
- findAnyException() - Method in class nz.org.riskscape.problem.Problem
-
Finds any exception info related to this problem, including exceptions that may have been caught by child/nested Problems
- findCommonAncestorOfType(Class<?>, Class<?>, Class<?>) - Static method in class nz.org.riskscape.ReflectionUtils
-
Search through both classes hierarchies, looking for the most recent ancestor that is either equal to
lookFor
or an ancestor that implementslookFor
. - findDefinition(String) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Search through for the definition of a step with the given name, using either the step id or alias
- findEquivalenceCoercer(Type, Type) - Method in interface nz.org.riskscape.engine.typeset.TypeRules
-
Search through the list of
EquivalenceRule
s and find the first one that can safely coerce a value from the source type to the target type. - findEquivalenceCoercer(Type, Type) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- findGeometryMember(Struct, TupleUtils.FindOption, Supplier<RuntimeException>) - Static method in class nz.org.riskscape.engine.query.TupleUtils
-
Look in the given struct for a member with type
Geom
. - findGeometryMember(Struct, TupleUtils.FindOption) - Static method in class nz.org.riskscape.engine.query.TupleUtils
- findIdentifiedClass(Class<? extends Identified>) - Static method in interface nz.org.riskscape.engine.Identified
- findImplementingClass(Class<T>, Class<? extends T>, ReflectionUtils.SearchOptions...) - Static method in class nz.org.riskscape.ReflectionUtils
-
Search through a class's hierarchy for an interface, returning the class or interface that implemented it.
- findMatches(CommandLine.Model.ArgGroupSpec) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the matches for the specified argument group.
- findOption(char) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the option with the specified short name, or
null
if no option with that name is defined for this command. - findOption(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the option with the specified name, or
null
if no option with that name is defined for this command. - findOrThrow(Object, T, Type) - Static method in class nz.org.riskscape.engine.types.Types
-
Convenience function to codify standard behaviour for when type.find() fails to find something and you want to fail fast in a
ProblemException.catching(nz.org.riskscape.problem.ProblemException.Call)
block - findParameterClass(Class<?>) - Static method in class nz.org.riskscape.ReflectionUtils
- findParameterClass(Class<?>, int) - Static method in class nz.org.riskscape.ReflectionUtils
-
Extracts the parameterized type (The
T
fromMyClass<T>
) from a parameterized subclass (e.g. - findParameters() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- findRequiredGeometryMember(Struct) - Static method in class nz.org.riskscape.engine.query.TupleUtils
-
Convenience version of findGeometryMember where required flag is set to true
- findTypeInformation(Class<? extends Type>) - Method in class nz.org.riskscape.engine.types.TypeRegistry
-
Search for a
TypeInformation
object that reports the given class as its type class \ (viaTypeInformation.getTypeClass()
- findTypeInformation(Type) - Method in class nz.org.riskscape.engine.types.TypeRegistry
-
Search for a
TypeInformation
object that reports the given type as its type class \ (viaTypeInformation.getTypeClass()
- finish() - Method in interface nz.org.riskscape.engine.pipeline.Sink
-
Tells the sink that there are no more tuples left to accept.
- finishTime - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- fix(Geometry) - Method in class nz.org.riskscape.engine.geo.GeometryFixer.Base
- fix(Geometry) - Method in interface nz.org.riskscape.engine.geo.GeometryFixer
-
Attempt to fix geom (which ought to be invalid).
- fixedInvalid(Geometry, Geometry, String) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When an invalid geometry (original) has been fixed.
- fixedInvalidPostReprojection(CoordinateReferenceSystem, CoordinateReferenceSystem, Geometry, Geometry) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When an geometry has become invalid during re-projection, but has been fixed.
- fixPathSep(String) - Static method in class nz.org.riskscape.engine.OsUtils
-
for strings that have file separators in them, make them correct for the env.
- flatMap(BiFunction<T, List<Problem>, ResultOrProblems<U>>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Maps this
ResultOrProblems
to another, only if the result has been set. - flatMap(Function<? super T, ResultOrProblems<U>>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
like
ResultOrProblems.flatMap(BiFunction)
, but appends the problem lists together in a newResultOrProblems
object - flatMap(Function<BoundParameters, ResultOrProblems<T>>) - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
ResultOrProblems
like method for mapping the parameters in to another ResultOrProblems object, but only if the parameters are valid - FlatProjection - Interface in nz.org.riskscape.engine.projection
- FlatProjector - Interface in nz.org.riskscape.engine.projection
-
A realized
FlatProjection
. - flattenMemberKeys(Struct) - Static method in class nz.org.riskscape.engine.types.Struct
- floating(double) - Static method in class nz.org.riskscape.rl.ast.Constant
-
Handy testing constructor to create a double "floating" constant
- Floating - Class in nz.org.riskscape.engine.types
- Floating() - Constructor for class nz.org.riskscape.engine.types.Floating
- FLOATING - Static variable in class nz.org.riskscape.engine.types.Nullable
- FLOATING - Static variable in class nz.org.riskscape.engine.types.Types
- footer() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Optional text to display after the list of options.
- footer() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional footer text lines displayed at the bottom of the help message.
- footer(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns command footer text as a string.
- footer(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional footer text lines displayed at the bottom of the help message.
- footerHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the footer section.
- footerHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the footer section.
- footerHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the footer text; the result of
String.format(footerHeading, params)
. - footerHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional heading preceding the footer section.
- forAnnotatedObject(Object) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Creates and returns a new
CommandSpec
initialized from the specified associated user object. - forAnnotatedObject(Object, CommandLine.IFactory) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Creates and returns a new
CommandSpec
initialized from the specified associated user object. - forAnnotatedObjectLenient(Object) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Creates and returns a new
CommandSpec
initialized from the specified associated user object. - forAnnotatedObjectLenient(Object, CommandLine.IFactory) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Creates and returns a new
CommandSpec
initialized from the specified associated user object. - forChar(char) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
-
Creates a token matcher for a single character
- forColumns(CommandLine.Help.Ansi, CommandLine.Help.Column...) - Static method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Constructs a
TextTable
with the specified columns. - forColumnWidths(CommandLine.Help.Ansi, int...) - Static method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Constructs a new TextTable with columns with the specified width, all SPANning multiple columns on overflow except the last column which WRAPS to the next row.
- forDefaultColumns(CommandLine.Help.Ansi, int) - Static method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Constructs a TextTable with five columns as follows: required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow) short option name (width: 2, indent: 0, TRUNCATE on overflow) comma separator (width: 1, indent: 0, TRUNCATE on overflow) long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow) description line(s) (width: 51, indent: 1, WRAP to next row on overflow)
- forDefaultColumns(CommandLine.Help.Ansi, int, int) - Static method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Constructs a TextTable with five columns as follows: required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow) short option name (width: 2, indent: 0, TRUNCATE on overflow) comma separator (width: 1, indent: 0, TRUNCATE on overflow) long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow) description line(s) (width: 51, indent: 1, WRAP to next row on overflow)
- forEach(Struct, Consumer<Tuple>) - Method in interface nz.org.riskscape.engine.io.TupleReader
-
Pass all the tuples to the given consumer until the stream is exhausted.
- forEachRemaining(Consumer<? super Tuple>) - Method in interface nz.org.riskscape.engine.relation.TupleIterator
-
Pass each tuple to the given consumer, closing the iterator once complete (or if in exception is thrown)
- forIString(String) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
-
Creates a token matcher for a single character
- forLineComment(String) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
- format(String) - Method in class nz.org.riskscape.engine.data.Bookmark.BookmarkBuilder
- Format - Interface in nz.org.riskscape.engine.output
-
A Format represents a file format (or other) used for data coming in and out of RiskScape.
- Format.Characteristics - Enum Class in nz.org.riskscape.engine.output
-
Format characteristics are here to guide the various bits of code that use them to be able to use them generically without prior knowledge of them specifically.
- forPattern(String) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
- forPattern(Pattern) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
-
Creates a token matcher for a
Pattern
- forQuotedString() - Static method in interface nz.org.riskscape.dsl.TokenMatcher
-
Creates a token matcher for a quoted string.
- forQuotedString(char) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
-
Creates a token matcher for a quoted string.
- forQuotedString(Set<Character>) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
-
Creates a token matcher for a string quoted with any of the characters in the given set.
- forString(String) - Static method in interface nz.org.riskscape.dsl.TokenMatcher
-
Creates a token matcher for a single character
- forStringArrayConsumer(CommandLine.Model.ISetter) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.UnmatchedArgsBinding
-
Creates a
UnmatchedArgsBinding
for a setter that consumesString[]
objects. - forStringCollectionSupplier(CommandLine.Model.IGetter) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.UnmatchedArgsBinding
-
Creates a
UnmatchedArgsBinding
for a getter that produces aCollection<String>
that the unmatched arguments can be added to. - Found(PipelineDeclaration, StepChain, StepDeclaration) - Constructor for class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- foundWith(Class<?>, String, List<Problem>) - Static method in class nz.org.riskscape.problem.Problems
- foundWith(Class<?>, String, Problem...) - Static method in class nz.org.riskscape.problem.Problems
- foundWith(Object, List<Problem>) - Static method in class nz.org.riskscape.problem.Problems
-
Collates the children into a top-level problem: "Problems found with {thing}"
- foundWith(Object, Problem...) - Static method in class nz.org.riskscape.problem.Problems
-
Creates a simple "Problems found with {thing}" problem with optional child problems.
- fps(String) - Static method in class nz.org.riskscape.engine.OsUtils
- from - Variable in class nz.org.riskscape.engine.pipeline.Edge
- from(Object, List<Problem>, List<Problem>) - Static method in interface nz.org.riskscape.engine.data.ResolvedBookmark
- from(Object) - Static method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Useful testing constructor to return a pre-constructed Object with a fake Bookmark object
- from(Object, List<Problem>) - Static method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Useful testing constructor to return a pre-constructed Object with a fake Bookmark object
- from(Parameter...) - Static method in class nz.org.riskscape.engine.bind.ParameterSet
- from(Geometry) - Static method in enum class nz.org.riskscape.engine.geo.GeometryFamily
- fromArray(FunctionArgument...) - Static method in class nz.org.riskscape.engine.function.ArgumentList
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Anything
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Bool
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.CoverageType
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Date
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Decimal
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.EmptyList
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Enumeration
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Floating
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.FunctionType
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Geom
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Integer
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.LambdaType
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.LookupTableType
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Nothing
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Nullable
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.RelationType
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.RSList
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Struct
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.types.Text
- fromBytes(DataInputStream) - Method in interface nz.org.riskscape.engine.types.Type
- fromBytes(DataInputStream) - Method in interface nz.org.riskscape.engine.types.WrappingType
- fromBytes(DataInputStream) - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- fromClass(Class) - Static method in enum class nz.org.riskscape.engine.geo.GeometryFamily
-
Return the
GeometryFamily
of fromClass. - fromEnum(Class<?>) - Static method in class nz.org.riskscape.engine.types.WithinSet
-
Convenience function that builds a WithinSet type of text members from an enum, making sure to convert java-style upper case enum members to riskscape-style lower-underscore names, suitable for use in things like options arrays, e.g.
- fromFunction(RiskscapeFunction) - Static method in class nz.org.riskscape.engine.types.FunctionType
- fromJavaType(Class<?>) - Static method in class nz.org.riskscape.engine.types.Types
- fromJavaType(Class<? extends Geometry>) - Static method in class nz.org.riskscape.engine.types.Geom
-
Finds the most specific RiskScape geometry
Type
that can represent javaType. - fromJavaTypeOptional(Class<?>) - Static method in class nz.org.riskscape.engine.types.Types
- fromList(Collection<Parameter>) - Static method in class nz.org.riskscape.engine.bind.ParameterSet
- fromStrictJavaTypeOptional(Class<?>) - Static method in class nz.org.riskscape.engine.types.Types
-
Variant of fromJavaTypeOptional that strictly maps to the internal java type.
- fromStruct(Struct) - Static method in class nz.org.riskscape.engine.function.ArgumentList
- fromURI(boolean) - Method in class nz.org.riskscape.engine.data.Bookmark.BookmarkBuilder
-
If true, this Bookmark has not been fetched from an identified collection, but instead constructed, probably from a URI.
- fromURI(URI) - Static method in class nz.org.riskscape.engine.data.Bookmark
-
Construct an anonymous bookmark from a URI.
- fromURI(URI, String) - Static method in class nz.org.riskscape.engine.data.Bookmark
- fullSynopsis() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the full usage synopsis of this command.
- FunctionArgument - Class in nz.org.riskscape.engine.function
- FunctionArgument(int, Type) - Constructor for class nz.org.riskscape.engine.function.FunctionArgument
- FunctionArgument(String, Type) - Constructor for class nz.org.riskscape.engine.function.FunctionArgument
- FunctionArgument(String, Type, Optional<Object>) - Constructor for class nz.org.riskscape.engine.function.FunctionArgument
- FunctionCall - Class in nz.org.riskscape.rl.ast
- FunctionCall(Token, List<FunctionCall.Argument>) - Constructor for class nz.org.riskscape.rl.ast.FunctionCall
- FunctionCall(Token, List<FunctionCall.Argument>, Optional<Pair<Token, Token>>) - Constructor for class nz.org.riskscape.rl.ast.FunctionCall
- FunctionCall(Token, List<FunctionCall.Argument>, Token) - Constructor for class nz.org.riskscape.rl.ast.FunctionCall
- FunctionCall.Argument - Class in nz.org.riskscape.rl.ast
- FunctionContext - Class in nz.org.riskscape.engine.function
-
Context containing things that may be useful to
RiskscapeFunction
s being instantiated from external sources. - FunctionContext(TypeSet) - Constructor for class nz.org.riskscape.engine.function.FunctionContext
- FunctionFramework - Interface in nz.org.riskscape.engine.function
-
Defines a framework for building functions, e.g.
- FunctionMetadata - Class in nz.org.riskscape.engine.function
-
Holds the common details about a RiskScape function, such as its argument-types and return-type.
- FunctionMetadata(String, List<Type>, Type, String) - Constructor for class nz.org.riskscape.engine.function.FunctionMetadata
-
This constructor is useful for testing
- FunctionMetadata(String, List<Type>, Type, String, IdentifiedFunction.Category, String) - Constructor for class nz.org.riskscape.engine.function.FunctionMetadata
-
Note that in general you would want to use the constructor
FunctionMetadata(String, ArgumentList, Type, String, IdentifiedFunction.Category, String)
instead, but in some cases providing a Listmay be simpler than an ArgumentList, i.e. - FunctionMetadata(String, ArgumentList, Type, String, IdentifiedFunction.Category, String) - Constructor for class nz.org.riskscape.engine.function.FunctionMetadata
- FunctionProblems - Interface in nz.org.riskscape.engine.function
- FunctionProvider - Interface in nz.org.riskscape.engine.function
- FunctionResolver - Interface in nz.org.riskscape.engine.function
-
Used for realizing
FunctionCall
expressions to produce aRiskscapeFunction
that can be used during execution ofRealizedExpression.evaluate(Object)
. - FunctionSet - Interface in nz.org.riskscape.engine
- FunctionType - Class in nz.org.riskscape.engine.types
-
Type information for a first-class function being stored in a tuple (as an
UntypedFunction
) - FunctionType(List<Type>, Type) - Constructor for class nz.org.riskscape.engine.types.FunctionType
- FUNCTOR_INTERFACES - Static variable in interface nz.org.riskscape.engine.pipeline.Step
-
The supported set of interfaces a Step can produce during realization.
G
- GeneralProblems - Interface in nz.org.riskscape.engine.problem
-
General purpose problems that can appear in many parts of the system.
- Geom - Class in nz.org.riskscape.engine.types
-
Riskscape Type that represents geometry, e.g.
- Geom() - Constructor for class nz.org.riskscape.engine.types.Geom
- GEOMETRY - Static variable in class nz.org.riskscape.engine.types.Nullable
- GEOMETRY - Static variable in class nz.org.riskscape.engine.types.Types
- GEOMETRY_LOGICAL - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- GEOMETRY_PROCESSING - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- GEOMETRY_REQUIRED - Enum constant in enum class nz.org.riskscape.problem.StandardCodes
- GeometryFamily - Enum Class in nz.org.riskscape.engine.geo
-
An enumeration of the main Geometry type 'families' we support in RiskScape, ranked in terms of their lowest-common-denominator-y-ness when intersecting each other, e.g.
- GeometryFixer - Interface in nz.org.riskscape.engine.geo
-
A utility for automatically fixing invalid
Geometry
. - GeometryFixer.Base - Class in nz.org.riskscape.engine.geo
-
A base implementation.
- GeometryInvalidException - Exception in nz.org.riskscape.engine
-
Thrown when a
Geometry
is found to be invalid. - GeometryInvalidException(Problem) - Constructor for exception nz.org.riskscape.engine.GeometryInvalidException
- GeometryProblems - Interface in nz.org.riskscape.engine
-
Problems relating to Geometry operations, errors, etc
- GeometryReprojectionException - Exception in nz.org.riskscape.engine
-
Thrown when a
Geometry
is not able to to re-projected to anotherCoordinateReferenceSystem
. - GeometryReprojectionException(String, Geometry, CoordinateReferenceSystem) - Constructor for exception nz.org.riskscape.engine.GeometryReprojectionException
- GeometryReprojectionException(String, Geometry, CoordinateReferenceSystem, Throwable) - Constructor for exception nz.org.riskscape.engine.GeometryReprojectionException
- GeometryRule - Class in nz.org.riskscape.engine.types.varule
-
Rule allow
Geometry
sub-types to be assigned toTypes.GEOMETRY
. - GeometryRule() - Constructor for class nz.org.riskscape.engine.types.varule.GeometryRule
- GeometryValidation - Enum Class in nz.org.riskscape.engine.geo
-
Enum to control if geometries should checked for validity and what to do if they are not
- GeomType - Class in nz.org.riskscape.engine.types
-
Base for a
Type
that wrapsTypes.GEOMETRY
to make it a more specific geometry sub-type. - GeomType() - Constructor for class nz.org.riskscape.engine.types.GeomType
- GeomType.Line - Class in nz.org.riskscape.engine.types
- GeomType.Point - Class in nz.org.riskscape.engine.types
- GeomType.Polygon - Class in nz.org.riskscape.engine.types
- get() - Static method in interface nz.org.riskscape.config.ConfigProblems
- get() - Static method in interface nz.org.riskscape.engine.ArgsProblems
- get() - Static method in interface nz.org.riskscape.engine.bind.ParamProblems
- get() - Static method in interface nz.org.riskscape.engine.data.BookmarkProblems
- get() - Static method in interface nz.org.riskscape.engine.data.InputDataProblems
- get() - Static method in interface nz.org.riskscape.engine.FileProblems
- get() - Static method in interface nz.org.riskscape.engine.GeometryProblems
- get() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- get() - Static method in interface nz.org.riskscape.engine.OutputProblems
- get() - Static method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
- get() - Static method in interface nz.org.riskscape.engine.problem.GeneralProblems
- get() - Static method in class nz.org.riskscape.engine.RandomSingleton
- get() - Method in interface nz.org.riskscape.engine.Reference
- get() - Static method in interface nz.org.riskscape.engine.resource.ResourceProblems
- get() - Static method in interface nz.org.riskscape.engine.types.TypeProblems
- get() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IGetter
-
Returns the current value of the binding.
- get() - Method in class nz.org.riskscape.problem.ResultOrProblems
- get() - Static method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Handy accessor to save on precious keystrokes
- get(int) - Method in class nz.org.riskscape.engine.function.ArgumentList
- get(int) - Method in class nz.org.riskscape.engine.SRIDSet
- get(int) - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- get(String, ProblemSink) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- get(FeatureSource<?, ?>) - Method in class nz.org.riskscape.engine.SRIDSet
- get(FeatureType) - Method in class nz.org.riskscape.engine.SRIDSet
- get(CoordinateReferenceSystem) - Method in class nz.org.riskscape.engine.SRIDSet
- get(Geometry) - Method in class nz.org.riskscape.engine.SRIDSet
- get(Class<T>) - Static method in class nz.org.riskscape.problem.Problems
-
Gets a (proxied) ProblemFactory that can be used to generate Problems.
- get(String) - Method in class nz.org.riskscape.engine.bind.ParameterSet
- get(String) - Method in class nz.org.riskscape.engine.function.ArgumentList
- get(String) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Deprecated.use
IdentifiedCollection.get(String, ProblemSink)
instead to make sure any warnings get picked up - get(String) - Method in class nz.org.riskscape.engine.typexp.AST.Dictionary
- get(String, ProblemSink) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Get an object from the collection that has the given id.
- getAccessString() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- getAccumulatorClass() - Method in interface nz.org.riskscape.engine.pipeline.Collector
- getActualGenericTypeArguments() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
-
Returns the names of the type arguments if this is a generic type.
- getAdditionalDescriptionKeys() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Subclasses should override to return a collection of additional description keys that may be used to find description text for this option or positional parameter in the resource bundle.
- getAdditionalDescriptionKeys() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns the additional lookup keys for finding description lines in the resource bundle for this option.
- getAdditionalDescriptionKeys() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
-
Returns the additional lookup keys for finding description lines in the resource bundle for this positional parameter.
- getAffected(Class<T>) - Method in class nz.org.riskscape.problem.Problem
-
With Problems, there is usually something this is most affected by the Problem, e.g.
- getAffectedClass() - Method in class nz.org.riskscape.engine.CustomCode
- getAffectedClass() - Method in class nz.org.riskscape.problem.Problem
- getAffectedName() - Method in class nz.org.riskscape.problem.Problem
- getAffectedObject() - Method in class nz.org.riskscape.problem.Problem
- getAggregationFunction() - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- getAggregationFunction() - Method in class nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter
- getAggregationFunction() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getAggregationFunction() - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- getAll() - Method in interface nz.org.riskscape.config.Config
- getAll() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- getAll() - Method in interface nz.org.riskscape.engine.IdentifiedCollection
- getAll(String) - Method in interface nz.org.riskscape.config.ConfigSection
- getAllowed() - Method in class nz.org.riskscape.engine.types.WithinSet
- getAllProblems() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- getAllProblems() - Method in interface nz.org.riskscape.engine.IdentifiedCollection
- getAlternatives() - Method in interface nz.org.riskscape.engine.function.OverloadedFunction
- getAncestorRules() - Method in class nz.org.riskscape.engine.types.TypeRegistry
- getAnnotatedFields(Class<?>, Class<? extends Annotation>) - Static method in class nz.org.riskscape.ReflectionUtils
- getAnnotation(Class<T>) - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- getAnnotation(Class<T>) - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- getAnsi() - Method in interface nz.org.riskscape.cli.AnsiHelper
- getAnsi() - Method in class nz.org.riskscape.cli.AnsiPrintStream
- getAnsi() - Method in interface nz.org.riskscape.cli.Terminal
- getAnsiErr() - Method in interface nz.org.riskscape.cli.Terminal
- getAnsiOut() - Method in interface nz.org.riskscape.cli.Terminal
- getArgs() - Method in class nz.org.riskscape.engine.types.LambdaType
-
The number of declared arguments
- getArgs() - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
-
The names of the arguments that are passed to the expression.
- getArgSpec() - Method in exception nz.org.riskscape.picocli.CommandLine.ParameterException
-
Returns the
ArgSpec
object for the (sub)command whose input could not be parsed. - getArgument(FunctionCall, String) - Method in class nz.org.riskscape.engine.function.ArgumentList
-
Returns the FunctionCall
FunctionCall.Argument
(i.e. - getArguments() - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- getArguments() - Method in class nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter
- getArguments() - Method in class nz.org.riskscape.engine.function.BinaryFunction
- getArguments() - Method in class nz.org.riskscape.engine.function.FunctionMetadata
- getArguments() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getArguments() - Method in interface nz.org.riskscape.engine.function.JavaFunction.Delegate
-
Called by
JavaFunction.getArguments()
to allow the delegate the option to provide anArgumentList
which enables keyword arguments to be used when the function is called. - getArguments() - Method in class nz.org.riskscape.engine.function.JavaFunction
-
Returns the argument list from
JavaFunction.Delegate.getArguments()
if this is not null else defers toRiskscapeFunction.getArguments()
. - getArguments() - Method in class nz.org.riskscape.engine.function.MetadataBasedFunction
- getArguments() - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- getArguments() - Method in interface nz.org.riskscape.engine.rl.agg.AggregationFunction
-
Returns the arguments this function expects, used for help and other introspection
- getArguments() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getArguments() - Method in class nz.org.riskscape.problem.Problem
- getArguments() - Method in class nz.org.riskscape.rl.ast.FunctionCall
- getArguments() - Method in class nz.org.riskscape.rl.ast.Lambda
-
Names of the arguments as given in the source
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.ArgumentList
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.BinaryFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.BinaryOperatorFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.ConstantFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.JavaFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.MetadataBasedFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.NullSafeFunction
- getArgumentTypes() - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.function.UnaryFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getArgumentTypes() - Method in class nz.org.riskscape.engine.types.FunctionType
- getArity() - Method in class nz.org.riskscape.engine.bind.Parameter
- getArity() - Method in class nz.org.riskscape.engine.function.ArgumentList
- getArity() - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- getAs() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- getAsSingleProblem() - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Returns the Problems found as a single Problem, rather than a List.
- getAst() - Method in class nz.org.riskscape.engine.pipeline.NamedStep
-
The source that defined this step - might not be actual user specified source code in some instances.
- getAst() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
The AST that this pipeline was built from.
- getAst() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getAtFileCommentChar() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the character that starts a single-line comment or
null
if all content of argument files should be interpreted as arguments (without comments). - getAttributeName() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
-
Deprecated.use getMemberName instead - the AST is no longer responsible for supplying a default member name to use when the user doesn't supply one
- getAuxiliaryTypeInfos() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
-
Returns type information of components or elements of a
multivalue
type. - getAuxiliaryTypes() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
-
Returns the component class of an array, or the parameter type of a generic Collection, or the parameter types of the key and the value of a generic Map.
- getBinder(Class<?>, Class<?>) - Method in interface nz.org.riskscape.engine.bind.BindingContext
-
Returns a
ParameterBinder
that can convert a value of fromType to toType. - getBinders() - Method in interface nz.org.riskscape.engine.Engine
-
IdentifiedCollection
ofParameterBinder
s to use for converting strings to model parameters. - getBindingContext() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- getBindingContext() - Method in interface nz.org.riskscape.engine.pipeline.RealizationInput
- getBookmark() - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
- getBookmarkResolvers() - Method in interface nz.org.riskscape.engine.Engine
- getBookmarks() - Method in interface nz.org.riskscape.engine.Project
- getBoundary() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- getBoundary() - Method in interface nz.org.riskscape.pipeline.ast.PipelineExpression
- getBoundary() - Method in class nz.org.riskscape.pipeline.ast.StepChain
- getBoundary() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- getBoundary() - Method in class nz.org.riskscape.pipeline.ast.StepLink
- getBoundary() - Method in class nz.org.riskscape.pipeline.ast.StepReference
- getBoundary() - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- getBoundary() - Method in class nz.org.riskscape.rl.ast.BracketedExpression
- getBoundary() - Method in class nz.org.riskscape.rl.ast.Constant
- getBoundary() - Method in interface nz.org.riskscape.rl.ast.Expression
- getBoundary() - Method in class nz.org.riskscape.rl.ast.FunctionCall
- getBoundary() - Method in class nz.org.riskscape.rl.ast.Lambda
- getBoundary() - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- getBoundary() - Method in class nz.org.riskscape.rl.ast.ParameterToken
- getBoundary() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- getBoundary() - Method in class nz.org.riskscape.rl.ast.SelectAllExpression
- getBoundary() - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- getBoundParameters() - Method in class nz.org.riskscape.engine.model.BaseModel2
- getBoundParameters() - Method in interface nz.org.riskscape.engine.model.Model
- getBoundParameters() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
-
The complete set of
Parameter
s that were used to realize this step. - getBounds() - Method in class nz.org.riskscape.engine.types.Referenced
- getBoundTo() - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
The
ParameterSet
that the unbound values were bound to - getBuilder() - Method in class nz.org.riskscape.engine.auth.SecretBuilder
- getBuildInfo() - Static method in class nz.org.riskscape.engine.BuildInfo
- getBuildInfo() - Method in interface nz.org.riskscape.engine.Engine
- getBuildParameterSet() - Method in interface nz.org.riskscape.engine.model.ModelFramework
-
Returns a set of parameters that are used to initially build the model, e.g.
- getBuildsClass() - Method in class nz.org.riskscape.engine.auth.SecretBuilder
- getBuildTime() - Method in class nz.org.riskscape.engine.BuildInfo
- getBundleName() - Method in class nz.org.riskscape.engine.i18n.HasMessages
- getCallback() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- getCanonicalType() - Method in class nz.org.riskscape.engine.typeset.LinkedType
- getCategory() - Method in class nz.org.riskscape.engine.function.FunctionMetadata
- getCategory() - Method in interface nz.org.riskscape.engine.function.IdentifiedFunction
- getCategory() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getCategory() - Method in class nz.org.riskscape.engine.function.JavaFunction
- getCategory() - Method in class nz.org.riskscape.engine.function.MetadataBasedFunction
- getCategory() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getCause() - Method in exception nz.org.riskscape.engine.RiskscapeException
- getCause() - Method in exception nz.org.riskscape.rl.MalformedExpressionException
- getChain() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- getChain() - Method in class nz.org.riskscape.pipeline.ast.StepLink
- getChainIndex() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- getChains() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- getCharacteristics() - Method in interface nz.org.riskscape.engine.output.Format
- getCharacteristics() - Method in interface nz.org.riskscape.engine.pipeline.Collector
- getChildren() - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
-
A list of RenderedProblems for each child in source
- getChildren() - Method in class nz.org.riskscape.problem.Problem
- getChoices() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- getChoices(Locale) - Method in class nz.org.riskscape.engine.model.ModelParameter
- getCJKAdjustedLength() - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns the number of columns this Text will occupy on the console, adjusted for wide CJK characters.
- getCJKAdjustedLength(int, int) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns the number of columns that the specified portion of this Text will occupy on the console, adjusted for wide CJK characters.
- getClassName() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
- getClassSimpleName() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
- getCode() - Method in class nz.org.riskscape.engine.cli.ExitCode
- getCode() - Method in interface nz.org.riskscape.engine.i18n.MessageKey
-
Return the code that identifies this message in
ResourceBundle
lookups. - getCode() - Method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
- getCode() - Method in class nz.org.riskscape.problem.Problem
- getCoercer(TypeRules, Type, Type) - Method in interface nz.org.riskscape.engine.types.eqrule.EquivalenceRule
- getCoercer(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.eqrule.IntegerToFloatingRule
- getCoercer(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.eqrule.NullableRule
- getCoercer(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.eqrule.PartialStructRule
- getCoercer(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.eqrule.SingleGeomToMultiGeomRule
- getCoercer(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.eqrule.SingleValueStructRule
- getCoercer(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.eqrule.StructGeometryRule
- getCollection(Class<U>) - Method in interface nz.org.riskscape.engine.IdentifiedLocator
- getCollectionByClass(Class<T>) - Method in interface nz.org.riskscape.engine.IdentifiedLocator
- getCollectionClass() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- getCollectionClass() - Method in interface nz.org.riskscape.engine.IdentifiedCollection
- getCollectionClass() - Method in exception nz.org.riskscape.engine.IdentifiedException
-
The type of thing in the collection XXX maybe just make this the collection itself?
- getCollectionClasses() - Method in interface nz.org.riskscape.engine.IdentifiedLocator
- getColorScheme() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the color scheme to use when printing help.
- getColumn() - Method in class nz.org.riskscape.dsl.Token.Location
- getCommand() - Method in exception nz.org.riskscape.engine.cli.InvalidUsageException
- getCommand() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the annotated user object that this
CommandLine
instance was constructed with. - getCommandLine() - Method in exception nz.org.riskscape.picocli.CommandLine.ExecutionException
-
Returns the
CommandLine
object for the (sub)command that could not be invoked. - getCommandLine() - Method in exception nz.org.riskscape.picocli.CommandLine.ParameterException
-
Returns the
CommandLine
object for the (sub)command whose input could not be parsed. - getCommandMethods(Class<?>, String) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Helper to get methods of a class annotated with
@Command
via reflection, optionally filtered by method name (not@Command.name
). - getCommandName() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the command name (also called program name) displayed in the usage help synopsis.
- getCommandSpec() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the
CommandSpec
model that thisCommandLine
was constructed with. - getCommitInfo() - Method in class nz.org.riskscape.engine.BuildInfo
- getComplexType() - Method in exception nz.org.riskscape.engine.typexp.TypeArgumentException
- getConfig() - Method in interface nz.org.riskscape.engine.Project
- getConstants() - Method in class nz.org.riskscape.dsl.Lexer.Tokens
- getConstructor() - Method in class nz.org.riskscape.engine.types.TypeInformation
-
A
TypeConstructor
that can construct instances of this type using riskscape's type expression language. - getContainedType() - Method in interface nz.org.riskscape.engine.types.ContainingType
- getContainedType() - Method in class nz.org.riskscape.engine.types.CoverageType
- getContainedType() - Method in class nz.org.riskscape.engine.types.EmptyList
- getContainedType() - Method in class nz.org.riskscape.engine.types.MultiGeom
- getContainedType() - Method in class nz.org.riskscape.engine.types.Nullable
- getContainedType() - Method in class nz.org.riskscape.engine.types.RelationType
- getContainedType() - Method in class nz.org.riskscape.engine.types.RSList
- getContainer() - Method in class nz.org.riskscape.engine.resource.CreateRequest
-
Location for where the data will be stored, like a directory or an object storage container.
- getContentAsString() - Method in interface nz.org.riskscape.engine.resource.Resource
- getContentReader() - Method in interface nz.org.riskscape.engine.resource.Resource
-
Return a
Reader
for the underlying resource. - getContentStream() - Method in interface nz.org.riskscape.engine.resource.Resource
-
Return an
InputStream
to the underlying resource. - getContentStream() - Method in class nz.org.riskscape.engine.resource.Resource.PseudoResource
- getContentSummary(Tuple) - Static method in class nz.org.riskscape.engine.query.TupleUtils
- getContentType() - Method in class nz.org.riskscape.engine.resource.CreateRequest
-
Content type of the data to be stored in mime-type form, e.g.
- getContext() - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
The
BindingContext
under which the parameters were bound - getContext() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getConvert() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
-
The function used to convert descendants to the given type
- getConverter() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- getCoordinateReferenceSystem() - Method in class nz.org.riskscape.engine.coverage.TypedCoverage.Empty
- getCoordinateReferenceSystem() - Method in interface nz.org.riskscape.engine.coverage.TypedCoverage
- getCrs() - Method in class nz.org.riskscape.engine.relation.SpatialMetadata
- getCrs() - Method in class nz.org.riskscape.engine.types.Referenced
- getData(Class<T>) - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
- getData(Bookmark, BindingContext, Class<T>) - Method in interface nz.org.riskscape.engine.data.BookmarkResolvers
-
Resolves a
Bookmark
and fetches the data from theResolvedBookmark
. - getDataType() - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
- getDeclared() - Method in class nz.org.riskscape.engine.bind.ParameterSet
- getDeclaredAnnotations() - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- getDeclaredParameter(String) - Method in interface nz.org.riskscape.engine.pipeline.Step
- getDeclaredParameterNames() - Method in interface nz.org.riskscape.engine.pipeline.Step
- getDeclaredParameters() - Method in interface nz.org.riskscape.engine.pipeline.Step
-
Deprecated.use getParameterSet() instead
- getDeclaringExecutable() - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- getDefaultCreationOptions() - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
A URI to use for storing results, typically with
ResourceFactory.create(nz.org.riskscape.engine.resource.CreateRequest)
- getDefaultCrs() - Method in interface nz.org.riskscape.engine.Project
-
A default CRS to apply to geometry when none is available.
- getDefaultFunction() - Method in class nz.org.riskscape.engine.bind.Parameter
- getDefaultInputName() - Method in interface nz.org.riskscape.engine.pipeline.Step
- getDefaultLocale() - Method in interface nz.org.riskscape.engine.i18n.Messages
- getDefaultMessage() - Method in interface nz.org.riskscape.engine.i18n.MessageKey
-
Return the default message to be used to resolve this message should lookups of 'code' fail to find a message.
- getDefaultMessage() - Method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
- getDefaultMessage() - Method in class nz.org.riskscape.problem.Problem
- getDefaultValue() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- getDefaultValue() - Method in class nz.org.riskscape.engine.function.FunctionArgument
- getDefaultValueProvider() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the default value provider for the command, or
null
if none has been set. - getDefaultValues(BindingContext) - Method in class nz.org.riskscape.engine.bind.Parameter
- getDelegate() - Method in class nz.org.riskscape.engine.function.JavaFunction
- getDependencies() - Method in interface nz.org.riskscape.engine.pipeline.RealizationInput
- getDependencies() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
-
The complete set of
RealizedStep
s that were used to realize this step - getDependencies() - Method in interface nz.org.riskscape.engine.rl.RealizedExpression
- getDependencies(NamedStep) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Get a list of dependencies that are required to provide the input(s) to step in the same order as the inputs are defined in step parameters.
- getDependents() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
-
The set of
RealizedStep
s that depend on the output of thisRealizedStep
. - getDescription() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- getDescription() - Method in class nz.org.riskscape.engine.data.Bookmark
- getDescription() - Method in class nz.org.riskscape.engine.function.FunctionMetadata
- getDescription() - Method in interface nz.org.riskscape.engine.function.IdentifiedFunction
- getDescription() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getDescription() - Method in class nz.org.riskscape.engine.function.JavaFunction
- getDescription() - Method in class nz.org.riskscape.engine.function.MetadataBasedFunction
- getDescription() - Method in class nz.org.riskscape.engine.pipeline.NullStep
- getDescription() - Method in interface nz.org.riskscape.engine.pipeline.Step
- getDescription() - Method in interface nz.org.riskscape.engine.resource.ResourceLoader
- getDescription() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getDescription() - Method in class nz.org.riskscape.pipeline.PipelineMetadata
-
A description of the pipeline, possibly the description of the model that generated.
- getDescription(Locale) - Method in interface nz.org.riskscape.engine.model.IdentifiedModel
- getDescription(Locale) - Method in class nz.org.riskscape.engine.model.ModelParameter
- getDescriptor() - Method in class nz.org.riskscape.engine.plugin.Plugin
- getDetailedHelpMessage(Object, String...) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Convenience form for
getDetailedMessage(getHelp(), owner, parts)
, cos it's very commonly used - getDetailedMessage(MessageSource, Object, String...) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Same as
Messages.getDetailedMessage(MessageSource, Locale, Object, String...)
but using default locale - getDetailedMessage(MessageSource, Locale, Object, String...) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Used for cases where the help is very detailed and can span several paragraphs.
- getDiagnostics() - Method in interface nz.org.riskscape.engine.Engine
-
A place to record and query various diagnostics related to this
Engine
instance. - getDigestInstance() - Static method in class nz.org.riskscape.engine.pipeline.Manifest
-
Get a new instance of a
MessageDigest
of the type used forManifest
checksums. - getDirection() - Method in class nz.org.riskscape.engine.sort.SortBy
-
The direction in which to sort.
- getDirectMapping() - Method in interface nz.org.riskscape.engine.projection.Projector
- getDirectMappingStrings() - Method in interface nz.org.riskscape.engine.projection.Projector
- getDisplayCrs() - Method in interface nz.org.riskscape.engine.Diagnostics
-
Returns a CRS for displaying geographic coordinates in a user-friendly and consistent manner.
- getDisplayHeight() - Method in interface nz.org.riskscape.cli.Terminal
- getDisplayWidth() - Method in interface nz.org.riskscape.cli.Terminal
- getDuplicates() - Method in exception nz.org.riskscape.engine.types.DuplicateKeysException
- getEdges() - Method in class nz.org.riskscape.engine.pipeline.ExecutablePipeline
- getEdges() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getEdgesFrom(NamedStep) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getEdgesTo(NamedStep) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getElements() - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- getEndOfOptionsDelimiter() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the end-of-options delimiter that signals that the remaining command line arguments should be treated as positional parameters.
- getEndSteps() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getEngine() - Method in interface nz.org.riskscape.engine.bind.BindingContext
- getEngine() - Method in interface nz.org.riskscape.engine.cli.EngineCommand
- getEngine() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- getEngine() - Method in interface nz.org.riskscape.engine.Project
- getEngine() - Method in interface nz.org.riskscape.engine.rl.RealizationContext
- getEntry(String) - Method in class nz.org.riskscape.engine.types.Struct
-
null-returning variation of getMember TODO consider making this package level or change it's name or something
- getEnumConstantNames() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
- getEnvelope() - Method in interface nz.org.riskscape.engine.coverage.TypedCoverage
- getEnvelope() - Method in class nz.org.riskscape.engine.types.Referenced
- getEquivalenceRules() - Method in class nz.org.riskscape.engine.types.TypeRegistry
- getErr() - Method in interface nz.org.riskscape.cli.Terminal
- getErr() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the writer to use when printing diagnostic (error) messages during command execution.
- getEvaluateIntersectionOp() - Method in interface nz.org.riskscape.engine.coverage.TypedCoverage
- getException() - Method in class nz.org.riskscape.problem.Problem
- getException() - Method in exception nz.org.riskscape.rl.MalformedExpressionException
- getExecuted() - Method in class nz.org.riskscape.engine.pipeline.ExecutionResult
-
The pipeline that was ultimately executed - it might differ from what was passed to execute in structural ways, but not functional ways.
- getExecutionContext() - Method in interface nz.org.riskscape.engine.output.PipelineJobContext
-
The
ExecutionContext
that was used to create this job. - getExecutionContext() - Method in interface nz.org.riskscape.engine.pipeline.RealizationInput
- getExecutionExceptionHandler() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the handler for dealing with exceptions that occurred in the
Callable
,Runnable
orMethod
user object of a command when the command was executed. - getExecutionResult() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the result of calling the user object
Callable
or invoking the user objectMethod
after parsing the user input, ornull
if this command has not been executed or if thisCommandLine
is for a subcommand that was not specified by the end user on the command line. - getExecutionStrategy() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the execution strategy used by the
execute
method to invoke the business logic on the user objects of this command and/or the user-specified subcommand(s). - getExisting() - Method in exception nz.org.riskscape.engine.ObjectAlreadyExistsException
- getExistingResource() - Method in exception nz.org.riskscape.engine.ObjectAlreadyExistsException
- getExitCode() - Method in interface nz.org.riskscape.picocli.CommandLine.IExitCodeGenerator
-
Returns the exit code that should be returned from the
execute
method. - getExitCode(Throwable) - Method in interface nz.org.riskscape.picocli.CommandLine.IExitCodeExceptionMapper
-
Returns the exit code that should be returned from the
execute
method. - getExitCodeExceptionMapper() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the mapper that was set by the application to map from exceptions to exit codes, for use by the
execute
method. - getExpected() - Method in exception nz.org.riskscape.dsl.UnexpectedTokenException
- getExpected() - Method in exception nz.org.riskscape.rl.MalformedExpressionException
- getExpr() - Method in class nz.org.riskscape.engine.sort.SortBy
-
Expression to extract value to sort by.
- getExpression() - Method in interface nz.org.riskscape.engine.rl.agg.RealizedAggregateExpression
- getExpression() - Method in interface nz.org.riskscape.engine.rl.RealizedExpression
- getExpression() - Method in class nz.org.riskscape.rl.ast.BracketedExpression
- getExpression() - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- getExpression() - Method in class nz.org.riskscape.rl.ast.Lambda
-
The expression to be evaluated, scoped to the list of arguments
- getExpression() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- getExpression() - Method in exception nz.org.riskscape.rl.MalformedExpressionException
- getExpressionRealizer() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- getExpressionRealizer() - Method in interface nz.org.riskscape.engine.rl.RealizationContext
- getExtension() - Method in interface nz.org.riskscape.engine.output.Format
- getExtensionPoints() - Method in interface nz.org.riskscape.engine.Engine
-
A collection of extension points that this engine was initialized with.
- getExtensionPoints() - Method in class nz.org.riskscape.engine.plugin.Plugin
-
Returns a list of
PluginFeature
classes advertised by thisPlugin
as possible extension points. - getExtensions(String) - Method in interface nz.org.riskscape.engine.data.BookmarkResolver
- getExtraneous() - Method in class nz.org.riskscape.engine.bind.BoundParameters
- getFailureProblem() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- getFailures() - Method in exception nz.org.riskscape.engine.pipeline.AutoClosingException
- getFailures() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getFamilyClass() - Method in enum class nz.org.riskscape.engine.geo.GeometryFamily
- getFeatureClass() - Method in class nz.org.riskscape.engine.plugin.ExtensionPoint
-
The 'service provider interface' class for this extension.
- getFeatures() - Method in class nz.org.riskscape.engine.plugin.ExtensionPoint
- getFeatures() - Method in class nz.org.riskscape.engine.plugin.Plugin
- getFeaturesOfType(Class<T>) - Method in interface nz.org.riskscape.engine.Engine
-
A generic look up method for features registered with the engine.
- getFeaturesOfType(Class<T>) - Method in class nz.org.riskscape.engine.plugin.ExtensionPoints
- getFilterFactory() - Method in interface nz.org.riskscape.engine.Engine
-
Get a filter factory.
- getFirst() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- getFirst() - Method in class nz.org.riskscape.pipeline.ast.StepChain
-
Nicer form of StepChain#getSteps().get(0)
- getFirstIdentifier() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- getFlatProjector(Struct) - Method in interface nz.org.riskscape.engine.projection.FlatProjection
-
Realize this projection with the given source type.
- getFormat() - Method in class nz.org.riskscape.engine.data.Bookmark
- getFormat() - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
The format that the user would like applied to all saved results, or empty if no preference was given.
- getFormat() - Method in class nz.org.riskscape.engine.output.SinkParameters
-
A format the user has asked the data to be saved in
- getFormats() - Method in interface nz.org.riskscape.engine.data.BookmarkResolver
- getFormats() - Method in interface nz.org.riskscape.engine.Engine
-
IdentifiedCollection
ofFormat
s that may be used to write output files. - getFramework() - Method in class nz.org.riskscape.engine.model.BaseModel2
- getFramework() - Method in interface nz.org.riskscape.engine.model.Model
- getFrameworkParameters() - Method in class nz.org.riskscape.engine.model.BaseModel2
- getFrameworkParameters() - Method in interface nz.org.riskscape.engine.model.Model
-
Returns the parameters used by the
ModelFramework
to build this model (e.g. - getFrom() - Method in exception nz.org.riskscape.engine.bind.NoBindingAvailableException
- getFrom() - Method in exception nz.org.riskscape.engine.typexp.UnknownTypeException
- getFromRange(double, double) - Static method in class nz.org.riskscape.engine.util.RandomUtils
-
Randomly selects a value from the given range.
- getFunction() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getFunction() - Method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- getFunctionCallArgument(FunctionCall) - Method in class nz.org.riskscape.engine.function.FunctionArgument
- getFunctionFrameworks() - Method in interface nz.org.riskscape.engine.Engine
- getFunctionResolver() - Method in interface nz.org.riskscape.engine.rl.RealizationContext
- getFunctionSet() - Method in interface nz.org.riskscape.engine.Project
- getGeometryFactory(CoordinateReferenceSystem) - Method in class nz.org.riskscape.engine.SRIDSet
- getGeometryStructMember() - Method in class nz.org.riskscape.engine.relation.SpatialMetadata
- getGeometryValidation() - Method in interface nz.org.riskscape.engine.Project
- getGot() - Method in exception nz.org.riskscape.dsl.UnexpectedTokenException
- getGot() - Method in exception nz.org.riskscape.rl.MalformedExpressionException
- getGroupMatches() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the top-level container for the
ArgGroupSpec
match or matches found. - getHelp() - Method in interface nz.org.riskscape.engine.i18n.Messages
- getHelp() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns a new
Help
object created by theIHelpFactory
with theCommandSpec
andColorScheme
of this command. - getHelpFactory() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the
IHelpFactory
that is used to construct the usage help message. - getHelpMessage(Object, String...) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Convenience form for
getMessage(getHelp(), owner, parts)
, cos it's very commonly used - getHelpSectionKeys() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the section keys in the order that the usage help message should render the sections.
- getHelpSectionMap() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the map of section keys and renderers used to construct the usage help message.
- getI18nClassLoader() - Method in class nz.org.riskscape.engine.plugin.Plugin
- getI18nClassLoader() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
- getId() - Method in class nz.org.riskscape.engine.auth.SecretBuilder
- getId() - Method in class nz.org.riskscape.engine.data.Bookmark
- getId() - Method in interface nz.org.riskscape.engine.data.BookmarkResolver
- getId() - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Shortcut for
ResolvedBookmark.getBookmark()
andBookmark.getId()
- getId() - Method in exception nz.org.riskscape.engine.FailedObjectException
- getId() - Method in class nz.org.riskscape.engine.function.FunctionMetadata
- getId() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getId() - Method in class nz.org.riskscape.engine.function.JavaFunction
- getId() - Method in class nz.org.riskscape.engine.function.MetadataBasedFunction
- getId() - Method in interface nz.org.riskscape.engine.Identified
- getId() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- getId() - Method in class nz.org.riskscape.engine.pipeline.NullStep
- getId() - Method in class nz.org.riskscape.engine.plugin.ExtensionPoint
- getId() - Method in class nz.org.riskscape.engine.plugin.Plugin
- getId() - Method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
- getId() - Method in interface nz.org.riskscape.engine.Reference
- getId() - Method in interface nz.org.riskscape.engine.resource.ResourceLoader
- getId() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getId() - Method in interface nz.org.riskscape.engine.types.ancestor.AncestorRule
- getId() - Method in interface nz.org.riskscape.engine.types.eqrule.EquivalenceRule
- getId() - Method in class nz.org.riskscape.engine.types.TypeInformation
-
An identifier for the type - should be ([a-z]) so that it can be used to identify types with riskscape's type expression language
- getId() - Method in interface nz.org.riskscape.engine.types.varule.VarianceRule
- getId() - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- getIdent() - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
- getIdentifiedClass() - Method in interface nz.org.riskscape.engine.Identified
- getIdentifiedClass() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- getIdentifiedClass() - Method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
- getIdentifiedClass() - Method in interface nz.org.riskscape.engine.Reference
- getIdentifiedModels() - Method in interface nz.org.riskscape.engine.Project
- getIdentifier() - Method in class nz.org.riskscape.rl.ast.FunctionCall
- getIdentifier() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- getIdentifiers() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- getIdentToken() - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
-
The first identifier that starts this step declaration.
- getIfType(Class<T>) - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Performs a conditional cast of the resolved thing, even if there are validation issues that stopped the data from being accessed If
ResolvedBookmark.validate()
returned errors, then this method should return an empty result with an error saying there were validation errors stopping the data from being accessed - getImplicitName(RealizationContext, RealizedExpression, Collection<String>) - Static method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
-
Return a name we can use to represent the given realized expression in a struct where no member name has been given.
- getImplicitTypeName(RealizationContext, Type) - Static method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
- getImplied() - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
-
The presence of one property can imply other properties, e.g.
- getIn() - Method in interface nz.org.riskscape.cli.Terminal
- getIndentLevel() - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
-
The number of ancestors this problem has
- getIndents() - Method in class nz.org.riskscape.dsl.Token
- getIndex() - Method in class nz.org.riskscape.engine.function.FunctionArgument
- getIndex() - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- getInputArity() - Method in class nz.org.riskscape.engine.pipeline.NullStep
- getInputArity() - Method in interface nz.org.riskscape.engine.pipeline.Step
- getInputNames() - Method in interface nz.org.riskscape.engine.pipeline.Step
- getInputType() - Method in interface nz.org.riskscape.engine.rl.agg.RealizedAggregateExpression
-
The
Type
that this expression's accumulators accept viaAccumulator.accumulate(Object)
- getInputType() - Method in interface nz.org.riskscape.engine.rl.RealizedExpression
- getInstance(Class<T>) - Static method in class nz.org.riskscape.engine.types.SimpleType
- getInterfaces(Class<?>) - Static method in class nz.org.riskscape.ReflectionUtils
- getJavaType() - Method in class nz.org.riskscape.engine.function.BinaryOperatorFunction
- getJobContext() - Method in class nz.org.riskscape.engine.pipeline.ExecutionResult
- getJoinedType() - Method in interface nz.org.riskscape.engine.join.Join
-
The type of tuple that
Join.join(Tuple, Tuple)
produces. - getJoinedType() - Method in interface nz.org.riskscape.engine.join.LopsidedJoiner
-
The type of tuple that
LopsidedJoiner.join(Object, Tuple)
produces. - getJoinType() - Method in interface nz.org.riskscape.engine.join.Join
-
Whether left, inner etc
- getKey() - Method in exception nz.org.riskscape.engine.NoSuchMemberException
- getKey() - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- getKeyType() - Method in interface nz.org.riskscape.engine.lookup.LookupTable
- getKeyType() - Method in class nz.org.riskscape.engine.types.LookupTableType
- getKeyword() - Method in interface nz.org.riskscape.dsl.TokenMatcher
- getKeyword() - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
- getKeyword() - Method in class nz.org.riskscape.engine.function.FunctionArgument
- getKeywords() - Method in class nz.org.riskscape.engine.function.ArgumentList
- getLabel() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate.Choice
- getLabel() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- getLabel() - Method in class nz.org.riskscape.engine.model.ModelParameter
- getLabels() - Method in interface nz.org.riskscape.engine.i18n.Messages
- getLast() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- getLast() - Method in class nz.org.riskscape.pipeline.ast.StepChain
-
Nicer form of
StepChain.getSteps().get(StepChain.getSteps().size() - 1);
- getLastIdentifier() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- getLeft() - Method in class nz.org.riskscape.engine.util.Pair
- getLeft() - Method in class nz.org.riskscape.rl.ast.Lambda
- getLength() - Method in class nz.org.riskscape.dsl.Token.Location
- getLhs() - Method in interface nz.org.riskscape.engine.join.Join
-
Expected type of the lhs of this join
- getLhs() - Method in interface nz.org.riskscape.engine.join.LopsidedJoiner
-
Expected type of the lhs of this join
- getLhs() - Method in class nz.org.riskscape.pipeline.ast.StepLink
- getLhs() - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- getLhsJavaType() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getLhsType() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getLimit() - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- getLimit() - Method in interface nz.org.riskscape.engine.relation.Relation
- getLine() - Method in class nz.org.riskscape.dsl.Token.Location
- getLine1() - Method in exception nz.org.riskscape.dsl.InconsistentIndentException
- getLine2() - Method in exception nz.org.riskscape.dsl.InconsistentIndentException
- getLink(int) - Method in class nz.org.riskscape.pipeline.ast.StepChain
- getLinkCount() - Method in class nz.org.riskscape.pipeline.ast.StepChain
- getLinkedType(String) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- getLoaders() - Method in interface nz.org.riskscape.engine.resource.ResourceFactory
- getLocale() - Method in interface nz.org.riskscape.cli.Terminal
- getLocale() - Method in class nz.org.riskscape.engine.i18n.TranslationContext
-
The locale being used for the translation
- getLocation() - Method in interface nz.org.riskscape.config.ConfigSection
- getLocation() - Method in class nz.org.riskscape.dsl.Token
- getLocation() - Method in class nz.org.riskscape.engine.data.Bookmark
-
Contains a potentially modified location, set to be absolute based on the location of the bookmark itself.
- getLocation() - Method in class nz.org.riskscape.engine.resource.BaseResource
- getLocation() - Method in interface nz.org.riskscape.engine.resource.Resource
- getLocation() - Method in class nz.org.riskscape.engine.resource.Resource.PseudoResource
- getLocation() - Method in class nz.org.riskscape.pipeline.PipelineMetadata
-
Where this pipeline came from.
- getLookupTableType() - Method in interface nz.org.riskscape.engine.lookup.LookupTable
- getMax() - Method in class nz.org.riskscape.engine.types.WithinRange
- getMaxRequired() - Method in class nz.org.riskscape.engine.bind.Parameter
- getMediaType() - Method in interface nz.org.riskscape.engine.output.Format
- getMediaType() - Method in interface nz.org.riskscape.engine.resource.Resource
- getMember(int) - Method in class nz.org.riskscape.rl.ast.StructDeclaration
-
Shortcut for
getMembers().get(index)
- getMember(String) - Method in class nz.org.riskscape.engine.types.Struct
- getMemberKeys() - Method in class nz.org.riskscape.engine.types.Struct
- getMembers() - Method in class nz.org.riskscape.engine.types.Struct
- getMembers() - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- getMemberType() - Method in class nz.org.riskscape.engine.types.CoverageType
-
The
Type
of values returned fromTypedCoverage.evaluate(org.locationtech.jts.geom.Point)
- getMemberType() - Method in class nz.org.riskscape.engine.types.RelationType
- getMemberType() - Method in class nz.org.riskscape.engine.types.RSList
- getMessage() - Method in class nz.org.riskscape.engine.cli.ExitCode
- getMessage() - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
-
The translated message for the source problem
- getMessage() - Method in class nz.org.riskscape.problem.Problem
- getMessage() - Method in exception nz.org.riskscape.problem.ProblemException
- getMessage(String, Object...) - Method in interface nz.org.riskscape.engine.i18n.MessageSource
-
Same as
MessageSource.getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale)
withLocale.getDefault()
and null default. - getMessage(String, Object...) - Method in class nz.org.riskscape.engine.i18n.TranslationContext
-
Allows this object to act a little like a MessageSource, which can help with statements().that().look().like().this();
- getMessage(String, Object[], String) - Method in class nz.org.riskscape.engine.i18n.TranslationContext
-
Same theory as
TranslationContext.getMessage(String code, Object...args)
but with a default message - getMessage(String, Object[], String, Locale) - Method in interface nz.org.riskscape.engine.i18n.MessageSource
-
Try to resolve the message.
- getMessage(String, Object[], Locale) - Method in interface nz.org.riskscape.engine.i18n.MessageSource
-
Same as
MessageSource.getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale)
with null default. - getMessage(MessageKey) - Method in interface nz.org.riskscape.engine.i18n.MessageSource
- getMessage(MessageKey, Locale) - Method in interface nz.org.riskscape.engine.i18n.MessageSource
-
Try to resolve the resolvable, returning
MessageKey.getDefaultMessage()
if lookup fails. - getMessage(MessageSource, Object, String...) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Same as
Messages.getMessage(MessageSource, Locale, Object, String...)
but using default locale - getMessage(MessageSource, Locale, Object, String...) - Method in interface nz.org.riskscape.engine.i18n.Messages
- getMessageArguments() - Method in interface nz.org.riskscape.engine.i18n.MessageKey
-
Return the array of arguments to be used to resolve this message.
- getMessageArguments() - Method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
- getMessageFactory(Class<T>, Locale) - Method in interface nz.org.riskscape.engine.i18n.MessageSource
-
Returns an implementation of the given factory class that resolves messages against the given locale and message source.
- getMessages() - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
- getMessages() - Method in interface nz.org.riskscape.engine.Engine
- getMessageSource() - Method in class nz.org.riskscape.engine.i18n.TranslationContext
-
The MessageSource being used for translation (i.e.
- getMetadata() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getMetadata() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getMetadata() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- getMetadata(Class<T>) - Method in class nz.org.riskscape.engine.types.WithMetadata
- getMethodParamPosition() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- getMetricRegistry() - Method in interface nz.org.riskscape.engine.Diagnostics
-
A place to register and query various
Metric
s linked to theEngine
- getMetricRegistry() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- getMin() - Method in class nz.org.riskscape.engine.types.WithinRange
- getMinRequired() - Method in class nz.org.riskscape.engine.bind.Parameter
- getMissing() - Method in exception nz.org.riskscape.picocli.CommandLine.MissingParameterException
- getMissingTypeId() - Method in exception nz.org.riskscape.engine.typeset.MissingTypeException
- getMixinName() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- getMixins() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns a map of user objects whose options and positional parameters were added to ("mixed in" with) this command.
- getModel() - Method in interface nz.org.riskscape.engine.model.IdentifiedModel
- getModelFrameworks() - Method in interface nz.org.riskscape.engine.Engine
- getModelParameter() - Method in exception nz.org.riskscape.engine.bind.ParameterBindingException
- getModelParameter(String) - Method in interface nz.org.riskscape.engine.model.Model
- getModelParameters() - Method in class nz.org.riskscape.engine.model.BaseModel2
- getModelParameters() - Method in interface nz.org.riskscape.engine.model.Model
-
Returns the model's parameters.
- getName() - Method in interface nz.org.riskscape.config.ConfigSection
- getName() - Method in class nz.org.riskscape.dsl.ConditionalParse
-
Debugging name for this part of the grammar
- getName() - Method in class nz.org.riskscape.engine.bind.Parameter
- getName() - Method in interface nz.org.riskscape.engine.data.BookmarkResolver
- getName() - Method in class nz.org.riskscape.engine.model.ModelParameter
- getName() - Method in class nz.org.riskscape.engine.output.SinkParameters
-
A name associate with the
Sink
. - getName() - Method in class nz.org.riskscape.engine.pipeline.NamedStep
-
The name that the user assigned, or that the system generated, that identifies an instance of the step in the
Pipeline
. - getName() - Method in interface nz.org.riskscape.engine.pipeline.RealizationInput
- getName() - Method in class nz.org.riskscape.engine.resource.CreateRequest
-
A name for this resource within the container.
- getName() - Method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- getName() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- getName() - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- getName() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- getName() - Method in class nz.org.riskscape.pipeline.PipelineMetadata
-
A name for this pipeline.
- getName() - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- getName() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- getNamedInput() - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
-
Get the input name, if any, that the output should be directed to.
- getNamedInputToken() - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
-
The identifier that specifies a named input which accepts the previous step in the chain's output, e.g.
- getNameToken() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- getNameToken() - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- getNegatableOptionTransformer() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the
INegatableOptionTransformer
used to create the negative form of negatable options. - getNestedPipeline() - Method in interface nz.org.riskscape.engine.pipeline.NestedPipelineStep
- getNewResource() - Method in exception nz.org.riskscape.engine.ObjectAlreadyExistsException
- getNext() - Method in class nz.org.riskscape.engine.sort.SortBy
-
A subordinate, sort order
- getNextTokens() - Method in class nz.org.riskscape.dsl.ConditionalParse
-
The sequence of tokens to be matched
- getNormalizedOperator() - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- getNormalVariate(double, double) - Static method in class nz.org.riskscape.engine.util.RandomUtils
-
Randomly selects a value from a normal distribution with the given mean and standard deviation.
- getNotNullableIndices() - Method in class nz.org.riskscape.engine.function.NullSafeFunction
-
for each argument, records true if the original receiver is not nullable
- getNumThreads() - Method in interface nz.org.riskscape.engine.pipeline.PipelineExecutor
- getOffset() - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- getOffset() - Method in interface nz.org.riskscape.engine.relation.Relation
- getOfType(Class<T>) - Method in class nz.org.riskscape.engine.auth.Secrets
- getOn() - Method in interface nz.org.riskscape.engine.join.Join
-
Used to determine whether tuples should be joined or not
- getOne(String) - Method in interface nz.org.riskscape.config.ConfigSection
- getOneRequired(String) - Method in interface nz.org.riskscape.config.ConfigSection
- getOperation() - Method in class nz.org.riskscape.engine.function.BinaryOperatorFunction
- getOperation() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getOperator() - Method in class nz.org.riskscape.engine.function.BinaryOperatorFunction
- getOperator() - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- getOr(String) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- getOr(String) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
ResultOrProblems returning alternative to get, which will return the same problems that a
NoSuchObjectException
or aFailedObjectException
would have, but as part of a ResultOrProblems. - getOrComputeFromCache(Class<?>, Object, Class<T>, Function<Object, T>) - Method in interface nz.org.riskscape.engine.rl.RealizationContext
-
Convenience version of
RealizationContext.getOrComputeFromCache(Object, Class, Function)
that namespaces keys with a class - getOrComputeFromCache(Object, Class<T>, Function<Object, T>) - Method in interface nz.org.riskscape.engine.rl.RealizationContext
-
Lookup and possibly populate an item in this context's cache, in a thread-safe way, so that there's only ever one of each object in the cache.
- getOriginal() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getOrThrow() - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Flow control helper for use with ResultOrProblems - see
ProblemException
for more details. - getOrThrow(Function<List<Problem>, Problem>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Flow control helper for use with ResultOrProblems - see
ProblemException
for more details. - getOrThrow(Problem) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Flow control helper for use with ResultOrProblems - see
ProblemException
for more details. - getOS() - Static method in class nz.org.riskscape.engine.OsUtils
- getOut() - Method in interface nz.org.riskscape.cli.Terminal
- getOut() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the writer used when printing user-requested usage help or version help during command execution.
- getOutputBaseLocation() - Method in interface nz.org.riskscape.engine.Project
- getOutputContainer() - Method in interface nz.org.riskscape.engine.output.PipelineJobContext
-
A storage location associated with this pipeline job.
- getOutputs() - Method in class nz.org.riskscape.engine.pipeline.ExecutablePipeline
- getOutputStream() - Method in class nz.org.riskscape.engine.resource.CreateHandle
- getOverloaded() - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- getOverloaded() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getOverloaded() - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- getOverwritten() - Method in exception nz.org.riskscape.picocli.CommandLine.OverwrittenOptionException
-
Returns the
CommandLine.Model.ArgSpec
for the option which was being overwritten. - getOwner() - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- getParameter() - Method in exception nz.org.riskscape.engine.bind.NoBindingAvailableException
-
A parameter associated with the
NoBindingAvailableException
, may be null - getParameter() - Method in class nz.org.riskscape.engine.model.ModelParameter
- getParameter(String) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getParameterExceptionHandler() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the handler for dealing with invalid user input when the command is executed.
- getParameterizedType() - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- getParameterNames() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getParameters() - Method in class nz.org.riskscape.engine.auth.SecretBuilder
- getParameters() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getParameters() - Method in interface nz.org.riskscape.engine.pipeline.RealizationInput
- getParameterSet() - Method in interface nz.org.riskscape.engine.data.BookmarkResolver
- getParameterSet() - Method in interface nz.org.riskscape.engine.function.FunctionFramework
-
Returns a set of parameters that are used to define the function and its metadata.
- getParameterSet() - Method in class nz.org.riskscape.engine.pipeline.NullStep
- getParameterSet() - Method in interface nz.org.riskscape.engine.pipeline.Step
-
The set of
Parameter
s this step accepts. - getParameterTemplates() - Method in interface nz.org.riskscape.engine.Project
- getParamMap() - Method in class nz.org.riskscape.engine.data.Bookmark
- getParent() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the command that this is a subcommand of, or
null
if this is a top-level command. - getParse() - Method in class nz.org.riskscape.dsl.ConditionalParse
-
A callback that gives the results of parsing.
- getParseResult() - Method in class nz.org.riskscape.picocli.CommandLine
- getPipeline() - Method in interface nz.org.riskscape.engine.output.PipelineJobContext
-
The actual pipeline being executed
- getPipeline() - Method in exception nz.org.riskscape.engine.pipeline.AutoClosingException
- getPipeline() - Method in exception nz.org.riskscape.engine.pipeline.PipelineDefinitionException
- getPipeline() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getPipeline() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- getPipelineDeclaration() - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
The
PipelineDeclaration
that the pipeline was realized from, if known. - getPipelineExecutor() - Method in interface nz.org.riskscape.engine.Engine
- getPipelineExecutor() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- getPipelineOutputs() - Method in interface nz.org.riskscape.engine.output.PipelineOutputContainer
- getPipelineOutputs() - Method in class nz.org.riskscape.engine.pipeline.ExecutionResult
- getPipelineOutputStores() - Method in interface nz.org.riskscape.engine.Engine
- getPipelineSteps() - Method in interface nz.org.riskscape.engine.Engine
- getPlugin() - Method in exception nz.org.riskscape.engine.plugin.PluginRuntimeException
- getPluginClassName() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
- getPluginDependencies() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
-
The plugin ids this plugin depends upon
- getPluginId() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
-
A unique id for the plugin - ideally globally unique, but must be at least install-unique
- getPlugins() - Method in interface nz.org.riskscape.engine.Engine
- getPosition() - Method in exception nz.org.riskscape.dsl.LexerException
- getPosition() - Method in class nz.org.riskscape.dsl.Token
- getPositionalArguments() - Method in class nz.org.riskscape.rl.ast.FunctionCall
-
Builds a list of all the arguments that were given before the first keyword argument appears
- getPredicate() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getPredicate() - Method in class nz.org.riskscape.engine.restriction.DefaultRestrictor
- getPredicate() - Method in interface nz.org.riskscape.engine.restriction.Restriction
-
Return the predicate used for deciding whether a tuple should be removed or not.
- getPriority() - Method in interface nz.org.riskscape.engine.function.FunctionFramework
- getProblem() - Method in exception nz.org.riskscape.engine.bind.NoBindingAvailableException
- getProblem() - Method in exception nz.org.riskscape.engine.bind.ParameterBindingException
-
Extends the default behaviour of getProblem to return either the problem the error was created with, or will concoct one from the message the exception was created with.
- getProblem() - Method in exception nz.org.riskscape.engine.RiskscapeException
- getProblems() - Method in interface nz.org.riskscape.engine.i18n.Messages
- getProblems() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- getProblems() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- getProblems() - Method in exception nz.org.riskscape.problem.ProblemException
- getProblems() - Method in class nz.org.riskscape.problem.ResultOrProblems
- getProblems(RealizationContext, List<Type>) - Method in class nz.org.riskscape.engine.function.ArgumentList
- getProblems(RealizationContext, List<Type>, BiFunction<FunctionArgument, Type, List<Problem>>) - Method in class nz.org.riskscape.engine.function.ArgumentList
-
Same as
ArgumentList.getProblems(RealizationContext, List)
except it lets you customize how argument/type mismatches are reported - getProblemSink() - Method in interface nz.org.riskscape.engine.Engine
-
A place for problems to go.
- getProblemSink() - Method in interface nz.org.riskscape.engine.Project
-
A place for problems to go.
- getProblemSink() - Method in interface nz.org.riskscape.engine.rl.RealizationContext
- getProduces() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- getProgressMetricNames() - Method in interface nz.org.riskscape.engine.HasMeter
- getProgressMetrics() - Method in interface nz.org.riskscape.engine.output.PipelineJobContext
-
High level metrics that can give the user an indication of how far through execution the job is
- getProgressMetrics() - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
A set of metrics that are useful to show progress to the user.
- getProject() - Method in interface nz.org.riskscape.engine.bind.BindingContext
- getProject() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- getProject() - Method in interface nz.org.riskscape.engine.rl.RealizationContext
- getProjectedType() - Method in interface nz.org.riskscape.engine.projection.FlatProjector
- getProjectedType() - Method in interface nz.org.riskscape.engine.projection.Projector
- getProjectionFunction(Struct) - Method in interface nz.org.riskscape.engine.projection.Projection
- getProperties() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
-
Returns all properties for the parameter.
- getProperties() - Method in class nz.org.riskscape.engine.model.ModelParameter
- getProperty(T) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
-
Returns the specified property, if present in the template.
- getPublicField(Class<?>, String) - Static method in class nz.org.riskscape.ReflectionUtils
-
Very simple public field lookup method that returns empty if no such field exists
- getReader(TupleWriter) - Method in interface nz.org.riskscape.engine.io.TupleStorage
- getRealizable() - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- getRealizable() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getRealizable() - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- getRealizable() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getRealizationContext() - Method in interface nz.org.riskscape.engine.bind.BindingContext
- getRealizationContext() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
-
Returns a
RealizationContext
bound to theExecutionContext
for use when realizing expressions for use within thisExecutionContext
. - getRealizationContext() - Method in interface nz.org.riskscape.engine.pipeline.RealizationInput
- getRealized(Class<T>) - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
-
Returns the realized result of this step, cast to a given type.
- getRealizedInterface(Class<? extends Realized>) - Static method in interface nz.org.riskscape.engine.pipeline.Realized
-
Utility for pulling which
Realized
sub-interface is being implemented by a class that implements realized class - getRealizedPipeline() - Method in class nz.org.riskscape.engine.pipeline.ExecutablePipeline
- getRealizedSteps() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getReason() - Method in exception nz.org.riskscape.engine.relation.InvalidTupleException
-
The specific reason why the tuple is invalid
- getReceiver() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
-
If here, this is the thing that is being accessed, e.g.
- getReference() - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
A reference to use for the job's output, usually the id of the pipeline or model being run.
- getReferences() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- getReferences() - Method in interface nz.org.riskscape.engine.IdentifiedCollection
- getRegistry() - Method in interface nz.org.riskscape.engine.HasMeter
- getRelation() - Method in exception nz.org.riskscape.engine.relation.RelationIOException
- getRelativeTo() - Method in interface nz.org.riskscape.engine.bind.BindingContext
- getRelativeTo() - Method in interface nz.org.riskscape.engine.Project
-
URI
which relative resources should be resolved against. - getRenamedParameters() - Method in class nz.org.riskscape.engine.pipeline.NamedStep
- getReplacements() - Method in class nz.org.riskscape.pipeline.ast.ParameterReplacer
-
A map of ParameterToken to Expressions that are used to rewrite expressions.
- getReprojectionTransform(int, int) - Method in class nz.org.riskscape.engine.SRIDSet
-
Get a
MathTransform
that can be used to re-project from sourceCrs to targetCrs. - getRequest() - Method in class nz.org.riskscape.engine.resource.CreateHandle
-
The original request made to save a resource
- getRequired(String) - Method in class nz.org.riskscape.engine.typeset.TypeSet
-
Deprecated.
- getRequired(String, ProblemSink) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- getRequiredArgument(FunctionCall, String) - Method in class nz.org.riskscape.engine.function.ArgumentList
- getRequiredAs(List<Type>, int, Class<T>) - Method in class nz.org.riskscape.engine.function.ArgumentList
- getResource() - Method in exception nz.org.riskscape.engine.FailedObjectException
- getResource() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- getResource() - Method in interface nz.org.riskscape.engine.Reference
- getResourceBundle() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the ResourceBundle of this command or
null
if no resource bundle is set. - getResourceFactory() - Method in interface nz.org.riskscape.engine.Engine
- getResult() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- getResult() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
-
The output of the step.
- getResult() - Method in interface nz.org.riskscape.engine.Reference
- getResult(String) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- getResult(String) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Alternative to get that returns the result wrapped in an
Optional
and aResultOrProblems
instead of throwingIdentifiedException
s. - getResultType() - Method in interface nz.org.riskscape.engine.rl.agg.RealizedAggregateExpression
-
The
Type
that this expression's accumulators emit viaAccumulator.process()
- getResultType() - Method in interface nz.org.riskscape.engine.rl.RealizedExpression
- getReturnType() - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter
- getReturnType() - Method in class nz.org.riskscape.engine.function.BinaryFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.BinaryOperatorFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.ConstantFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.FunctionMetadata
- getReturnType() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getReturnType() - Method in class nz.org.riskscape.engine.function.JavaFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.MetadataBasedFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.NullSafeFunction
- getReturnType() - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- getReturnType() - Method in class nz.org.riskscape.engine.function.UnaryFunction
- getReturnType() - Method in interface nz.org.riskscape.engine.rl.agg.AggregationFunction
-
The return type this function produces, used for help and other introspection
- getReturnType() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getReturnType() - Method in class nz.org.riskscape.engine.types.FunctionType
- getRhs() - Method in interface nz.org.riskscape.engine.join.Join
-
Expected type of the rhs of this join
- getRhs() - Method in interface nz.org.riskscape.engine.join.LopsidedJoiner
-
Expected type of the rhs of this join
- getRhs() - Method in class nz.org.riskscape.pipeline.ast.StepLink
- getRhs() - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- getRhsJavaType() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getRhsType() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- getRight() - Method in class nz.org.riskscape.engine.util.Pair
- getRootLocation() - Method in interface nz.org.riskscape.config.Config
- getSaveFormat() - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
The preferred file format that pipeline results should be saved in
- getScalarDataType() - Method in interface nz.org.riskscape.engine.coverage.TypedCoverage
- getScalarDataType() - Method in interface nz.org.riskscape.engine.data.SelfDescribingScalarData
-
Returns the RiskScape type that describes this data when extracted from a project and added in to a pipeline as a scalar value.
- getScalarDataType() - Method in interface nz.org.riskscape.engine.lookup.LookupTable
- getScalarDataType() - Method in interface nz.org.riskscape.engine.relation.Relation
- getScalarDataType(Object) - Static method in interface nz.org.riskscape.engine.data.SelfDescribingScalarData
-
Handy method that will attempt top return you a riskscape type for an object, first checking if it's self describing, then falling back to
Types.fromJavaType(Class)
- getScalarType() - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Returns the RiskScape type that represents this data when extracted from a project and added in to a pipeline or expression as a scalar value.
- getScopeType() - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
-
The scope (or input type) that was closed over when the expression that contained this lambda expression was realized
- getSection(String) - Method in interface nz.org.riskscape.config.Config
-
Look up a particular section by name, returning empty if none exists
- getSeed() - Static method in class nz.org.riskscape.engine.RandomSingleton
- getSeparator() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the String that separates option names from option values when parsing command line options.
- getSeverity() - Method in class nz.org.riskscape.problem.Problem
- getSimilarIds(String) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- getSimilarIds(String) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Find possible matches for a failed id lookup.
- getSource() - Method in class nz.org.riskscape.engine.function.FunctionMetadata
- getSource() - Method in interface nz.org.riskscape.engine.function.IdentifiedFunction
- getSource() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- getSource() - Method in class nz.org.riskscape.engine.function.JavaFunction
- getSource() - Method in class nz.org.riskscape.engine.function.MetadataBasedFunction
- getSource() - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
-
The thing that caused all the problems
- getSource() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- getSourceInformation() - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- getSourceInformation() - Method in interface nz.org.riskscape.engine.relation.Relation
- getSourcePath() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
-
The location on the filesystem where this plugin's resources are located
- getSourceType() - Method in interface nz.org.riskscape.engine.pipeline.Collector
-
The type of tuple this collector accepts.
- getSourceType() - Method in interface nz.org.riskscape.engine.pipeline.StreamingCollector
-
The type of tuple this collector accepts.
- getSourceType() - Method in interface nz.org.riskscape.engine.projection.FlatProjector
- getSourceType() - Method in interface nz.org.riskscape.engine.projection.Projector
-
The exact
Struct
object that is expected to be seen by theFunction.apply(java.lang.Object)
- getSourceType() - Method in class nz.org.riskscape.engine.restriction.DefaultRestrictor
- getSourceType() - Method in interface nz.org.riskscape.engine.restriction.Restrictor
-
The exact
Struct
that Tuple's passed toPredicate.test(java.lang.Object)
should be of. - getSourceType() - Method in interface nz.org.riskscape.engine.types.eqrule.Coercer
- getSpatialMetadata() - Method in interface nz.org.riskscape.engine.relation.Relation
- getSpatialMetadataMapper() - Method in interface nz.org.riskscape.engine.projection.Projector
-
An optional function used for transforming spatial metadata from source to target.
- getSridSet() - Method in interface nz.org.riskscape.engine.Project
- getStartOfLine() - Method in class nz.org.riskscape.dsl.Token
- getStartSteps() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getStartSteps() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getState() - Method in interface nz.org.riskscape.engine.pipeline.NestedPipelineStep
- getStep() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
-
The
Step
that produced a realized output that went in to thisRealizedStep
- getStep() - Method in exception nz.org.riskscape.engine.pipeline.StepAlreadyAddedException
- getStep() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- getStep() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- getStep(String) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getStep(String) - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- getStepCapper() - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
A function to use for applying a
Sink
to any terminal steps that are not themselves sinks. - getStepId() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- getStepIdToken() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- getStepName() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- getStepNameFunction(PipelineDeclaration) - Method in interface nz.org.riskscape.pipeline.StepNamingPolicy
- getStepNameFunction(StepNamingPolicy) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- getStepParameters() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- getSteps() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getSteps() - Method in class nz.org.riskscape.pipeline.ast.StepChain
- getStepsRequiringInput() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- getStepType() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- getStore() - Method in interface nz.org.riskscape.engine.output.PipelineOutputContainer
- getStoredAt() - Method in interface nz.org.riskscape.engine.output.PipelineOutputContainer
-
Returns a URI that describes where the outputs are stored.
- getStoredAt() - Method in class nz.org.riskscape.engine.output.RiskscapeWriter
- getStoreForURI(URI) - Method in interface nz.org.riskscape.engine.output.PipelineOutputStores
-
Find a store capable of writing to the given URI
- getString(String, String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns the String value found in the resource bundle for the specified key, or the specified default value if not found.
- getStringArray(String, String[]) - Method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns the String array value found in the resource bundle for the specified key, or the specified default value if not found.
- getStruct() - Method in exception nz.org.riskscape.engine.NoSuchMemberException
- getStruct() - Method in class nz.org.riskscape.engine.Tuple
-
The struct defines the shape of the data - the attribute keys and what RiskScape
Type
they are. - getStyledChars(int, int, CommandLine.Help.Ansi.Text, int) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Copies the specified substring of this Text into the specified destination, preserving the markup.
- getSubcommands() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns a map with the subcommands registered on this instance.
- getSubPipelineParameter() - Method in interface nz.org.riskscape.engine.pipeline.NestedPipelineStep
- getSuggestions() - Method in exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
-
Returns suggested solutions if such solutions exist, otherwise returns an empty list.
- getSupportedFormats() - Method in interface nz.org.riskscape.engine.data.BookmarkResolvers
- getTarget() - Method in class nz.org.riskscape.engine.function.NullSafeFunction
- getTarget() - Method in class nz.org.riskscape.engine.pipeline.NamedStep
-
The implementation of the step - this is the thing that can actually operate on the tuples that pass through this part of the pipeline
- getTarget() - Method in exception nz.org.riskscape.engine.resource.ResourceLoadingException
- getTargetType() - Method in interface nz.org.riskscape.engine.pipeline.Collector
-
The type of tuple this collector produces
- getTargetType() - Method in interface nz.org.riskscape.engine.pipeline.StreamingCollector
-
The type of tuple this collector produces
- getTargetType() - Method in interface nz.org.riskscape.engine.types.eqrule.Coercer
- getTempDirectory() - Method in interface nz.org.riskscape.engine.bind.BindingContext
- getTempDirectory() - Method in interface nz.org.riskscape.engine.Engine
- getTempDirectory() - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
- getTempDirectory() - Method in class nz.org.riskscape.engine.resource.Resource.Options
-
A directory to use for storing any temporary files that are created.
- getTemplate() - Method in interface nz.org.riskscape.engine.bind.UserDefinedParameter
- getTemplate() - Method in class nz.org.riskscape.engine.model.ModelParameter
- getter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the
CommandLine.Model.IGetter
that is responsible for supplying the value of the annotated program element associated with this group. - getter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the
CommandLine.Model.IGetter
that is responsible for supplying the value of the annotated program element associated with this group. - getter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the
CommandLine.Model.IGetter
that is responsible for supplying the value of this argument. - getter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the
CommandLine.Model.IGetter
that is responsible for supplying the value of this argument. - getter() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- getter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UnmatchedArgsBinding
-
Returns the getter responsible for producing a
Collection
that the unmatched arguments can be added to. - getter(CommandLine.Model.IGetter) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the
CommandLine.Model.IGetter
that is responsible for getting the value of the annotated program element associated with this group, and returns this builder. - getter(CommandLine.Model.IGetter) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the
CommandLine.Model.IGetter
that is responsible for getting the value of this argument, and returns this builder. - getTerminal() - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
- getTo() - Method in exception nz.org.riskscape.engine.bind.NoBindingAvailableException
- getToken() - Method in class nz.org.riskscape.rl.ast.Constant
- getToken() - Method in class nz.org.riskscape.rl.ast.ParameterToken
- getToken() - Method in class nz.org.riskscape.rl.ast.SelectAllExpression
- getToString() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- getTuple() - Method in exception nz.org.riskscape.engine.relation.InvalidTupleException
- getTupleStorage() - Method in interface nz.org.riskscape.engine.Engine
-
A place for parts of the engine to use for storage
- getType() - Method in class nz.org.riskscape.engine.bind.Parameter
- getType() - Method in class nz.org.riskscape.engine.coverage.TypedCoverage.Empty
- getType() - Method in interface nz.org.riskscape.engine.coverage.TypedCoverage
- getType() - Method in class nz.org.riskscape.engine.function.FunctionArgument
- getType() - Method in class nz.org.riskscape.engine.output.SinkParameters
-
The type of the data that the sink is going to receive via
Sink.accept(nz.org.riskscape.engine.Tuple)
. - getType() - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- getType() - Method in interface nz.org.riskscape.engine.relation.Relation
- getType() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
-
The resulting ancestor type
- getType() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
-
Contained type of the list, not the list type itself (although it could be a list, if you have a list of lists...)
- getType() - Method in exception nz.org.riskscape.engine.types.CoercionException
-
The type that the value failed to be converted in to
- getType() - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- getType() - Method in class nz.org.riskscape.engine.types.Value
-
The type that represents
Value.getValue()
- getType() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
-
Returns the class that the option or parameter value should be converted to when matched on the command line.
- getType() - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- getType(String) - Method in class nz.org.riskscape.engine.Tuple
-
Shortcut for accessing the type of a member
- getTypeBuilder() - Method in interface nz.org.riskscape.engine.Project
- getTypeClass() - Method in class nz.org.riskscape.engine.types.TypeInformation
-
The exact type that results from
TypeConstructor
will be of. - getTypeInfo() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- getTypeInformation(Class<? extends SimpleType>) - Static method in class nz.org.riskscape.engine.types.SimpleType
- getTypeInformationDescription() - Method in class nz.org.riskscape.engine.types.Anything
- getTypeInformationDescription() - Method in class nz.org.riskscape.engine.types.SimpleType
- getTypeInformationId() - Method in class nz.org.riskscape.engine.types.Bool
- getTypeInformationId() - Method in class nz.org.riskscape.engine.types.Date
- getTypeInformationId() - Method in class nz.org.riskscape.engine.types.Geom
- getTypeInformationId() - Method in class nz.org.riskscape.engine.types.SimpleType
- getTypeIOConstructor() - Method in class nz.org.riskscape.engine.types.TypeInformation
-
An optional
TypeIOConstructor
that can return/buildTypeIO
objects for a particular type. - getTypeName() - Method in class nz.org.riskscape.engine.bind.Parameter
- getTypeRegistry() - Method in interface nz.org.riskscape.engine.Engine
- getTypeRegistry() - Method in class nz.org.riskscape.engine.typeset.TypeSet
- getTypeSet() - Method in class nz.org.riskscape.engine.function.FunctionContext
-
Get the typeSet that will be in use for the project.
- getTypeSet() - Method in interface nz.org.riskscape.engine.Project
- getTypeSet() - Method in interface nz.org.riskscape.engine.rl.RealizationContext
-
Access to the
TypeSet
for this context (via the project) - getTypeSet() - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- getTypeSet() - Method in class nz.org.riskscape.engine.typeset.LinkedType
- getTypeSet() - Method in interface nz.org.riskscape.engine.typexp.TypeBuilder
-
A type set to use for referring to user-defined
LinkedType
s - getTypesFromArguments() - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- getUnbound() - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
The original, given values that were bound.
- getUnboundParameters() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Unbound parameters, can be set with pipeline default values.
- getUnderlyingProblems() - Method in exception nz.org.riskscape.problem.ResultComputationException
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.EmptyList
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.GeomType
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.MultiGeom
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.OfUnit
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.Referenced
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.WithinRange
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.WithinSet
- getUnderlyingType() - Method in class nz.org.riskscape.engine.types.WithMetadata
- getUnderlyingType() - Method in interface nz.org.riskscape.engine.types.WrappingType
- getUnderlyingType() - Method in class nz.org.riskscape.engine.typeset.CanonicalType
- getUnderlyingType() - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- getUnderlyingType() - Method in class nz.org.riskscape.engine.typeset.LinkedType
- getUnit() - Method in class nz.org.riskscape.engine.types.OfUnit
- getUnmatched() - Method in exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
-
Returns the unmatched command line arguments.
- getUnmatchedArguments() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the list of unmatched command line arguments, if any.
- getUnparsed() - Method in class nz.org.riskscape.engine.data.Bookmark
-
Contains extra, unparsed, keys and values from the bookmark definition that a particular resolver can make use of
- getUnwrappedType() - Method in interface nz.org.riskscape.engine.types.Type
- getUsageHelpWidth() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns the maximum width of the usage help message.
- getUsageMessage() - Method in class nz.org.riskscape.picocli.CommandLine
-
Similar to
CommandLine.usage(PrintStream)
, but returns the usage help message as a String instead of printing it to thePrintStream
. - getUsageMessage(CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine
-
Similar to
CommandLine.usage(PrintStream, Help.Ansi)
, but returns the usage help message as a String instead of printing it to thePrintStream
. - getUsageMessage(CommandLine.Help.ColorScheme) - Method in class nz.org.riskscape.picocli.CommandLine
-
Similar to
CommandLine.usage(PrintStream, Help.ColorScheme)
, but returns the usage help message as a String instead of printing it to thePrintStream
. - getValidation() - Method in class nz.org.riskscape.engine.bind.Parameter
- getValidationPostReproject() - Method in class nz.org.riskscape.engine.SRIDSet
-
Controls if geometries should be validated after a re-projection and what to do if they have become invalid.
- getValidationProblems() - Method in class nz.org.riskscape.engine.bind.BoundParameters
- getValue() - Method in class nz.org.riskscape.dsl.Token
- getValue() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate.Choice
- getValue() - Method in class nz.org.riskscape.engine.pipeline.DefaultCollection
- getValue() - Method in exception nz.org.riskscape.engine.types.CoercionException
-
The value that failed to be coerced to a type
- getValue() - Method in class nz.org.riskscape.engine.types.Value
-
The underlying value, matches
Value.getType()
. - getValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the current value of this argument.
- getValue() - Method in exception nz.org.riskscape.picocli.CommandLine.ParameterException
-
Returns the
String
value for the (sub)command whose input could not be parsed. - getValue() - Method in class nz.org.riskscape.rl.ast.ParameterToken
- getValue(String) - Method in class nz.org.riskscape.engine.bind.BoundParameters
- getValue(BoundParameters) - Method in class nz.org.riskscape.engine.model.ModelParameter
- getValueMap() - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
The bound, valid, values that correspond to the
BoundParameters.boundTo
parameter set. - getValueOr() - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
- getValues() - Method in class nz.org.riskscape.engine.Tuple
- getValues() - Method in class nz.org.riskscape.engine.types.Enumeration
- getValues(String) - Method in class nz.org.riskscape.engine.bind.BoundParameters
- getValueType() - Method in interface nz.org.riskscape.engine.lookup.LookupTable
- getValueType() - Method in class nz.org.riskscape.engine.types.LookupTableType
- getValueType() - Method in class nz.org.riskscape.engine.types.TypeInformation
-
The java type that is used to hold values that conform to this type.
- getVarianceRules() - Method in class nz.org.riskscape.engine.types.TypeRegistry
- getVersion() - Method in class nz.org.riskscape.engine.BuildInfo
- getVersion() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
- getVersion() - Method in interface nz.org.riskscape.picocli.CommandLine.IVersionProvider
-
Returns version information for a command.
- getWithProblemsIgnored() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- getWithProblemsIgnored() - Method in class nz.org.riskscape.problem.ResultOrProblems
- getWrappedClass() - Method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
- getWrappedFunction() - Method in class nz.org.riskscape.engine.function.agg.AddAggregationFunction
- getWriterConstructor() - Method in interface nz.org.riskscape.engine.output.Format
-
Get a
WriterConstructor
to create an output writer with. - GLOBAL_TYPE_SET - Static variable in class nz.org.riskscape.engine.typeset.TypeSet
-
A jvm-global type set, only use with extreme prejudice
- GREATER_THAN - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- GREATER_THAN_EQUAL - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- group() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the groups this option or positional parameter belongs to, or
null
if this option is not part of a group. - group() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatch
-
Returns the
ArgGroupSpec
of the containerGroupMatchContainer
of this match. - group() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatchContainer
-
Returns the
ArgGroupSpec
whose matches are captured in thisGroupMatchContainer
.
H
- handle(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractParseResultHandler
-
Deprecated.Processes the specified
ParseResult
and returns the result as a list of objects. - handle(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.RunAll
-
Executes the top-level command and all subcommands as
Runnable
orCallable
. - handle(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.RunFirst
-
Executes the top-level
Runnable
orCallable
subcommand. - handle(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.RunLast
-
Executes the most specific
Runnable
orCallable
subcommand. - Handle(String, Resource, ConstructionCallback<T>) - Constructor for class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in class nz.org.riskscape.picocli.CommandLine.DefaultExceptionHandler
-
Deprecated.
- handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in interface nz.org.riskscape.picocli.CommandLine.IExceptionHandler
-
Deprecated.Handles a
ParameterException
that occurred while parsing the command line arguments and optionally returns a list of results. - handleExecutionException(Exception, CommandLine, CommandLine.ParseResult) - Method in interface nz.org.riskscape.picocli.CommandLine.IExecutionExceptionHandler
-
Handles an
Exception
that occurred while executing theRunnable
orCallable
command and returns an exit code suitable for returning fromCommandLine.execute(String...)
. - handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.DefaultExceptionHandler
-
Deprecated.This implementation always simply rethrows the specified exception.
- handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in interface nz.org.riskscape.picocli.CommandLine.IExceptionHandler2
-
Deprecated.Handles a
ExecutionException
that occurred while executing theRunnable
orCallable
command and optionally returns a list of results. - handleInterrupt() - Method in interface nz.org.riskscape.cli.InterruptHandler
- handleParseException(CommandLine.ParameterException, String[]) - Method in class nz.org.riskscape.picocli.CommandLine.DefaultExceptionHandler
-
Deprecated.Prints the message of the specified exception, followed by the usage message for the command or subcommand whose input was invalid, to the stream returned by
CommandLine.AbstractHandler.err()
. - handleParseException(CommandLine.ParameterException, String[]) - Method in interface nz.org.riskscape.picocli.CommandLine.IExceptionHandler2
-
Deprecated.Handles a
ParameterException
that occurred while parsing the command line arguments and optionally returns a list of results. - handleParseException(CommandLine.ParameterException, String[]) - Method in interface nz.org.riskscape.picocli.CommandLine.IParameterExceptionHandler
-
Handles a
ParameterException
that occurred while parsing the command line arguments and returns an exit code suitable for returning fromCommandLine.execute(String...)
. - handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in interface nz.org.riskscape.picocli.CommandLine.IParseResultHandler
-
Deprecated.Processes a List of
CommandLine
objects resulting from successfully parsing the command line arguments and optionally returns a list of results. - handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine.RunAll
-
Prints help if requested, and otherwise executes the top-level command and all subcommands as
Runnable
,Callable
orMethod
. - handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine.RunFirst
-
Prints help if requested, and otherwise executes the top-level
Runnable
orCallable
command. - handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine.RunLast
-
Prints help if requested, and otherwise executes the most specific
Runnable
orCallable
subcommand. - handleParseResult(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractParseResultHandler
-
Deprecated.Prints help if requested, and otherwise calls
CommandLine.AbstractParseResultHandler.handle(CommandLine.ParseResult)
. - handleParseResult(CommandLine.ParseResult) - Method in interface nz.org.riskscape.picocli.CommandLine.IParseResultHandler2
-
Deprecated.Processes the
ParseResult
object resulting from successfully parsing the command line arguments and returns a return value. - hasArgument(String) - Method in class nz.org.riskscape.engine.function.ArgumentList
- hasChildPipeline() - Method in interface nz.org.riskscape.engine.join.LopsidedJoiner
- hasChildren() - Method in class nz.org.riskscape.problem.Problem
- hasCollectionOf(Class<? extends Identified>) - Method in interface nz.org.riskscape.engine.IdentifiedLocator
- hasCorrectArity(int) - Method in class nz.org.riskscape.engine.bind.Parameter
- hasDefaultProblem() - Method in exception nz.org.riskscape.dsl.UnexpectedTokenException
- hasDefaultValue() - Method in class nz.org.riskscape.engine.bind.Parameter
- hasDependencies() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- hasDependents() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- hasErrors() - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Shortcut for
hasProblems(Severity.ERROR)
- hasErrors(Collection<? extends Problem>) - Static method in class nz.org.riskscape.problem.Problem
- hasExitCode() - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Returns
true
if an exit code was set withCommandLine.AbstractHandler.andExit(int)
, orfalse
(the default) if the handler should not callSystem.exit(int)
after processing completes. - hasFailures() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- hasGeometryMember(Struct) - Static method in class nz.org.riskscape.engine.query.TupleUtils
-
Convenience version to check if the struct has a geometry member
- hashCode() - Method in class nz.org.riskscape.dsl.ConditionalParse
- hashCode() - Method in class nz.org.riskscape.dsl.Token
- hashCode() - Method in class nz.org.riskscape.dsl.Token.Location
- hashCode() - Method in class nz.org.riskscape.engine.bind.BoundParameters
- hashCode() - Method in class nz.org.riskscape.engine.bind.Parameter
- hashCode() - Method in class nz.org.riskscape.engine.bind.ParameterSet
- hashCode() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate.Choice
- hashCode() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- hashCode() - Method in class nz.org.riskscape.engine.BuildInfo
- hashCode() - Method in class nz.org.riskscape.engine.data.Bookmark
- hashCode() - Method in class nz.org.riskscape.engine.function.FunctionArgument
- hashCode() - Method in class nz.org.riskscape.engine.i18n.HasMessages
- hashCode() - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
- hashCode() - Method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
- hashCode() - Method in class nz.org.riskscape.engine.i18n.TranslationContext
- hashCode() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- hashCode() - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
- hashCode() - Method in class nz.org.riskscape.engine.output.SinkParameters
- hashCode() - Method in class nz.org.riskscape.engine.pipeline.Edge
- hashCode() - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
- hashCode() - Method in class nz.org.riskscape.engine.pipeline.ExecutionResult
- hashCode() - Method in class nz.org.riskscape.engine.pipeline.NamedStep
- hashCode() - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- hashCode() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- hashCode() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- hashCode() - Method in class nz.org.riskscape.engine.problem.ProblemFactoryProxy.JavaMethodCode
- hashCode() - Method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
- hashCode() - Method in class nz.org.riskscape.engine.resource.CreateHandle
- hashCode() - Method in class nz.org.riskscape.engine.resource.CreateRequest
- hashCode() - Method in class nz.org.riskscape.engine.resource.Resource.Options
- hashCode() - Method in class nz.org.riskscape.engine.resource.Resource.PseudoResource
- hashCode() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- hashCode() - Method in class nz.org.riskscape.engine.sort.SortBy
- hashCode() - Method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- hashCode() - Method in class nz.org.riskscape.engine.Tuple
- hashCode() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
- hashCode() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- hashCode() - Method in class nz.org.riskscape.engine.types.CoverageType
- hashCode() - Method in class nz.org.riskscape.engine.types.Enumeration
- hashCode() - Method in class nz.org.riskscape.engine.types.LambdaType
- hashCode() - Method in class nz.org.riskscape.engine.types.LookupTableType
- hashCode() - Method in class nz.org.riskscape.engine.types.Nullable
- hashCode() - Method in class nz.org.riskscape.engine.types.Referenced
- hashCode() - Method in class nz.org.riskscape.engine.types.RelationType
- hashCode() - Method in class nz.org.riskscape.engine.types.RSList
- hashCode() - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- hashCode() - Method in class nz.org.riskscape.engine.types.SimpleType
- hashCode() - Method in class nz.org.riskscape.engine.types.Struct
- hashCode() - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- hashCode() - Method in class nz.org.riskscape.engine.types.Value
- hashCode() - Method in class nz.org.riskscape.engine.types.WithinRange
- hashCode() - Method in class nz.org.riskscape.engine.types.WithinSet
- hashCode() - Method in class nz.org.riskscape.engine.types.WithMetadata
- hashCode() - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- hashCode() - Method in class nz.org.riskscape.engine.util.Pair
- hashCode() - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
- hashCode() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
- hashCode() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
- hashCode() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- hashCode() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
- hashCode() - Method in class nz.org.riskscape.picocli.CommandLine.Range
- hashCode() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- hashCode() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- hashCode() - Method in class nz.org.riskscape.pipeline.ast.StepChain
- hashCode() - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
- hashCode() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- hashCode() - Method in class nz.org.riskscape.pipeline.ast.StepLink
- hashCode() - Method in class nz.org.riskscape.pipeline.ast.StepReference
- hashCode() - Method in class nz.org.riskscape.pipeline.PipelineMetadata
- hashCode() - Method in class nz.org.riskscape.problem.Problem
- hashCode() - Method in class nz.org.riskscape.problem.ResultOrProblems
- hashCode() - Method in class nz.org.riskscape.rl.ast.BinaryOperation
- hashCode() - Method in class nz.org.riskscape.rl.ast.BracketedExpression
- hashCode() - Method in class nz.org.riskscape.rl.ast.Constant
- hashCode() - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- hashCode() - Method in class nz.org.riskscape.rl.ast.FunctionCall
- hashCode() - Method in class nz.org.riskscape.rl.ast.Lambda
- hashCode() - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- hashCode() - Method in class nz.org.riskscape.rl.ast.ParameterToken
- hashCode() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- hashCode() - Method in class nz.org.riskscape.rl.ast.SelectAllExpression
- hashCode() - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- hashCode() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- hashCodeImpl() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
- hasInitialValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Determines whether the option or positional parameter will be reset to the
CommandLine.Model.ArgSpec.Builder.initialValue()
before parsing new input. - hasInitialValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Determines whether the option or positional parameter will be reset to the
CommandLine.Model.ArgSpec.initialValue()
before parsing new input. - hasInitialValue() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- hasInitialValue(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Determines whether the option or positional parameter will be reset to the
CommandLine.Model.ArgSpec.Builder.initialValue()
before parsing new input. - hasKey(String) - Method in interface nz.org.riskscape.config.ConfigSection
- hasKeyValuePair() - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
- hasKeyword() - Method in class nz.org.riskscape.engine.function.FunctionArgument
- hasKeywordArguments() - Method in class nz.org.riskscape.rl.ast.FunctionCall
- hasMatchedOption(char) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns whether an option whose aliases include the specified short name was matched on the command line.
- hasMatchedOption(String) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns whether an option whose aliases include the specified name was matched on the command line.
- hasMatchedOption(CommandLine.Model.OptionSpec) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns whether the specified option was matched on the command line.
- hasMatchedPositional(int) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns whether a positional parameter was matched at the specified position.
- hasMatchedPositional(CommandLine.Model.PositionalParamSpec) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns whether the specified positional parameter was matched on the command line.
- hasMember(String) - Method in class nz.org.riskscape.engine.types.Struct
- HasMessages - Class in nz.org.riskscape.engine.i18n
-
Feature interface for plugins to indicate they have i18n message bundles on their classpath.
- HasMessages(String) - Constructor for class nz.org.riskscape.engine.i18n.HasMessages
- HasMeter - Interface in nz.org.riskscape.engine
-
Interface that may be added to
Realized
implementations should they have specific metrics. - hasNamedInput(String) - Method in interface nz.org.riskscape.engine.pipeline.Step
- hasNext() - Method in class nz.org.riskscape.engine.relation.Singleton
- hasNoDependencies() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- hasNoDependents() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- hasNulls() - Method in class nz.org.riskscape.engine.Tuple
- hasPluginDependencies() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
- hasProblem() - Method in exception nz.org.riskscape.engine.RiskscapeException
- hasProblems() - Method in class nz.org.riskscape.problem.ResultOrProblems
- hasProblems(Problem.Severity) - Method in class nz.org.riskscape.problem.ResultOrProblems
- hasProperty(ParameterProperty) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- hasRequiredNulls() - Method in class nz.org.riskscape.engine.Tuple
- hasSkipOnInvalid() - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- hasSkipOnInvalid() - Method in interface nz.org.riskscape.engine.relation.Relation
- hasStep(String) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
- hasSubcommand() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns
true
if a subcommand was matched on the command line,false
otherwise. - hasValidationErrors() - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
- header() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Optional summary description of the command, shown before the synopsis.
- header() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional header lines displayed at the top of the help message.
- header(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the command header text as a string.
- header(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional header lines displayed at the top of the help message.
- headerHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the header section.
- headerHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the header section.
- headerHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the header text; the result of
String.format(headerHeading, params)
. - headerHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the heading preceding the header section.
- heading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.ArgGroup
-
The heading of this group, used when generating the usage documentation.
- heading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the heading of this group, used when generating the usage documentation.
- heading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the heading of this group (may be
null
), used when generating the usage documentation. - heading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the heading of this group (may be
null
), used when generating the usage documentation. - headingKey() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.ArgGroup
-
ResourceBundle key for this group's usage help message section heading.
- headingKey() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the heading key of this group, used to get the heading from a resource bundle.
- headingKey() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the heading key of this group (may be
null
), used to get the heading from a resource bundle. - headingKey(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the heading key of this group, used to get the heading from a resource bundle.
- help() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Deprecated.
- help() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Deprecated.
- help() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Deprecated.
- help(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Sets whether this option disables validation of the other arguments, and returns this builder.
- Help(Object) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help
-
Constructs a new
Help
instance with a default color scheme, initialized from annotatations on the specified class and superclasses. - Help(Object, CommandLine.Help.Ansi) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help
-
Constructs a new
Help
instance with a default color scheme, initialized from annotatations on the specified class and superclasses. - Help(Object, CommandLine.Help.ColorScheme) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help
-
Deprecated.use
picocli.CommandLine.Help#Help(picocli.CommandLine.Model.CommandSpec, picocli.CommandLine.Help.ColorScheme)
- Help(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help
-
Constructs a new
Help
instance with the specified color scheme, initialized from annotatations on the specified class and superclasses. - helpCommand() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set this attribute to
true
if this subcommand is a help command, and required options and positional parameters of the parent command should not be validated. - helpCommand() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns whether this subcommand is a help command, and required options and positional parameters of the parent command should not be validated.
- helpCommand(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets whether this is a help command and required parameter checking should be suspended.
- HelpCommand() - Constructor for class nz.org.riskscape.picocli.CommandLine.HelpCommand
- helpFactory() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the
IHelpFactory
that is used to construct the usage help message. - helpFactory(CommandLine.IHelpFactory) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets a new
IHelpFactory
to customize the usage help message. - hidden() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set
hidden=true
if this command should not be included in the list of commands in the usage help of the parent command. - hidden() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns whether this option should be excluded from the usage message.
- hidden() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns whether this option should be excluded from the usage message.
- hidden() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns whether this command should be hidden from the usage help message of the parent command.
- hidden() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Set
hidden=true
if this option should not be included in the usage help message. - hidden() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Set
hidden=true
if this parameter should not be included in the usage message. - hidden(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets whether this option should be excluded from the usage message, and returns this builder.
- hidden(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.
- hideParamSyntax() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns whether usage syntax decorations around the paramLabel should be suppressed.
- hideParamSyntax() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns whether usage syntax decorations around the paramLabel should be suppressed.
- hideParamSyntax() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Returns whether usage syntax decorations around the paramLabel should be suppressed.
- hideParamSyntax() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Returns whether usage syntax decorations around the paramLabel should be suppressed.
- hideParamSyntax(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets whether usage syntax decorations around the paramLabel should be suppressed.
- host - Variable in class nz.org.riskscape.engine.pipeline.Manifest.LocalInfo
I
- id(String) - Method in class nz.org.riskscape.engine.data.Bookmark.BookmarkBuilder
- ID_PATTERN - Static variable in class nz.org.riskscape.engine.function.JavaFunction
-
REGEX pattern for valid ID's.
- ident() - Method in class nz.org.riskscape.engine.typexp.AST.ComplexType
- ident() - Method in class nz.org.riskscape.engine.typexp.AST.Symbol
-
The identifier for this symbol
- identified(String) - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- identified(String, String, String, IdentifiedFunction.Category) - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- identified(RealizableFunction, FunctionMetadata) - Static method in interface nz.org.riskscape.engine.rl.RealizableFunction
-
Build an IdentifiedFunction from a RealizableFunction and some FunctionMetadata.
- Identified - Interface in nz.org.riskscape.engine
-
Object that as an identifier.
- IdentifiedCollection<T extends Identified> - Interface in nz.org.riskscape.engine
-
A collection of
Identified
objects. - IdentifiedCollection.Base<T extends Identified> - Class in nz.org.riskscape.engine
-
Convenience class for any
IdentifiedCollection
s that want to work from an in-memory set of objects. - IdentifiedCollection.Base.Handle - Class in nz.org.riskscape.engine
- IdentifiedException - Exception in nz.org.riskscape.engine
-
Thrown by an
IdentifiedCollection
when there was some issue with adding or getting an object from the collection. - IdentifiedException(Class<?>, Problem) - Constructor for exception nz.org.riskscape.engine.IdentifiedException
- IdentifiedFunction - Interface in nz.org.riskscape.engine.function
-
A
RiskscapeFunction
that is identified by itsIdentified.getId()
. - IdentifiedFunction.Category - Enum Class in nz.org.riskscape.engine.function
- IdentifiedFunction.Wrapping - Class in nz.org.riskscape.engine.function
- IdentifiedLocator - Interface in nz.org.riskscape.engine
-
An IdentifiedLocator is a service locator style API that allows an IdentifiedCollection to be looked up by the class the collection contains, e.g.
- IdentifiedModel - Interface in nz.org.riskscape.engine.model
- IdentifiedType - Class in nz.org.riskscape.engine.typeset
-
Wraps a type to include an identifier and a
TypeSet
to link it back to some managed and identified set of types among a set. - IdentifiedType(String) - Constructor for class nz.org.riskscape.engine.typeset.IdentifiedType
- IDENTIFIER - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- IDENTIFIER_PATTERN - Static variable in enum class nz.org.riskscape.rl.TokenTypes
-
The regex used for matching
TokenTypes.IDENTIFIER
tokens - used for quoting methods. - IDENTIFIERS - Static variable in class nz.org.riskscape.rl.ExpressionParser
-
Used with
ConditionalParse
- identity(Type) - Static method in interface nz.org.riskscape.engine.types.eqrule.Coercer
- IDENTITY - Static variable in interface nz.org.riskscape.engine.projection.Projection
-
The identity projection is like no projection - just returns self
- IDENTITY - Static variable in class nz.org.riskscape.engine.types.ancestor.AncestorType
-
No conversion
- IDENTITY - Static variable in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- identityMapping(Struct) - Static method in interface nz.org.riskscape.engine.projection.Projector
- identToken - Variable in class nz.org.riskscape.pipeline.ast.StepDeclaration
-
The first identifier that starts this step declaration.
- identToken(String) - Static method in enum class nz.org.riskscape.rl.TokenTypes
- ifElse(Consumer<T>, Consumer<List<Problem>>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Call the given consumer function with the result, only if result is set, else call the consumer
- ifElseReturn(Function<T, U>, Consumer<List<Problem>>, U) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Call the given consumer function with the result, only if result is set, else call the consumer
- ifElseReturn(Function<T, U>, Function<List<Problem>, U>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Call the given consumer function with the result, only if result is set, else call the consumer
- ifPresent(Consumer<T>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Call the given consumer function with the result, only if result is set
- ifProblems(Function<List<Problem>, U>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Call the given function if there were any problems with this
ResultOrProblems
, returning whatever the function returned. - ifTrue(boolean, Type) - Static method in class nz.org.riskscape.engine.types.Nullable
- ignored(String) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
A parameter was given, but it was ignored.
- ignoredWithHints(Set<String>, Set<String>) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
A parameter was given, but it was ignored.
- ignoreThis() - Method in interface nz.org.riskscape.engine.function.OverloadedFunction
- implies(ParameterProperty) - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
- INCONSISTENT_INDENT - Enum constant in enum class nz.org.riskscape.dsl.ProblemCodes
- InconsistentIndentException - Exception in nz.org.riskscape.dsl
- InconsistentIndentException(Token, Token) - Constructor for exception nz.org.riskscape.dsl.InconsistentIndentException
- indent - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem.ToStringOptions
-
Applied after
prefixAll
and beforeprefixChildren
indentLevel
times. - indent - Variable in class nz.org.riskscape.picocli.CommandLine.Help.Column
-
Indent (number of empty spaces at the start of the column preceding the text value)
- indentLevel - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem
-
The number of ancestors this problem has
- indentWrappedLines - Variable in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
By default, indent wrapped lines by 2 spaces.
- index() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns an index or range specifying which of the command line arguments should be assigned to this positional parameter.
- index() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
-
Returns an index or range specifying which of the command line arguments should be assigned to this positional parameter.
- index() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Specify an index ("0", or "1", etc.) to pick which of the command line arguments should be assigned to this field.
- index(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.
- index(CommandLine.Range) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.
- INDEX - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- indexOfArgNamed(String) - Method in class nz.org.riskscape.rl.ast.FunctionCall
- info(String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- INFO - Enum constant in enum class nz.org.riskscape.problem.Problem.Severity
- infoOutput() - Method in interface nz.org.riskscape.engine.function.IdentifiedFunction
-
Get information about this function.
- init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream) - Method in class nz.org.riskscape.picocli.CommandLine.HelpCommand
-
Deprecated.
- init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream) - Method in interface nz.org.riskscape.picocli.CommandLine.IHelpCommandInitializable
-
Deprecated.
- init(CommandLine, CommandLine.Help.ColorScheme, PrintWriter, PrintWriter) - Method in class nz.org.riskscape.picocli.CommandLine.HelpCommand
-
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
- init(CommandLine, CommandLine.Help.ColorScheme, PrintWriter, PrintWriter) - Method in interface nz.org.riskscape.picocli.CommandLine.IHelpCommandInitializable2
-
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
- InitializationException(String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.InitializationException
- InitializationException(String, Exception) - Constructor for exception nz.org.riskscape.picocli.CommandLine.InitializationException
- initializeEngine(Engine) - Method in class nz.org.riskscape.engine.plugin.Plugin
-
Initialize the
Engine
with any services that are provided by this Plugin. - initializeEngine(Engine, ProblemSink) - Method in class nz.org.riskscape.engine.plugin.Plugin
-
Initialize the
Engine
with any services that are provided by this Plugin. - initializeProject(Project, Engine) - Method in class nz.org.riskscape.engine.plugin.Plugin
-
Fill a
Project
with goodies, usually by scanning through the Project's Config. - initialValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the initial value this option or positional parameter.
- initialValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the initial value this option or positional parameter.
- initialValue(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the initial value of this option or positional parameter to the specified value, and returns this builder.
- INNER - Enum constant in enum class nz.org.riskscape.engine.join.JoinType
-
https://en.wikipedia.org/wiki/Join(SQL)#Innerjoin
- INPUT_ALREADY_CHAINED - Enum constant in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Attempt to chain to a named input that has already been chained to
- InputDataProblems - Interface in nz.org.riskscape.engine.data
-
Problems relating to one of the user's input data sources.
- insecureNotAllowed(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceProblems
- insertFirst(OperatorResolver) - Method in interface nz.org.riskscape.engine.FunctionSet
- insertLast(OperatorResolver) - Method in interface nz.org.riskscape.engine.FunctionSet
- insertSynopsisCommandName(int, CommandLine.Help.Ansi.Text) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the detailed synopsis text by inserting the command name before the specified text with options and positional parameters details.
- INSTANCE - Static variable in class nz.org.riskscape.engine.pipeline.NullStep
- INSTANCE - Static variable in class nz.org.riskscape.engine.types.EmptyList
-
The one and only instance of an EmptyList type
- INSTANCE - Static variable in class nz.org.riskscape.pipeline.PipelineParser
- INSTANCE - Static variable in class nz.org.riskscape.rl.ExpressionParser
- integer(long) - Static method in class nz.org.riskscape.rl.ast.Constant
-
Handy testing constructor to create a long "integer" constant
- Integer - Class in nz.org.riskscape.engine.types
-
Permissive Integer type that will convert any
Number
in to an long integer viaNumber.longValue()
. - Integer() - Constructor for class nz.org.riskscape.engine.types.Integer
- INTEGER - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- INTEGER - Static variable in class nz.org.riskscape.engine.types.Nullable
- INTEGER - Static variable in class nz.org.riskscape.engine.types.Types
- IntegerToFloatingRule - Class in nz.org.riskscape.engine.types.eqrule
-
Allows assignment of integers to floating point - considered a downcast, as an integer value can represented 'enough' by a floating point rule.
- IntegerToFloatingRule() - Constructor for class nz.org.riskscape.engine.types.eqrule.IntegerToFloatingRule
- interactive() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns whether this option prompts the user to enter a value on the command line.
- interactive() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns whether this option will prompt the user to enter a value on the command line.
- interactive() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Set
interactive=true
if this option will prompt the end user for a value (like a password). - interactive() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Set
interactive=true
if this positional parameter will prompt the end user for a value (like a password). - interactive(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets whether this option prompts the user to enter a value on the command line, and returns this builder.
- INTERNAL_TYPE - Static variable in class nz.org.riskscape.engine.types.Struct
- internalShowDefaultValue(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns whether the default for this option or positional parameter should be shown, potentially overriding the specified global setting.
- internalShowDefaultValue(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- internalType() - Method in class nz.org.riskscape.engine.types.Anything
- internalType() - Method in class nz.org.riskscape.engine.types.Bool
- internalType() - Method in class nz.org.riskscape.engine.types.CoverageType
- internalType() - Method in class nz.org.riskscape.engine.types.Date
- internalType() - Method in class nz.org.riskscape.engine.types.Decimal
- internalType() - Method in class nz.org.riskscape.engine.types.EmptyList
- internalType() - Method in class nz.org.riskscape.engine.types.Enumeration
- internalType() - Method in class nz.org.riskscape.engine.types.Floating
- internalType() - Method in class nz.org.riskscape.engine.types.FunctionType
- internalType() - Method in class nz.org.riskscape.engine.types.Geom
- internalType() - Method in class nz.org.riskscape.engine.types.GeomType.Line
- internalType() - Method in class nz.org.riskscape.engine.types.GeomType.Point
- internalType() - Method in class nz.org.riskscape.engine.types.GeomType.Polygon
- internalType() - Method in class nz.org.riskscape.engine.types.Integer
- internalType() - Method in class nz.org.riskscape.engine.types.LambdaType
- internalType() - Method in class nz.org.riskscape.engine.types.LookupTableType
- internalType() - Method in class nz.org.riskscape.engine.types.MultiGeom
- internalType() - Method in class nz.org.riskscape.engine.types.Nothing
- internalType() - Method in class nz.org.riskscape.engine.types.Nullable
- internalType() - Method in class nz.org.riskscape.engine.types.OfUnit
- internalType() - Method in class nz.org.riskscape.engine.types.Referenced
- internalType() - Method in class nz.org.riskscape.engine.types.RelationType
- internalType() - Method in class nz.org.riskscape.engine.types.RSList
- internalType() - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- internalType() - Method in class nz.org.riskscape.engine.types.Struct
- internalType() - Method in class nz.org.riskscape.engine.types.Text
- internalType() - Method in interface nz.org.riskscape.engine.types.Type
-
The underlying java class used to represent this type.
- internalType() - Method in class nz.org.riskscape.engine.types.WithinRange
- internalType() - Method in class nz.org.riskscape.engine.types.WithinSet
- internalType() - Method in class nz.org.riskscape.engine.types.WithMetadata
- internalType() - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- interpolateVariables() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns whether whether variables should be interpolated in String values.
- interpolateVariables(Boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets whether whether variables should be interpolated in String values.
- InterruptHandler - Interface in nz.org.riskscape.cli
-
Functional interface for an interrupt handler.
- invalid(Geometry, TopologyValidationError, String) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When an invalid geometry has been detected and geometry fixing does not work.
- INVALID_BECAUSE - Enum constant in enum class nz.org.riskscape.problem.StandardCodes
- InvalidBoundParametersException - Exception in nz.org.riskscape.engine.bind
-
Thrown when a method expects a set of bound parameters that match a particular set of defined parameters but they don't match.
- InvalidBoundParametersException(String) - Constructor for exception nz.org.riskscape.engine.bind.InvalidBoundParametersException
-
Deprecated.
- InvalidBoundParametersException(Problem) - Constructor for exception nz.org.riskscape.engine.bind.InvalidBoundParametersException
- invalidContent(String) - Method in interface nz.org.riskscape.engine.data.BookmarkProblems
- invalidFor(Object) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
Use when the parameters for a given object are invalid, e.g.
- invalidPostReprojection(CoordinateReferenceSystem, CoordinateReferenceSystem) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When an invalid geometry has been created due to re-projection and geometry fixing does not work.
- invalidTupleError() - Method in interface nz.org.riskscape.engine.data.InputDataProblems
-
An invalid tuple that has not been skipped, and thus has stopped the pipeline execution.
- InvalidTupleException - Exception in nz.org.riskscape.engine.relation
-
Thrown when an invalid tuple (row) of input data is encountered, i.e.
- InvalidTupleException(Tuple, String) - Constructor for exception nz.org.riskscape.engine.relation.InvalidTupleException
-
Deprecated.
- InvalidTupleException(Tuple, String, Throwable) - Constructor for exception nz.org.riskscape.engine.relation.InvalidTupleException
-
Deprecated.
- InvalidTupleException(Tuple, Problem) - Constructor for exception nz.org.riskscape.engine.relation.InvalidTupleException
- InvalidTupleException(Tuple, Problem, Throwable) - Constructor for exception nz.org.riskscape.engine.relation.InvalidTupleException
- invalidTupleSkipped() - Method in interface nz.org.riskscape.engine.data.InputDataProblems
-
An invalid row of data (tuple) has been skipped.
- InvalidUsageException - Exception in nz.org.riskscape.engine.cli
-
Can be thrown by commands when there is some higher level problem with they way a command has been used that could be solved if the user RTFM.
- InvalidUsageException(Object, String, Object...) - Constructor for exception nz.org.riskscape.engine.cli.InvalidUsageException
- INVARIANT - Enum constant in enum class nz.org.riskscape.engine.types.varule.Variance
-
The rule says that values of source type can not be safely assigned to the target.
- invoke(Object, Method, Object[]) - Method in class nz.org.riskscape.engine.problem.ProblemFactoryProxy
-
Intercepts the @{link ProblemFactory} method to create a
Problem
based on the method name and factory class name. - invoke(String, Class<?>, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - invoke(String, Class<?>, PrintStream, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - invoke(String, Class<?>, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - invoke(String, Class<?>, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - IO_CHARSET - Static variable in class nz.org.riskscape.engine.types.Text
- is(Type) - Static method in class nz.org.riskscape.engine.types.Nullable
- isA(Class<T>) - Method in interface nz.org.riskscape.engine.auth.Secret
- isA(Class<T>) - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
- isA(Class<T>) - Method in class nz.org.riskscape.engine.types.GeomType
- isA(Class<T>) - Method in class nz.org.riskscape.engine.types.MultiGeom
- isA(Class<T>) - Method in interface nz.org.riskscape.engine.types.Type
- isA(Class<T>) - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- isA(Class<T>) - Method in class nz.org.riskscape.pipeline.ast.StepDeclaration
-
Functional cast for a step, useful for definition or reference specific functional code in favour of if-for-instance style logic
- isA(Class<T>) - Method in interface nz.org.riskscape.rl.ast.Expression
-
Functional style instanceof method
- isAccessible() - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- isAddMethodSubcommands() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns whether method commands should be added as subcommands.
- isAdjustLineBreaksForWideCJKCharacters() - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
- isAdjustLineBreaksForWideCJKCharacters() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.
- isAllowInsecure() - Method in class nz.org.riskscape.engine.resource.Resource.Options
- isAllowNull(Type) - Static method in class nz.org.riskscape.engine.types.GeomType
- isAnnotationPresent(Class<? extends Annotation>) - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isAnonymous() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- isApplicable(URI) - Method in interface nz.org.riskscape.engine.output.PipelineOutputStore
-
Returns a score indicating if this store is able to create a
PipelineOutputContainer
for the given URI. - isArgGroup() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isArgSpec() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isArray() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
- isAssignable(Type, Type) - Method in interface nz.org.riskscape.engine.typeset.TypeRules
- isBoolean() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
- isBuiltin() - Method in interface nz.org.riskscape.engine.function.IdentifiedFunction
- isCaseInsensitiveEnumValuesAllowed() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether the parser should ignore case when converting arguments to
enum
values. - isChecksum() - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
True, if the user would like to have a checksum generated for saved results.
- isCollection() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
- isCompatible(ParameterProperty) - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
- isCompatible(RealizationContext, List<Type>) - Method in class nz.org.riskscape.engine.function.ArgumentList
- isConverting() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
- isConverting() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- isDirectlyFailed() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- isEmpty() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- isEmpty() - Method in interface nz.org.riskscape.engine.IdentifiedCollection
- isEmpty() - Method in interface nz.org.riskscape.engine.rl.agg.Accumulator
- isEmpty() - Method in class nz.org.riskscape.engine.types.Struct.StructBuilder
- isEmpty() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatch
-
Returns
true
if this match has no matched arguments and no matched subgroups. - isEmpty() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- isEnum() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
-
Returns
true
ifCommandLine.Model.ITypeInfo.getType()
is an enum. - isEOF() - Method in class nz.org.riskscape.dsl.Lexer
- isEquivalent(Struct) - Method in class nz.org.riskscape.engine.types.Struct
- isError() - Method in class nz.org.riskscape.problem.Problem
- isExpandAtFiles() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether arguments starting with
'@'
should be treated as the path to an argument file and its contents should be expanded into separate arguments for each line in the specified file. - isFailed() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- isFailed() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- isFatal() - Method in class nz.org.riskscape.problem.Problem
- isFromURI() - Method in class nz.org.riskscape.engine.data.Bookmark
-
If true, this Bookmark has not been fetched from an identified collection, but instead constructed, probably from a URI.
- isIdentity() - Method in interface nz.org.riskscape.engine.types.eqrule.Coercer
- isInteractive() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isInterpolateVariables() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether whether variables should be interpolated in String values.
- isJSONStyle() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- isLinux() - Static method in class nz.org.riskscape.engine.OsUtils
- isMac() - Static method in class nz.org.riskscape.engine.OsUtils
- isMany() - Method in class nz.org.riskscape.engine.bind.Parameter
- isMap() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
- isMethodParameter() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isMixin() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isMultiValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns
true
if this argument'sCommandLine.Model.ArgSpec.type()
is an array, aCollection
or aMap
,false
otherwise. - isMultiValue() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isMultiValue() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ITypeInfo
-
Returns
true
ifCommandLine.Model.ITypeInfo.getType()
is an array, map or collection. - isNullable() - Method in enum class nz.org.riskscape.engine.join.JoinType
- isNullable() - Method in class nz.org.riskscape.engine.types.Nullable
- isNullable() - Method in interface nz.org.riskscape.engine.types.Type
- isNullable() - Method in interface nz.org.riskscape.engine.types.WrappingType
- isNumeric() - Method in interface nz.org.riskscape.engine.types.Type
-
Indicates if this
Type
is numeric. - isOneBased() - Method in class nz.org.riskscape.engine.types.Enumeration
- isOption() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns
true
if this argument is a named option,false
otherwise. - isOption() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isOption() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- isOption() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
- isOptional() - Method in class nz.org.riskscape.engine.bind.Parameter
- isOverwrittenOptionsAllowed() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether options for single-value fields can be specified multiple times on the command line.
- isParallelizable() - Method in interface nz.org.riskscape.engine.pipeline.Collector
- isParameter() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isParentCommand() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isPositional() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns
true
if this argument is a positional parameter,false
otherwise. - isPositional() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
- isPositional() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
- isPosixClusteredShortOptionsAllowed() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether the parser accepts clustered short options.
- isPresent() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- isPresent() - Method in class nz.org.riskscape.problem.ResultOrProblems
- isReceiverSelectAll() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- isReplace() - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
True, if the user would like existing content to be replaced.
- isReplace() - Method in class nz.org.riskscape.engine.resource.CreateRequest
-
If set to true and an existing resource exists in the container with the same name, then it will be replaced.
- isSameFamily(Geometry) - Method in enum class nz.org.riskscape.engine.geo.GeometryFamily
- isSelectAll() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
-
true
if the member is a vanilla select-all operator, e.g. - isSelectAllOnReceiver() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
-
true
if the member has a trailing select-all operator, e.g. - isSimpleType(Type) - Static method in class nz.org.riskscape.engine.types.SimpleType
- isSingleIdentifier() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- isSourceSingleLine() - Method in class nz.org.riskscape.dsl.Token
- isSpec() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isSplitQuotedStrings() - Method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use
CommandLine.Model.ParserSpec.splitQuotedStrings(boolean)
. - isSQLStyle() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- isStopAtPositional() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether the parser interprets the first positional parameter as "end of options" so the remaining arguments are all treated as positional parameters.
- isStopAtUnmatched() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether the parser should stop interpreting options and positional parameters as soon as it encounters an unmatched option.
- isSubgroupOf(CommandLine.Model.ArgGroupSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns
true
if this group is a subgroup (or a nested sub-subgroup, to any level of depth) of the specified group,false
otherwise. - isSupersetOf(Struct) - Method in class nz.org.riskscape.engine.types.Struct
- isToggleBooleanFlags() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether the value of boolean flag options should be "toggled" when the option is matched.
- isTrailingSelectAll() - Method in class nz.org.riskscape.rl.ast.PropertyAccess
- isTrimQuotes() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether the parser should trim quotes from command line arguments.
- isTTY() - Method in interface nz.org.riskscape.cli.Terminal
- isType(Class<?>) - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
- isUnbounded() - Method in interface nz.org.riskscape.engine.pipeline.Sink
-
If true, this sink will never return false from
Sink.accept(Tuple)
- isUnion(Struct) - Method in class nz.org.riskscape.engine.types.Struct
- isUnknownOption() - Method in exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
-
Returns
true
if the first unmatched command line arguments resembles an option,false
otherwise. - isUnmatched() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- isUnmatchedArgumentsAllowed() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether the end user may specify arguments on the command line that are not matched to any option or parameter fields.
- isUnmatchedOptionsArePositionalParams() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether arguments on the command line that resemble an option should be treated as positional parameters.
- isUnresolved() - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns
true
if this range contains variables that have not been expanded yet,false
if this Range does not contain any variables. - isUnspecified() - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns
true
if this Range is a default value,false
if the user specified this value. - isUsageHelpAutoWidth() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
- isUsageHelpRequested() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns
true
if an option annotated withCommandLine.Option.usageHelp()
was specified on the command line. - isUsageHelpRequested() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns
true
if one of the options that was matched on the command line is ausageHelp
option. - isUseSimplifiedAtFiles() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns whether to use a simplified argument file format that is compatible with JCommander.
- isValid() - Method in class nz.org.riskscape.engine.bind.BoundParameters
- isVariable - Variable in class nz.org.riskscape.picocli.CommandLine.Range
-
Deprecated.use
CommandLine.Range.isVariable()
instead - isVariable() - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns
true
if this range has no fixed upper bound. - isVersionHelpRequested() - Method in class nz.org.riskscape.picocli.CommandLine
-
Returns
true
if an option annotated withCommandLine.Option.versionHelp()
was specified on the command line. - isVersionHelpRequested() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns
true
if one of the options that was matched on the command line is aversionHelp
option. - isWhitespace() - Method in class nz.org.riskscape.dsl.Token
- isWhitespace() - Method in interface nz.org.riskscape.dsl.TokenType
- isWhitespace() - Method in enum class nz.org.riskscape.rl.TokenTypes
- isWindows() - Static method in class nz.org.riskscape.engine.OsUtils
- isWrapped() - Method in interface nz.org.riskscape.engine.types.Type
- italic - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- iterator() - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- iterator() - Method in interface nz.org.riskscape.engine.relation.Relation
J
- JavaFunction - Class in nz.org.riskscape.engine.function
-
Immutable prototype-builder implementation of
IdentifiedFunction
TODO given the use of this an all sorts of other implementations, the name of this needs to change to be more like 'BaseFunction' or 'ImmutableFunction' - JavaFunction(String, String, String, List<Type>, Type, JavaFunction.Delegate, IdentifiedFunction.Category) - Constructor for class nz.org.riskscape.engine.function.JavaFunction
- JavaFunction(FunctionMetadata, JavaFunction.Delegate) - Constructor for class nz.org.riskscape.engine.function.JavaFunction
- JavaFunction.Delegate - Interface in nz.org.riskscape.engine.function
- JavaMethodCode(Method) - Constructor for class nz.org.riskscape.engine.problem.ProblemFactoryProxy.JavaMethodCode
- JavaRule - Class in nz.org.riskscape.engine.types
-
This rule stops variance calculation when the java types are not compatible
- JavaRule() - Constructor for class nz.org.riskscape.engine.types.JavaRule
- join(List<Struct.StructMember>) - Static method in interface nz.org.riskscape.engine.projection.Projector
- join(Tuple, Tuple) - Method in interface nz.org.riskscape.engine.join.Join
-
Create a joined tuple of joinedType that can be used with our joinCondition
- join(CommandLine.Help.Ansi, int, boolean, String[], StringBuilder, Object...) - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Formats each of the specified values and appends it to the specified StringBuilder.
- join(CommandLine.Help.Ansi, int, String[], StringBuilder, Object...) - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Deprecated.
- join(T, Tuple) - Method in interface nz.org.riskscape.engine.join.LopsidedJoiner
-
Join a single lhs value to the indexed set of rhs values.
- Join - Interface in nz.org.riskscape.engine.join
-
Interface for classes that can join a relation on to another relation, tuple at a time.
- JoinCondition - Interface in nz.org.riskscape.engine.join
- JOINER - Static variable in class nz.org.riskscape.engine.types.WithinSet
- JoinType - Enum Class in nz.org.riskscape.engine.join
-
Specifies what kind of join this is
- jsonStyleMember(String, Expression) - Static method in class nz.org.riskscape.rl.ast.StructDeclaration
-
Returns a json style (foo: bar) struct member
- jsonStyleMember(Token, Expression) - Static method in class nz.org.riskscape.rl.ast.StructDeclaration
-
Returns a json style (foo: bar) struct member
K
- KEY_IDENTIFIER - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- KEY_IDENTIFIERS - Static variable in class nz.org.riskscape.rl.ExpressionParser
-
Used with
ConditionalParse
- keyValuesMap(String...) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Creates and returns a
Map
that contains an entry for each specified String that is in"key:value"
format. - KEYWORD_AND - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- KEYWORD_AS - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- KEYWORD_DOES_NOT_EXIST - Enum constant in enum class nz.org.riskscape.engine.rl.ExpressionRealizer.ProblemCodes
-
Keyword supplied for an argument that doesn't exist with this keyword
- KEYWORD_FALSE - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- KEYWORD_NULL - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- KEYWORD_OR - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- KEYWORD_OUT_OF_ORDER - Enum constant in enum class nz.org.riskscape.engine.rl.ExpressionRealizer.ProblemCodes
-
Happens when an argument is supplied multiple times, i.e.
- KEYWORD_REQUIRED - Enum constant in enum class nz.org.riskscape.engine.rl.ExpressionRealizer.ProblemCodes
-
Non-keyword arg supplied after keyword args, e.g.
- KEYWORD_TRUE - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- keywordArgumentsOffset() - Method in class nz.org.riskscape.rl.ast.FunctionCall
- KEYWORDS - Static variable in enum class nz.org.riskscape.rl.TokenTypes
L
- Lambda - Class in nz.org.riskscape.rl.ast
-
A lambda expression in the RiskScape language is a self-contained expression that can be applied to a list of arguments.
- Lambda(Token, List<Token>, Expression) - Constructor for class nz.org.riskscape.rl.ast.Lambda
- lambdaArityError(Expression, int, int) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
- LambdaType - Class in nz.org.riskscape.engine.types
-
Represents a lambda expression in an unrealized function's type signature.
- LambdaType(String...) - Constructor for class nz.org.riskscape.engine.types.LambdaType
- LambdaType(List<String>) - Constructor for class nz.org.riskscape.engine.types.LambdaType
- LANGUAGE - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- last(PipelineDeclaration) - Static method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- last(PipelineDeclaration, StepChain) - Static method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Copies the specified text values into the correct cells in the
CommandLine.Help.TextTable
. - Layout(CommandLine.Help.ColorScheme, int) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Constructs a Layout with the specified color scheme, a new default TextTable, the default option renderer, and the default parameter renderer.
- Layout(CommandLine.Help.ColorScheme, CommandLine.Help.TextTable) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Constructs a Layout with the specified color scheme, the specified TextTable, the default option renderer, and the default parameter renderer.
- Layout(CommandLine.Help.ColorScheme, CommandLine.Help.TextTable, CommandLine.Help.IOptionRenderer, CommandLine.Help.IParameterRenderer) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Constructs a Layout with the specified color scheme, the specified TextTable, the specified option renderer and the specified parameter renderer.
- lazilyCollected(TupleIterator) - Method in class nz.org.riskscape.engine.pipeline.DefaultCollection
- LBRACE - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- LBRACK - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- LEADING_TOKENS - Static variable in class nz.org.riskscape.rl.ExpressionParser
-
The list of tokens that typically start any expression
- LEFT_OUTER - Enum constant in enum class nz.org.riskscape.engine.join.JoinType
-
https://en.wikipedia.org/wiki/Join(SQL)#Leftouter_join
- LESS_THAN - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- LESS_THAN_EQUAL - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- lex(String) - Method in class nz.org.riskscape.rl.ExpressionParser
-
Lexes source with the
TokenTypes.tokens()
. - Lexer<T extends TokenType> - Class in nz.org.riskscape.dsl
- Lexer(Lexer.Tokens<T>, String) - Constructor for class nz.org.riskscape.dsl.Lexer
- Lexer.Tokens<T extends TokenType> - Class in nz.org.riskscape.dsl
-
Meta-class object for token type enumeration.
- LexerException - Exception in nz.org.riskscape.dsl
-
General exception thrown during lexing
- LexerException(LexerException.ProblemCodes, int, Object...) - Constructor for exception nz.org.riskscape.dsl.LexerException
- LexerException.ProblemCodes - Enum Class in nz.org.riskscape.dsl
- LF - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- LHS_STEP_INDEX - Static variable in interface nz.org.riskscape.engine.join.LopsidedJoiner
- limit(long) - Method in interface nz.org.riskscape.engine.relation.Relation
-
Convenience version of
Relation.limitAndOffset(long, long)
with offset set to the Relation's current offset - limitAndOffset(long, long) - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- limitAndOffset(long, long) - Method in interface nz.org.riskscape.engine.relation.Relation
-
Returns a new relation that yields a subset of tuples this relation would normally return.
- limitSplit() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Returns true if arguments should be split first before any further processing and the number of parts resulting from the split is limited to the max arity of the argument.
- limitSplit(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Sets whether arguments should be split first before any further processing.
- Line() - Constructor for class nz.org.riskscape.engine.types.GeomType.Line
- LINE - Static variable in class nz.org.riskscape.engine.types.Types
- LINE_ENDINGS - Static variable in interface nz.org.riskscape.dsl.TokenMatcher
- LINE_SEPARATOR - Static variable in class nz.org.riskscape.engine.OsUtils
- LINEAL - Enum constant in enum class nz.org.riskscape.engine.geo.GeometryFamily
- lineno - Variable in class nz.org.riskscape.dsl.Token
- LinkedType - Class in nz.org.riskscape.engine.typeset
- LinkedType(TypeSet, String) - Constructor for class nz.org.riskscape.engine.typeset.LinkedType
- LinkedTypeRule - Class in nz.org.riskscape.engine.types.varule
- LinkedTypeRule() - Constructor for class nz.org.riskscape.engine.types.varule.LinkedTypeRule
- LIST_ANYTHING - Static variable in class nz.org.riskscape.engine.types.RSList
- ListDeclaration - Class in nz.org.riskscape.rl.ast
-
A list declarations yields a list of whatever is expressed within it, e.g.
- ListDeclaration(List<Expression>, Optional<Pair<Token, Token>>) - Constructor for class nz.org.riskscape.rl.ast.ListDeclaration
- listItemMismatch(Class<?>, Type) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- ListUtils - Class in nz.org.riskscape.util
- ListUtils() - Constructor for class nz.org.riskscape.util.ListUtils
- LITERALS - Static variable in class nz.org.riskscape.rl.ExpressionParser
-
All of the things that can be inside a
Constant
- load(String, URI) - Method in interface nz.org.riskscape.engine.resource.ResourceFactory
- load(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceFactory
- load(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceLoader
-
Get a
Resource
representing the target resource. - load(URI, URI) - Method in interface nz.org.riskscape.engine.resource.ResourceFactory
- localFilename(URI) - Method in class nz.org.riskscape.engine.resource.BaseResource
- localInfo - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- LocalInfo(String, String) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest.LocalInfo
- location - Variable in class nz.org.riskscape.engine.resource.BaseResource
- location(URI) - Method in class nz.org.riskscape.engine.data.Bookmark.BookmarkBuilder
-
Contains a potentially modified location, set to be absolute based on the location of the bookmark itself.
- Location(int, int, int) - Constructor for class nz.org.riskscape.dsl.Token.Location
- log(Problem) - Method in interface nz.org.riskscape.engine.Diagnostics
-
Logs a notification.
- log(Problem) - Method in interface nz.org.riskscape.problem.ProblemSink
- LOGICAL - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- longestName() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns the longest option name.
- lookup(Object) - Method in interface nz.org.riskscape.engine.lookup.LookupTable
-
Lookup a value in this table, or null if there is no value for the given key (or null if the key mapped to null)
- LookupTable - Interface in nz.org.riskscape.engine.lookup
-
A LookupTable is a data source that allows some value to be looked up based on a key.
- LookupTableType - Class in nz.org.riskscape.engine.types
-
Represents an instance of a
LookupTable
- LookupTableType(Type, Type) - Constructor for class nz.org.riskscape.engine.types.LookupTableType
- LookupTableTypeRule - Class in nz.org.riskscape.engine.types.varule
- LookupTableTypeRule() - Constructor for class nz.org.riskscape.engine.types.varule.LookupTableTypeRule
- LopsidedJoiner<T> - Interface in nz.org.riskscape.engine.join
-
A variation on Joiner that works by joining individual values from the lhs (left-hand side) to an indexed set of rhs (right-hand side) values.
- LPAREN - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
M
- makeNegative(String, CommandLine.Model.CommandSpec) - Method in interface nz.org.riskscape.picocli.CommandLine.INegatableOptionTransformer
-
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.
- makeNegative(String, CommandLine.Model.CommandSpec) - Method in class nz.org.riskscape.picocli.CommandLine.RegexTransformer
-
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.
- makeSynopsis(String, CommandLine.Model.CommandSpec) - Method in interface nz.org.riskscape.picocli.CommandLine.INegatableOptionTransformer
-
Returns the documentation string to show in the synopsis and usage help message for the specified option.
- makeSynopsis(String, CommandLine.Model.CommandSpec) - Method in class nz.org.riskscape.picocli.CommandLine.RegexTransformer
-
Returns the documentation string to show in the synopsis and usage help message for the specified option.
- makeUnique(String, Collection<String>) - Static method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
- malformedExpression(String) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
A parent problem that wraps a more specific problem within the expression
- MalformedExpressionException - Exception in nz.org.riskscape.rl
-
Thrown by a ExpressionParser when we got an unexpected token, indicating that the expression must be malformed.
- MalformedExpressionException(String, UnexpectedTokenException) - Constructor for exception nz.org.riskscape.rl.MalformedExpressionException
- malformedExpressionTip() - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Give the user some idea of what to do when an unexpected token exception occurs
- Manifest - Class in nz.org.riskscape.engine.pipeline
-
metadata from the execution of a pipeline
- Manifest() - Constructor for class nz.org.riskscape.engine.pipeline.Manifest
- Manifest(RealizedPipeline) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest
- Manifest(RealizedPipeline, LocalDateTime) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest
- MANIFEST_FILE - Static variable in class nz.org.riskscape.engine.pipeline.Manifest
-
Filename of manifest file.
- Manifest.LocalInfo - Class in nz.org.riskscape.engine.pipeline
- Manifest.OutputInfo - Class in nz.org.riskscape.engine.pipeline
- Manifest.StepDescription - Class in nz.org.riskscape.engine.pipeline
- Manifest.VersionInfo - Class in nz.org.riskscape.engine.pipeline
- map(Function<BoundParameters, T>) - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
ResultOrProblems
like method for mapping the parameters in to another object, but only if the parameters are valid - map(Function<T, U>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Maps the result of this
ResultOrProblems
to another result, only if the result has been set. - map(Function<T, U>, Function<Problem, Problem>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Maps the result of this
ResultOrProblems
to another result, only if the result has been set, as well as supporting remapping problems one at a time regardless of a result. - mapFunctionCall(FunctionCall, Function<FunctionCall.Argument, ResultOrProblems<T>>) - Method in class nz.org.riskscape.engine.function.FunctionArgument
-
Convenience method to apply a mapping to actual value that was supplied (i.e.
- mapOrCombine(Function<T, U>, ResultOrProblems<?>...) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Like
ResultOrProblems.map(Function)
, but will only map if this and all dependencies succeeded. - match(TokenType, String, int) - Method in interface nz.org.riskscape.dsl.TokenMatcher
- matchedArgs() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns a list of matched options and positional parameters, in order they were matched on the command line.
- matchedOption(char) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the option with the specified short name, or
null
if no option with that name was matched on the command line. - matchedOption(String) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the option with the specified name, or
null
if no option with that name was matched on the command line. - matchedOptions() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns a list of matched options, in order they were matched on the command line.
- matchedOptionsSet() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns a set of matched options.
- matchedOptionValue(char, T) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
- matchedOptionValue(String, T) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
- matchedPositional(int) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the first
PositionalParamSpec
that matched an argument at the specified position, ornull
if no positional parameters were matched at that position. - matchedPositionals() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns a list of matched positional parameters, in order they were matched on the command line.
- matchedPositionals(int) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns all
PositionalParamSpec
objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position. - matchedPositionalsSet() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns a set of matched positional parameters.
- matchedPositionalValue(int, T) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the command line argument value of the positional parameter at the specified position, converted to the type of the positional parameter, or the specified default value if no positional parameter was matched at that position.
- matchedSubgroups() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatch
-
Returns matches for the subgroups, if any.
- matchedValues(CommandLine.Model.ArgSpec) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatch
-
Returns the values matched for the specified argument, converted to the type of the argument.
- matcher() - Method in interface nz.org.riskscape.dsl.TokenType
- matcher() - Method in enum class nz.org.riskscape.rl.TokenTypes
- matches() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatchContainer
-
Returns the list of
GroupMatch
instances:ArgGroupSpec
s with a multiplicity greater than one may be matched multiple times. - matches(Tuple) - Method in interface nz.org.riskscape.engine.join.JoinCondition
- MATHS - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- max - Variable in class nz.org.riskscape.picocli.CommandLine.Range
-
Deprecated.use
CommandLine.Range.max()
instead - max() - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns the upper bound of this range (inclusive), or
Integer.MAX_VALUE
if this range has no upper bound. - max(int) - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns a new Range object with the
max
value replaced by the specified value. - max(Collection<? extends Problem>) - Static method in class nz.org.riskscape.problem.Problem
- maxRequired - Variable in class nz.org.riskscape.engine.bind.Parameter.MutableFields
- MaxValuesExceededException(CommandLine, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.MaxValuesExceededException
- merge(BoundParameters) - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
Merge these bound parameters with other such that any parameter that is set in other will replace one that this set in these bound parameters.
- message - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem
-
The translated message for the source problem
- MessageFactory - Interface in nz.org.riskscape.engine.i18n
-
A MessageFactory allows i18n messages to be declared and looked up from a MessageSource using a declarative dsl-ish technique.
- MessageKey - Interface in nz.org.riskscape.engine.i18n
-
Interface for objects that are suitable for message resolution in a
MessageSource
. - messages() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the Messages for this argument group specification, or
null
. - messages() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the Messages for this arg specification, or
null
. - messages() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the Messages for this usage help message specification, or
null
. - messages(CommandLine.Model.Messages) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Sets the Messages for this ArgGroupSpec, and returns this ArgGroupSpec.
- messages(CommandLine.Model.Messages) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Sets the Messages for this ArgSpec, and returns this ArgSpec.
- messages(CommandLine.Model.Messages) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.
- Messages - Interface in nz.org.riskscape.engine.i18n
-
High level interface in to RiskScape's i18n subsystem.
- Messages(CommandLine.Model.CommandSpec, String) - Constructor for class nz.org.riskscape.picocli.CommandLine.Model.Messages
- Messages(CommandLine.Model.CommandSpec, String, ResourceBundle) - Constructor for class nz.org.riskscape.picocli.CommandLine.Model.Messages
- Messages(CommandLine.Model.CommandSpec, ResourceBundle) - Constructor for class nz.org.riskscape.picocli.CommandLine.Model.Messages
- MessageSource - Interface in nz.org.riskscape.engine.i18n
-
Strategy interface for resolving messages, with support for the parameterization and internationalization of such messages.
- MetadataBasedFunction - Class in nz.org.riskscape.engine.function
-
Convenience class for dealing with the basic metadata-related aspects of a function, i.e.
- MetadataBasedFunction(FunctionMetadata) - Constructor for class nz.org.riskscape.engine.function.MetadataBasedFunction
- MetadataIdentifiedRealizableFunction(RealizableFunction, FunctionMetadata) - Constructor for class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- MethodParam(Method, int) - Constructor for class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- min - Variable in class nz.org.riskscape.picocli.CommandLine.Range
-
Deprecated.use
CommandLine.Range.min()
instead - min() - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns the lower bound of this range (inclusive).
- min(int) - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns a new Range object with the
min
value replaced by the specified value. - min(GeometryFamily) - Method in enum class nz.org.riskscape.engine.geo.GeometryFamily
-
Returns the lesser of the two geometry types - equivalent to the expected type when intersecting two geometries of the given types, excluding weird peripheral geometries such as glancing points and lines
- min(Variance, Variance) - Static method in enum class nz.org.riskscape.engine.types.varule.Variance
- MinimalVisitor<T> - Class in nz.org.riskscape.rl.ast
-
Subclass of
ExpressionVisitor
that does a traversal through the AST, without modifying anything. - MinimalVisitor() - Constructor for class nz.org.riskscape.rl.ast.MinimalVisitor
- minRequired - Variable in class nz.org.riskscape.engine.bind.Parameter.MutableFields
- MINUS - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- mirror(MetricRegistry, String) - Method in interface nz.org.riskscape.engine.Diagnostics
-
Mirrors the metrics in the given registry in our own MetricRegistry.
- MISC - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- mismatch(Object, Class<?>, Class<?>) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- mismatch(Object, TokenType, TokenType) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- mismatch(Object, Type, Type) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- mismatch(FunctionArgument, Type) - Static method in interface nz.org.riskscape.engine.ArgsProblems
-
Convenient way to generate a Problem when there's a type mismatch for one of the supplied arguments.
- mismatch(FunctionArgument, Type, List<Type>) - Static method in interface nz.org.riskscape.engine.ArgsProblems
-
Convenient way to generate a Problem when there's a type mismatch for one of the supplied arguments.
- mismatch(Expression, Class<? extends Expression>, String) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
expr is expected to be of requiredType but is not.
- mismatchedCrs(CoordinateReferenceSystem, CoordinateReferenceSystem) - Method in interface nz.org.riskscape.engine.GeometryProblems
- MISSING_IGNORED - Enum constant in enum class nz.org.riskscape.engine.Tuple.CoerceOptions
-
Suppresses an error for when
Tuple.hasNulls()
returns true after building the tuple from the map - MISSING_KEYWORD_ARGUMENTS - Enum constant in enum class nz.org.riskscape.engine.rl.ExpressionRealizer.ProblemCodes
-
Positional/Keyword arguments are missing, e.g.
- MissingParameterException(CommandLine, Collection<CommandLine.Model.ArgSpec>, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.MissingParameterException
- MissingParameterException(CommandLine, CommandLine.Model.ArgSpec, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.MissingParameterException
- MissingTypeConverterException(CommandLine, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.MissingTypeConverterException
- MissingTypeException - Exception in nz.org.riskscape.engine.typeset
- MissingTypeException(String, IdentifiedException) - Constructor for exception nz.org.riskscape.engine.typeset.MissingTypeException
- mixedGeometryTypes(Object) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
Could not perform an operation because we got a mix of geometry types (e.g.
- mixinAnnotatedElements() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns a map of the mixin names to mixin
IAnnotatedElement
objects for this command. - mixins() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns a map of the mixin names to mixin
CommandSpec
objects configured for this command. - mixinStandardHelpOptions() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Adds the standard
-h
and--help
usageHelp options and-V
and--version
versionHelp options to the options of this command. - mixinStandardHelpOptions() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns
true
if the standard help options have been mixed in with this command,false
otherwise. - mixinStandardHelpOptions(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets whether the standard help options should be mixed in with this command.
- Model - Interface in nz.org.riskscape.engine.model
-
Represents the new style of Riskscape model.
- ModelFramework - Interface in nz.org.riskscape.engine.model
-
Defines a framework for building models, e.g.
- ModelParameter - Class in nz.org.riskscape.engine.model
- ModelParameter(Parameter, ParameterTemplate) - Constructor for class nz.org.riskscape.engine.model.ModelParameter
- moreIndented(Token) - Method in class nz.org.riskscape.dsl.Token
- MULTI_LINE - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_LINE_TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_LINE_TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_POINT - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_POINT_TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_POINT_TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_POLYGON - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_POLYGON_TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MULTI_POLYGON_TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.MultiGeom
- MultiGeom - Class in nz.org.riskscape.engine.types
- MultiGeom(Class<? extends GeometryCollection>, Type) - Constructor for class nz.org.riskscape.engine.types.MultiGeom
- MULTIPLE_FILES - Enum constant in enum class nz.org.riskscape.engine.output.Format.Characteristics
-
This format ends up storing multiple files, rather than a single one.
- multipleProblems() - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Useful non-specific method to group a bunch of problems when there's no specific parent issue.
- multiplicity() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.ArgGroup
-
Determines how often this group can be specified on the command line;
"0..1"
(optional) by default. - multiplicity() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the multiplicity of this group: how many occurrences it may have on the command line;
"0..1"
(optional) by default. - multiplicity() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the multiplicity of this group: how many occurrences it may have on the command line;
"0..1"
(optional) by default. - multiplicity(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the multiplicity of this group: how many occurrences it may have on the command line;
"0..1"
(optional) by default. - multiplicity(CommandLine.Range) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the multiplicity of this group: how many occurrences it may have on the command line;
"0..1"
(optional) by default. - MULTIPLY - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- MutableFields(Parameter) - Constructor for class nz.org.riskscape.engine.bind.Parameter.MutableFields
- mutuallyExclusive(String, String) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
'
' and ' ' cannot both be specified at the same time - MutuallyExclusiveArgsException(CommandLine, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.MutuallyExclusiveArgsException
N
- name - Variable in class nz.org.riskscape.engine.bind.Parameter.MutableFields
- name() - Method in class nz.org.riskscape.engine.CustomCode
- name() - Method in class nz.org.riskscape.engine.problem.ProblemFactoryProxy.JavaMethodCode
- name() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Program name to show in the synopsis.
- name() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Mixin
-
Optionally specify a name that the mixin object can be retrieved with from the
CommandSpec
. - name() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns name of this command.
- name() - Method in interface nz.org.riskscape.problem.ProblemCode
-
The name of this code, unique among all other codes in its class
- name(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets the String to use as the program name in the synopsis line of the help message.
- NAME - Enum constant in enum class nz.org.riskscape.engine.problem.Affecting.Target
- nameAlreadyUsedBy(String, Object, Class<?>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
- named(String) - Method in interface nz.org.riskscape.engine.pipeline.Step
- NAMED_INPUT_NOT_ALLOWED - Enum constant in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Attempt to chain to a named input on a step that doesn't support named inputs
- namedInput - Variable in class nz.org.riskscape.engine.pipeline.Edge
- namedInputToken - Variable in class nz.org.riskscape.pipeline.ast.StepDeclaration
-
The identifier that specifies a named input which accepts the previous step in the chain's output, e.g.
- namedInputUnknown(Step, String, List<String>) - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
-
Attempt to chain to a named input that doesn't exist on the target step.
- NamedStep - Class in nz.org.riskscape.engine.pipeline
- NamedStep(String, Step, StepDefinition) - Constructor for class nz.org.riskscape.engine.pipeline.NamedStep
- NamedStep(String, Step) - Constructor for class nz.org.riskscape.engine.pipeline.NamedStep
-
Create a named step without specifying the source that defined it - some fake ast will be constructed and assigned as a place holder.
- names() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns all names of this command, including
CommandLine.Model.CommandSpec.name()
andCommandLine.Model.CommandSpec.aliases()
. - names() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns one or more option names.
- names() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns one or more option names.
- names() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
One or more option names.
- names(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Replaces the option names with the specified values.
- negatable() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns whether a negative version for this boolean option is automatically added.
- negatable() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns whether a negative version for this boolean option is automatically added.
- negatable() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
(Only for boolean options): set this to automatically add a negative version for this boolean option.
- negatable(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Sets whether a negative version for this boolean option is automatically added, and returns this builder.
- negatableOptionTransformer() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the
INegatableOptionTransformer
used to create the negative form of negatable options. - negatableOptionTransformer(CommandLine.INegatableOptionTransformer) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets the
INegatableOptionTransformer
used to create the negative form of negatable options. - negatedOptionsMap() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns a map of the negated option names to option spec objects configured for this command.
- NestedPipelineStep - Interface in nz.org.riskscape.engine.pipeline
-
A
Step
that uses another pipeline as part of its processing. - NestedPipelineStep.State - Enum Class in nz.org.riskscape.engine.pipeline
-
Used to track the construction state of this step, as we have to do a bit of collaboration across components to successfully build and validate pipeline steps that nest a child pipeline.
- NEVER - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Visibility
- newAccumulator() - Method in interface nz.org.riskscape.engine.pipeline.Collector
-
Create a new accumulator that holds collection/aggregation state for this collector to use.
- newAccumulator() - Method in interface nz.org.riskscape.engine.pipeline.StreamingCollector
-
Create a new accumulator that holds collection/aggregation state for this collector to use.
- newAccumulator() - Method in interface nz.org.riskscape.engine.rl.agg.RealizedAggregateExpression
- newBindingContext() - Method in interface nz.org.riskscape.engine.Project
- newBindingContext(RealizationContext) - Method in interface nz.org.riskscape.engine.Project
- newExecutionContext() - Method in interface nz.org.riskscape.engine.Project
- newExecutionContext(Project) - Method in interface nz.org.riskscape.engine.pipeline.PipelineExecutor
- newFactory(Class<T>) - Method in class nz.org.riskscape.engine.i18n.TranslationContext
- newInstance() - Method in class nz.org.riskscape.engine.plugin.ConstructorFeature
- newInstance(A) - Method in class nz.org.riskscape.engine.plugin.ConstructorFeature
- newInstance(Class<T>) - Static method in class nz.org.riskscape.ReflectionUtils
-
Calls
clazz.newInstance
, wrapping the checked exceptions in an unchecked runtime exception - newInstance(Class<T>, Function<Exception, E>) - Static method in class nz.org.riskscape.ReflectionUtils
-
Calls
clazz.newInstance
, wrapping the checked exceptions in an exception provided fromconstructor
- newInstance(PipelineJobContext) - Method in interface nz.org.riskscape.engine.pipeline.SinkConstructor
-
Create a new instance of the tuple consumer (T), returning a failed result if it couldn't be done because of the given execution options or some other environment issue As much as possible, other validation errors should have been surfaced during the realization of this
SinkConstructor
from the step. - newLines - Variable in class nz.org.riskscape.dsl.Lexer.Tokens
- newMessageSource(String) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Construct a MessageSource from the named resource bundle base name.
- newOutputOptions(String) - Method in interface nz.org.riskscape.engine.output.PipelineOutputStore
- newPluginInstance() - Method in interface nz.org.riskscape.engine.plugin.PluginDescriptor
- newRealizationContext() - Method in interface nz.org.riskscape.engine.Project
- newWriter(ExecutionContext, Struct, CreateHandle) - Method in interface nz.org.riskscape.engine.output.WriterConstructor
-
Create a new writer that can write the given type.
- next() - Method in class nz.org.riskscape.dsl.Lexer
- next() - Method in class nz.org.riskscape.engine.relation.Singleton
- NO_ARGS - Static variable in interface nz.org.riskscape.engine.i18n.MessageKey
- NO_ARGS - Static variable in class nz.org.riskscape.engine.types.LambdaType
- NO_BYTES - Static variable in interface nz.org.riskscape.engine.resource.Resource
-
An empty input stream for use with UNKNOWN
- NO_DEFAULT - Static variable in class nz.org.riskscape.engine.bind.Parameter
- NO_DESCRIPTION - Static variable in class nz.org.riskscape.engine.function.FunctionMetadata
- NO_DESCRIPTION - Static variable in class nz.org.riskscape.engine.pipeline.Pipeline
- NO_META - Static variable in interface nz.org.riskscape.engine.types.TypeVisitor
-
Null-alternative when the child of a compound type has no metadata
- NO_PROBLEM - Static variable in exception nz.org.riskscape.engine.cli.ExitException
-
Magic problem that indicates that there wasn't a problem related to this exit exception, such as when the user just wants to quit
- NO_PROBLEMS - Static variable in class nz.org.riskscape.problem.ResultOrProblems
- NO_STYLES - Static variable in interface nz.org.riskscape.cli.Terminal
-
Convenient constant to denote no styling
- NO_SUCH_MEMBER - Static variable in interface nz.org.riskscape.engine.rl.ExpressionRealizer
-
Problem code for when a member is missing from the scope of an expression - used by realizeConstant
- NO_VALIDATION - Static variable in class nz.org.riskscape.engine.bind.Parameter
- noBindingAvailable(Class<?>, Class<?>) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
There was no binder available to bind
from
->to
. - NoBindingAvailableException - Exception in nz.org.riskscape.engine.bind
-
Thrown from BindingContext when a binding fails because no
ParameterBinder
is available to bind with the given from and to - NoBindingAvailableException(Class<?>, Class<?>) - Constructor for exception nz.org.riskscape.engine.bind.NoBindingAvailableException
- noBindingAvailableForParameter(Parameter, Class<?>, Class<?>) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
As above, but with a parameter for context
- noFeatureLayers() - Method in interface nz.org.riskscape.engine.data.BookmarkProblems
- NON_SPATIAL - Enum constant in enum class nz.org.riskscape.engine.output.Format.Characteristics
-
This format doesn't require geometry to be present and might not record spatial data efficiently (or accurately)
- NONE - Enum constant in enum class nz.org.riskscape.problem.StandardCodes
- NONE - Static variable in interface nz.org.riskscape.engine.restriction.Restriction
- NONE - Static variable in class nz.org.riskscape.engine.sort.SortBy
- normaliseParameterMap(Map<String, ?>) - Static method in class nz.org.riskscape.engine.bind.ParameterSet
-
Accepts a wild-card map and returns one where all values are lists.
- NORMALIZED_TOKENS - Static variable in class nz.org.riskscape.rl.ast.BinaryOperation
- normalizeStruct(Struct) - Method in interface nz.org.riskscape.engine.rl.RealizationContext
-
Returns an equal struct to the given one, such that a subsequent call would return the exact same one.
- NoSuchMemberException - Exception in nz.org.riskscape.engine
-
Thrown when a tuple is queried for a member that does not exist.
- NoSuchMemberException(Struct, String) - Constructor for exception nz.org.riskscape.engine.NoSuchMemberException
- NoSuchObjectException - Exception in nz.org.riskscape.engine
-
Thrown when
IdentifiedCollection.get(String)
does not find an object with the given id. - NoSuchObjectException(String, Class<? extends Identified>) - Constructor for exception nz.org.riskscape.engine.NoSuchObjectException
- NoSuchObjectException(String, IdentifiedCollection<?>) - Constructor for exception nz.org.riskscape.engine.NoSuchObjectException
- noSuchObjectExists(String, Class<?>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Produces an error for when a user has referenced an object by its id and it doesn't exist
- noSuchObjectExistsDidYouMean(String, Class<? extends Identified>, List<String>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
- noSuchOperatorFunction(String, List<Type>) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
- noSuchStructMember(String, List<String>) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
- NoSuitableTypeIOException - Exception in nz.org.riskscape.engine.io
-
Throws by
TypeIOBuilder
s when aTypeIO
object couldn't be constructed - typically because there is no support for reading/writing a particular type. - NoSuitableTypeIOException(Type) - Constructor for exception nz.org.riskscape.engine.io.NoSuitableTypeIOException
- NOT_EQUALS - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- notAnOption(String, Class<T>) - Static method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Convenience version of
GeneralProblems.notAnOption(String, Object, List)
for enums. - notAnOption(String, Object, List<?>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
'
' is not a valid option for . - notAnOptionSimilarTo(String, List<?>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
When value is not a valid option.
- notAValid(Class<?>, String) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Similar to
ExpressionProblems.cannotParse(Object, String)
but for cases where mentioning 'parsing' is less appropriate. - notBookmarkOrFile(String) - Method in interface nz.org.riskscape.engine.data.BookmarkProblems
- notFound(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceProblems
- Nothing - Class in nz.org.riskscape.engine.types
- Nothing() - Constructor for class nz.org.riskscape.engine.types.Nothing
- NOTHING - Static variable in class nz.org.riskscape.engine.types.Types
- NothingRule - Class in nz.org.riskscape.engine.types.varule
-
Accepts null/nothing being passed to a Nullable target.
- NothingRule() - Constructor for class nz.org.riskscape.engine.types.varule.NothingRule
- notNumeric(FunctionArgument, Type) - Method in interface nz.org.riskscape.engine.ArgsProblems
- notReferenced(Type) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When a geometry type is found but it is not
Referenced
e.g it is missing CRS - notStruct(Expression, Type) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- Nullable - Class in nz.org.riskscape.engine.types
-
Wraps another type to allow values to be null.
- Nullable(Type) - Constructor for class nz.org.riskscape.engine.types.Nullable
- NullableAncestorRule - Class in nz.org.riskscape.engine.types.ancestor
-
Allows two types to be ancestors by making the ancestor type nullable if either of the descendant types are also nullable
- NullableAncestorRule() - Constructor for class nz.org.riskscape.engine.types.ancestor.NullableAncestorRule
- NullableRule - Class in nz.org.riskscape.engine.types.eqrule
-
Allows equivalence to be determined by the types inside a nullable
- NullableRule() - Constructor for class nz.org.riskscape.engine.types.eqrule.NullableRule
- NullableTargetRule - Class in nz.org.riskscape.engine.types.varule
-
Passes variance test on to the contained type of a nullable if the target, or the target and source, are nullable.
- NullableTargetRule() - Constructor for class nz.org.riskscape.engine.types.varule.NullableTargetRule
- nullGeometry(String, String) - Method in interface nz.org.riskscape.engine.data.InputDataProblems
-
We don't support the geometry attribute in the input data being null.
- NullSafeFunction - Class in nz.org.riskscape.engine.function
-
A
RiskscapeFunction
that wraps another one to short-circuit the target function to return null if any of the args are null. - NullSafeFunction(RiskscapeFunction, List<Type>, Type, boolean[]) - Constructor for class nz.org.riskscape.engine.function.NullSafeFunction
- NullStep - Class in nz.org.riskscape.engine.pipeline
- NullStep() - Constructor for class nz.org.riskscape.engine.pipeline.NullStep
- NumberTypeAncestorRule - Class in nz.org.riskscape.engine.types.ancestor
-
A converting rule that flattens any number types to floating to allow them to be ancestors
- NumberTypeAncestorRule() - Constructor for class nz.org.riskscape.engine.types.ancestor.NumberTypeAncestorRule
- nz.org.riskscape - package nz.org.riskscape
- nz.org.riskscape.cli - package nz.org.riskscape.cli
- nz.org.riskscape.config - package nz.org.riskscape.config
- nz.org.riskscape.dsl - package nz.org.riskscape.dsl
- nz.org.riskscape.engine - package nz.org.riskscape.engine
- nz.org.riskscape.engine.auth - package nz.org.riskscape.engine.auth
- nz.org.riskscape.engine.bind - package nz.org.riskscape.engine.bind
- nz.org.riskscape.engine.cli - package nz.org.riskscape.engine.cli
- nz.org.riskscape.engine.coverage - package nz.org.riskscape.engine.coverage
- nz.org.riskscape.engine.data - package nz.org.riskscape.engine.data
- nz.org.riskscape.engine.function - package nz.org.riskscape.engine.function
- nz.org.riskscape.engine.function.agg - package nz.org.riskscape.engine.function.agg
- nz.org.riskscape.engine.geo - package nz.org.riskscape.engine.geo
- nz.org.riskscape.engine.i18n - package nz.org.riskscape.engine.i18n
- nz.org.riskscape.engine.io - package nz.org.riskscape.engine.io
- nz.org.riskscape.engine.join - package nz.org.riskscape.engine.join
- nz.org.riskscape.engine.lookup - package nz.org.riskscape.engine.lookup
- nz.org.riskscape.engine.model - package nz.org.riskscape.engine.model
- nz.org.riskscape.engine.output - package nz.org.riskscape.engine.output
- nz.org.riskscape.engine.pipeline - package nz.org.riskscape.engine.pipeline
- nz.org.riskscape.engine.plugin - package nz.org.riskscape.engine.plugin
- nz.org.riskscape.engine.problem - package nz.org.riskscape.engine.problem
- nz.org.riskscape.engine.projection - package nz.org.riskscape.engine.projection
- nz.org.riskscape.engine.query - package nz.org.riskscape.engine.query
- nz.org.riskscape.engine.relation - package nz.org.riskscape.engine.relation
- nz.org.riskscape.engine.resource - package nz.org.riskscape.engine.resource
- nz.org.riskscape.engine.restriction - package nz.org.riskscape.engine.restriction
- nz.org.riskscape.engine.rl - package nz.org.riskscape.engine.rl
- nz.org.riskscape.engine.rl.agg - package nz.org.riskscape.engine.rl.agg
- nz.org.riskscape.engine.sort - package nz.org.riskscape.engine.sort
- nz.org.riskscape.engine.spi - package nz.org.riskscape.engine.spi
- nz.org.riskscape.engine.types - package nz.org.riskscape.engine.types
- nz.org.riskscape.engine.types.ancestor - package nz.org.riskscape.engine.types.ancestor
- nz.org.riskscape.engine.types.eqrule - package nz.org.riskscape.engine.types.eqrule
- nz.org.riskscape.engine.types.varule - package nz.org.riskscape.engine.types.varule
- nz.org.riskscape.engine.typeset - package nz.org.riskscape.engine.typeset
- nz.org.riskscape.engine.typexp - package nz.org.riskscape.engine.typexp
- nz.org.riskscape.engine.util - package nz.org.riskscape.engine.util
- nz.org.riskscape.picocli - package nz.org.riskscape.picocli
- nz.org.riskscape.pipeline - package nz.org.riskscape.pipeline
- nz.org.riskscape.pipeline.ast - package nz.org.riskscape.pipeline.ast
- nz.org.riskscape.problem - package nz.org.riskscape.problem
- nz.org.riskscape.rl - package nz.org.riskscape.rl
- nz.org.riskscape.rl.ast - package nz.org.riskscape.rl.ast
- nz.org.riskscape.util - package nz.org.riskscape.util
O
- OBJECT - Enum constant in enum class nz.org.riskscape.engine.problem.Affecting.Target
- objectAlreadyExists(String, Class<?>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Produces an error for when a user to tries to add an object with an id that is already used, e.g.
- ObjectAlreadyExistsException - Exception in nz.org.riskscape.engine
-
Thrown when an attempt is made to add an object to an
IdentifiedCollection
, but the collection already has an object with the same id. - ObjectAlreadyExistsException(Identified, Resource, Resource) - Constructor for exception nz.org.riskscape.engine.ObjectAlreadyExistsException
- ObjectRenderer - Interface in nz.org.riskscape.engine.i18n
-
Allows plugins to define custom 'toString' rules for generating a localized string representation of an object, in addition to the defaults.
- of() - Static method in class nz.org.riskscape.engine.types.Struct
-
Create an empty struct
- of(String, Object...) - Static method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
-
Build a
RiskscapeMessage
with desired code and messageArguments. - of(Class<?>, String) - Static method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
-
Creates a placeholder object when there is none available, e.g.
- of(Class<T>) - Static method in class nz.org.riskscape.engine.spi.EngineCollection
-
Generics-defeating constructor for a new EngineCollection.
- of(String...) - Static method in class nz.org.riskscape.rl.ast.PropertyAccess
- of(String, Type) - Static method in class nz.org.riskscape.engine.types.Struct
-
Define a struct, starting with the given key and type
- of(String, Type, String, Type) - Static method in class nz.org.riskscape.engine.types.Struct
- of(String, Type, String, Type, String, Type) - Static method in class nz.org.riskscape.engine.types.Struct
- of(String, Type, String, Type, String, Type, String, Type) - Static method in class nz.org.riskscape.engine.types.Struct
- of(String, Type, String, Type, String, Type, String, Type, String, Type) - Static method in class nz.org.riskscape.engine.types.Struct
- of(List<String>) - Static method in class nz.org.riskscape.rl.ast.PropertyAccess
- of(L, R) - Static method in class nz.org.riskscape.engine.util.Pair
-
Construct a new pair in a slightly nicer way that using the constructor e.g.
- of(Struct) - Static method in class nz.org.riskscape.engine.Tuple
-
Convenience constructor for building an empty tuple of this type
- of(Struct, String, Object) - Static method in class nz.org.riskscape.engine.Tuple
-
Convenience constructor for building a tuple with a single key/value
- of(Struct, String, Object, String, Object) - Static method in class nz.org.riskscape.engine.Tuple
-
Convenience constructor for building a tuple with two keys/values
- of(Type) - Static method in class nz.org.riskscape.engine.types.ancestor.AncestorType
-
Create an
AncestorType
with no conversion - of(Type) - Static method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- of(Type) - Static method in class nz.org.riskscape.engine.types.Nullable
- of(Type, Object) - Static method in class nz.org.riskscape.engine.types.Value
- of(Type, AncestorType.Converter) - Static method in class nz.org.riskscape.engine.types.ancestor.AncestorType
- of(Type, AncestorTypeList.Converter) - Static method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- of(Type, CoordinateReferenceSystem) - Static method in class nz.org.riskscape.engine.types.Referenced
-
Now somewhat needless static constructor to avoid undue change in code that was calling it.
- of(Type, CoordinateReferenceSystem, Envelope) - Static method in class nz.org.riskscape.engine.types.Referenced
-
Now somewhat needless static constructor to avoid undue change in code that was calling it.
- of(T) - Static method in class nz.org.riskscape.problem.ResultOrProblems
- of(T, List<Problem>) - Static method in class nz.org.riskscape.problem.ResultOrProblems
- of(T, Problem...) - Static method in class nz.org.riskscape.problem.ResultOrProblems
- ofDefault(String, Object...) - Static method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
-
Build a
RiskscapeMessage
that only contains the default message. - off() - Method in interface nz.org.riskscape.picocli.CommandLine.Help.Ansi.IStyle
-
Returns the ANSI escape code for turning this style off.
- off() - Method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- off(CommandLine.Help.Ansi.IStyle...) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
-
Returns the concatenated ANSI escape codes for turning all specified styles off.
- OFF - Enum constant in enum class nz.org.riskscape.engine.geo.GeometryValidation
-
Geometries are not checked for validity nor are they fixed.
- OFF - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Forced OFF: never emit ANSI escape code regardless of the platform.
- offset(long) - Method in interface nz.org.riskscape.engine.relation.Relation
-
Convenience version of
Relation.limitAndOffset(long, long)
with limit set to the Relation's current limit - ofNullable(Type, CoordinateReferenceSystem) - Static method in class nz.org.riskscape.engine.types.Referenced
-
Static constructor that takes care of re-wrapping the produced referenced type with nullable if the given underlying type was nullable
- ofNullable(Type, CoordinateReferenceSystem, Envelope) - Static method in class nz.org.riskscape.engine.types.Referenced
-
Static constructor that takes care of re-wrapping the produced referenced type with nullable if the given underlying type was nullable
- ofNullable(Type, ReferencedEnvelope) - Static method in class nz.org.riskscape.engine.types.Referenced
-
Static constructor that takes care of re-wrapping the produced referenced type with nullable if the given underlying type was nullable
- ofNullable(T, List<Problem>) - Static method in class nz.org.riskscape.problem.ResultOrProblems
-
Constructor where thing may or may not have been successfully created.
- OfUnit - Class in nz.org.riskscape.engine.types
-
Wraps a type adding some extra unit metadata, e.g.
- OfUnit(String, Type) - Constructor for class nz.org.riskscape.engine.types.OfUnit
- ofValues(Struct, Object...) - Static method in class nz.org.riskscape.engine.Tuple
-
Convenience constructor for building a tuple from an ordered (wrt to the struct) set of values
- OK - Static variable in class nz.org.riskscape.picocli.CommandLine.ExitCode
-
Return value from the
execute
andexecuteHelpRequest
methods signifying successful termination. - on() - Method in interface nz.org.riskscape.picocli.CommandLine.Help.Ansi.IStyle
-
Returns the ANSI escape code for turning this style on.
- on() - Method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- on(CommandLine.Help.Ansi.IStyle...) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
-
Returns the concatenated ANSI escape codes for turning all specified styles on.
- ON - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Forced ON: always emit ANSI escape code regardless of the platform.
- ON_DEMAND - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Visibility
- ONE_REQUIRED - Enum constant in enum class nz.org.riskscape.engine.query.TupleUtils.FindOption
- oneBased(String...) - Static method in class nz.org.riskscape.engine.types.Enumeration
-
Construct a Riskscape Enumeration from the given array of strings.
- oneOfTheseRequired(String...) - Static method in interface nz.org.riskscape.engine.bind.ParamProblems
-
Convenience wrapper for
ParamProblems.oneOfTheseRequired(List)
(because Arrays don't render very nicely in error messages). - oneOfTheseRequired(List<String>) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
-
Return this when there are a set of optional parameters, but at least one of them is required
- operationNotSupported(String, Class) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
For when an operation is called despite not being supported.
- OperatorResolver - Interface in nz.org.riskscape.engine.function
-
Used for Realizing
BinaryOperation
s in toRealizedExpression
s that can be used to evaluate an expression - OPERATORS - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- optional(String, Class<?>) - Static method in class nz.org.riskscape.engine.bind.Parameter
- optional(String, Class<?>, int) - Static method in class nz.org.riskscape.engine.bind.Parameter
- OPTIONAL - Enum constant in enum class nz.org.riskscape.engine.query.TupleUtils.FindOption
- optionArity(Field) - Static method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns a new
Range
based on theCommandLine.Option.arity()
annotation on the specified field, or the field type's default arity if no arity was specified. - optionList() - Method in class nz.org.riskscape.picocli.CommandLine.Help
- optionList(CommandLine.Help.Layout, Comparator<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Sorts all
Options
with the specifiedcomparator
(if the comparator is non-null
), then adds all non-hidden options to the specified TextTable and returns the result of TextTable.toString(). - optionListHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the options list.
- optionListHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the options list.
- optionListHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the option list; an empty string if there are no options, otherwise the result of
String.format(optionListHeading, params)
. - optionListHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the heading preceding the options list.
- optionParams(CommandLine.Help.Ansi.IStyle...) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Adds the specified styles to the registered styles for option parameters in this color scheme builder and returns this builder.
- optionParamStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Returns the registered styles for option parameters in this color scheme builder.
- optionParamStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns the registered styles for option parameters in this color scheme.
- optionParamText(String) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns a Text with all optionParam styles applied to the specified optionParam string.
- optionRenderer - Variable in class nz.org.riskscape.picocli.CommandLine.Help.Layout
- options() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the list of options configured for this group.
- options() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the list of options configured for this command.
- options(CommandLine.Help.Ansi.IStyle...) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.
- Options() - Constructor for class nz.org.riskscape.engine.resource.Resource.Options
- optionsMap() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns a map of the option names to option spec objects configured for this command.
- optionStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Returns the registered styles for options in this color scheme builder.
- optionStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns the registered styles for options in this color scheme.
- optionText(String) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns a Text with all option styles applied to the specified option string.
- OR - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- order() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.ArgGroup
-
Determines the position in the options list in the usage help message at which this group should be shown.
- order() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the position in the options list in the usage help message at which this group should be shown.
- order() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the position in the options list in the usage help message at which this group should be shown.
- order() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IOrdered
-
Returns the position in the options list in the usage help message at which this element should be shown.
- order() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns the position in the options list in the usage help message at which this option should be shown.
- order() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns the position in the options list in the usage help message at which this option should be shown.
- order() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
When
@Command(sortOptions = false)
is specified, this attribute can be used to control the order in which options are listed in the usage help message. - order(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the position in the options list in the usage help message at which this group should be shown, and returns this builder.
- order(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Sets the position in the options list in the usage help message at which this option should be shown, and returns this builder.
- orElse(Consumer<List<Problem>>, T) - Method in class nz.org.riskscape.problem.ResultOrProblems
- orElse(T) - Method in class nz.org.riskscape.problem.ResultOrProblems
- orElseGet(Function<List<Problem>, T>) - Method in class nz.org.riskscape.problem.ResultOrProblems
- orElseThrow(Function<List<Problem>, ? extends X>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Mirror of
Optional.orElseThrow(Supplier)
- throws the given exception if there is no computed result. - orElseThrow(Supplier<? extends X>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Mirror of
Optional.orElseThrow(Supplier)
- throws the given exception if there is no computed result. - originalArgs() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the command line arguments that were parsed.
- originalArgs(String[]) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Sets the specified command line arguments that were parsed.
- originalStringValues() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the original command line arguments matched by this option or positional parameter spec.
- OsUtils - Class in nz.org.riskscape.engine
-
Various utilities for interacting with the OS
- OsUtils() - Constructor for class nz.org.riskscape.engine.OsUtils
- out() - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Returns the stream to print command output to.
- outOfStorage(String, long) - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
-
Attached to an OutOfStorageException
- OutputInfo(String, String, String) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest.OutputInfo
- OutputInfo(String, String, MessageDigest) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest.OutputInfo
- outputLocationNotSupported(URI) - Method in interface nz.org.riskscape.engine.OutputProblems
-
None of the configured output stores support this uri
- OutputProblems - Interface in nz.org.riskscape.engine
- outputs - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- outputTypeAsText(String, Type, PipelineOutputStore) - Method in interface nz.org.riskscape.engine.OutputProblems
-
When the output has no specific mapping for the given type, so will fall-back to writing it as text.
- overflow - Variable in class nz.org.riskscape.picocli.CommandLine.Help.Column
-
Policy that determines how to handle values larger than the column width.
- OverloadedFunction - Interface in nz.org.riskscape.engine.function
-
Signals that an
IdentifiedFunction
supports different combinations of types. - OverwrittenOptionException(CommandLine, CommandLine.Model.ArgSpec, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.OverwrittenOptionException
- overwrittenOptionsAllowed() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- overwrittenOptionsAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
P
- Pair<L,
R> - Class in nz.org.riskscape.engine.util -
General purpose pair type
- Pair(L, R) - Constructor for class nz.org.riskscape.engine.util.Pair
- PARALLELIZABLE - Enum constant in enum class nz.org.riskscape.engine.pipeline.Collector.Characteristic
-
The collector can be parallelized by creating multiple accumulators and combining them before processing.
- Parameter - Class in nz.org.riskscape.engine.bind
-
Parameters are the inputs and toggles that ultimately control how Riskscape works.
- Parameter(String, Class<?>, Optional<BiFunction<BindingContext, Parameter, List<?>>>, int, int) - Constructor for class nz.org.riskscape.engine.bind.Parameter
- PARAMETER_IDENTIFIER - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- PARAMETER_UNKNOWN - Enum constant in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Attempt to add a value for a parameter that doesn't exist
- Parameter.MutableFields - Class in nz.org.riskscape.engine.bind
- parameterArity(Field) - Static method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns a new
Range
based on theCommandLine.Parameters.arity()
annotation on the specified field, or the field type's default arity if no arity was specified. - ParameterBinder - Interface in nz.org.riskscape.engine.bind
-
Interface for a class that can convert a string in to an object of a particular type
- ParameterBindingException - Exception in nz.org.riskscape.engine.bind
-
Thrown by
ParameterBinder
s when a value can not be converted to the desired type for some reason. - ParameterBindingException(Parameter, String, Object...) - Constructor for exception nz.org.riskscape.engine.bind.ParameterBindingException
- ParameterBindingException(Parameter, List<Problem>) - Constructor for exception nz.org.riskscape.engine.bind.ParameterBindingException
-
Build a binding exception that wraps a list of Problems, wrapping them in a
foundWith
error that includes the parameter as context - ParameterBindingException(Parameter, Problem) - Constructor for exception nz.org.riskscape.engine.bind.ParameterBindingException
- parameterConsumer() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the custom parameter handler for this option or positional parameter, or
null
. - parameterConsumer() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns a custom
IParameterConsumer
to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner, ornull
. - parameterConsumer() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Optionally specify a custom
IParameterConsumer
to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner. - parameterConsumer() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Optionally specify a custom
IParameterConsumer
to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner. - parameterConsumer(CommandLine.IParameterConsumer) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the parameterConsumer for this option or positional parameter, and returns this builder.
- parameterDescriptions - Variable in class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- ParameterException(CommandLine, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.ParameterException
-
Constructs a new ParameterException with the specified CommandLine and error message.
- ParameterException(CommandLine, String, Throwable) - Constructor for exception nz.org.riskscape.picocli.CommandLine.ParameterException
-
Constructs a new ParameterException with the specified CommandLine and error message.
- ParameterException(CommandLine, String, Throwable, CommandLine.Model.ArgSpec, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.ParameterException
-
Constructs a new ParameterException with the specified CommandLine and error message.
- ParameterException(CommandLine, String, CommandLine.Model.ArgSpec, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.ParameterException
-
Constructs a new ParameterException with the specified CommandLine and error message.
- parameterIndex(Field) - Static method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns a new
Range
based on theCommandLine.Parameters.index()
annotation on the specified field. - ParameterIndexGapException(String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.ParameterIndexGapException
- parameterLabelRenderer() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Option and positional parameter value label renderer used for the synopsis line(s) and the option list.
- parameterList() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the section of the usage help message that lists the parameters with their descriptions.
- parameterList(CommandLine.Help.Layout, CommandLine.Help.IParamLabelRenderer) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the section of the usage help message that lists the parameters with their descriptions.
- parameterListHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the parameters list.
- parameterListHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the parameter list.
- parameterListHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the positional parameter list; an empty string if there are no positional parameters, otherwise the result of
String.format(parameterListHeading, params)
. - parameterListHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional heading preceding the parameter list.
- ParameterProperty - Interface in nz.org.riskscape.engine.bind
-
Represents an expected property or 'trait' that the parameter should have, especially in terms of how a UI user should specify the parameter value.
- parameterRenderer - Variable in class nz.org.riskscape.picocli.CommandLine.Help.Layout
- ParameterReplacer - Class in nz.org.riskscape.pipeline.ast
-
An
ExpressionVisitor
that rewrites an expression by replacing any parameters it has found with substitutions from the visitor's map of replacements. - ParameterReplacer(Map<ParameterToken, Expression>) - Constructor for class nz.org.riskscape.pipeline.ast.ParameterReplacer
- parameters(CommandLine.Help.Ansi.IStyle...) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Adds the specified styles to the registered styles for positional parameters in this color scheme builder and returns this builder.
- ParameterSet - Class in nz.org.riskscape.engine.bind
-
A set of
Parameter
objects that are grouped together, typically as a set of required inputs for something that a user adds to their project. - ParameterSet(Collection<Parameter>) - Constructor for class nz.org.riskscape.engine.bind.ParameterSet
- parametersNotAllowed(ParameterToken) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Generic error that says that an expression is no good in the current context as parameters are not allowed, i.e.
- parameterStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme.Builder
-
Returns the registered styles for positional parameters in this color scheme builder.
- parameterStyles() - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns the registered styles for positional parameters in this color scheme.
- ParameterTemplate - Class in nz.org.riskscape.engine.bind
-
Contains the aspects of a parameter that the user can customize themselves.
- ParameterTemplate(Optional<String>, Optional<String>, Set<ParameterProperty>, List<ParameterTemplate.Choice>) - Constructor for class nz.org.riskscape.engine.bind.ParameterTemplate
- ParameterTemplate(Optional<String>, Optional<String>, Set<ParameterProperty>, List<ParameterTemplate.Choice>, Optional<String>) - Constructor for class nz.org.riskscape.engine.bind.ParameterTemplate
- ParameterTemplate.Choice - Class in nz.org.riskscape.engine.bind
-
A parameter can have a set of pre-defined choices, i.e.
- parameterText(String) - Method in class nz.org.riskscape.picocli.CommandLine.Help.ColorScheme
-
Returns a Text with all parameter styles applied to the specified parameter string.
- ParameterToken - Class in nz.org.riskscape.rl.ast
-
Represents an unresolved expression within a larger expression.
- ParameterToken(Token) - Constructor for class nz.org.riskscape.rl.ast.ParameterToken
- paramLabel() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the name of the option or positional parameter used in the usage help message.
- paramLabel() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the name of the option or positional parameter used in the usage help message.
- paramLabel() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Specify a
paramLabel
for the option parameter to be used in the usage help message. - paramLabel() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Specify a
paramLabel
for the parameter to be used in the usage help message. - paramLabel(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the name of the option or positional parameter used in the usage help message, and returns this builder.
- ParamProblems - Interface in nz.org.riskscape.engine.bind
- parent() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the parent command of this subcommand, or
null
if this is a top-level command. - parent(String) - Method in class nz.org.riskscape.engine.types.Struct
- parent(CommandLine.Model.CommandSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets the parent command of this subcommand.
- parentCommandElements() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the list of program elements annotated with
{@literal @}ParentCommand
configured for this command. - parentGroup() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the parent group that this group is part of, or
null
if this group is not part of a composite. - parse(String) - Method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
-
Convenience method for parsing an rl expression in to an
Expression
ast. - parse(String) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
-
Parses the specified comma-separated sequence of style descriptors and returns the associated styles.
- parse(String) - Method in class nz.org.riskscape.rl.ExpressionParser
-
Parses the given string in to an
Expression
. - parse(String...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.parseArgs(String...)
instead - parseAllowParameters(String) - Method in class nz.org.riskscape.rl.ExpressionParser
-
A version of
ExpressionParser.parse(String)
that allows the expression to containParameterToken
s. - parseArgs(String...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Parses the specified command line arguments and returns a list of
ParseResult
with the options, positional parameters, and subcommands (if any) that were recognized and initialized during the parsing process. - parseError(Object) - Static method in class nz.org.riskscape.problem.Problems
-
Produces an error: "Failed to parse [expectedThing]' E.g.
- ParseException - Exception in nz.org.riskscape.dsl
-
Base exception thrown when converting a sequence of tokens from a
Lexer
in to an abstract syntax tree. - ParseException(Problem) - Constructor for exception nz.org.riskscape.dsl.ParseException
- parseExpression(Lexer<TokenTypes>) - Method in class nz.org.riskscape.rl.ExpressionParser
- parseFunctionExpression(Lexer<TokenTypes>) - Method in class nz.org.riskscape.rl.ExpressionParser
- parseIf(String, List<Set<? extends TokenType>>, Supplier<T>) - Static method in class nz.org.riskscape.dsl.ConditionalParse
-
Construct a
ConditionalParse
that matches a sequence of possible tokens. - parseIfIs(String, List<? extends TokenType>, Supplier<T>) - Static method in class nz.org.riskscape.dsl.ConditionalParse
-
Convenience version of parseIf where the next sequence of tokens needs to match the sequence of token types in
nextTokens
- parseIfIs(String, TokenType, Supplier<T>) - Static method in class nz.org.riskscape.dsl.ConditionalParse
-
Convenience version of parseIf where the next token has to be exactly the given token.
- parseIfOneOf(String, Set<? extends TokenType>, Supplier<T>) - Static method in class nz.org.riskscape.dsl.ConditionalParse
-
Convenience version of
ConditionalParse.parseIf(String, List, Supplier)
with a singleton list. - parseOr(String) - Method in class nz.org.riskscape.rl.ExpressionParser
-
Convenience method to catch any exceptions from parsing the expression and return them as a
ResultOrProblem
- parsePipeline(String) - Method in class nz.org.riskscape.pipeline.PipelineParser
-
Parses a pipeline from the DSL
- parsePipelineAllowParameters(String) - Method in class nz.org.riskscape.pipeline.PipelineParser
-
Parses a pipeline from the DSL, allowing $parameters to appear in the sauce
- parsePrj(String) - Method in interface nz.org.riskscape.engine.geo.PrjParser
- parsePropertyExpression(Lexer<TokenTypes>, Optional<Expression>) - Method in class nz.org.riskscape.rl.ExpressionParser
- parser() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the parser specification for this command.
- parser(CommandLine.Model.ParserSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Initializes the parser specification for this command from the specified settings and returns this commandSpec.
- ParserSpec() - Constructor for class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- parseString(String) - Static method in class nz.org.riskscape.rl.ExpressionParser
-
Convenience form of
new ExpressionParser().parse(source)
- parseWithHandler(CommandLine.IParseResultHandler2<R>, String[]) - Method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - parseWithHandlers(CommandLine.IParseResultHandler2<R>, CommandLine.IExceptionHandler2<R>, String...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
andCommandLine.getExecutionResult()
instead - PartialStructRule - Class in nz.org.riskscape.engine.types.eqrule
- PartialStructRule() - Constructor for class nz.org.riskscape.engine.types.eqrule.PartialStructRule
- peek() - Method in class nz.org.riskscape.dsl.Lexer
- peekType() - Method in class nz.org.riskscape.dsl.Lexer
- pick(List<?>) - Static method in class nz.org.riskscape.engine.util.RandomUtils
-
Picks an item randomly from the given list.
- pick(List<?>, List<Double>) - Static method in class nz.org.riskscape.engine.util.RandomUtils
-
Picks an item based on a weighted random choice.
- PicocliException(String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.PicocliException
- PicocliException(String, Throwable) - Constructor for exception nz.org.riskscape.picocli.CommandLine.PicocliException
- Pipeline - Class in nz.org.riskscape.engine.pipeline
-
A user-configurable data processing pipeline for performing hazard analysis.
- Pipeline(PipelineDeclaration) - Constructor for class nz.org.riskscape.engine.pipeline.Pipeline
- Pipeline.ProblemCodes - Enum Class in nz.org.riskscape.engine.pipeline
- PipelineCycleException - Exception in nz.org.riskscape.engine.pipeline
-
Thrown when a cycle is detected in a pipeline
- PipelineCycleException(String) - Constructor for exception nz.org.riskscape.engine.pipeline.PipelineCycleException
- PipelineDeclaration - Class in nz.org.riskscape.pipeline.ast
-
AST for a pipeline declaration - the root of the AST.
- PipelineDeclaration(List<StepChain>) - Constructor for class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Construct a new
PipelineDeclaration
without any metadata. - PipelineDeclaration(List<StepChain>, PipelineMetadata) - Constructor for class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- PipelineDeclaration.Found - Class in nz.org.riskscape.pipeline.ast
-
Simple value holder for the results of finding a step via the
PipelineDeclaration.find(BiPredicate)
method. - PipelineDefinitionException - Exception in nz.org.riskscape.engine.pipeline
-
Thrown by
Pipeline
when adding edges or steps to a pipeline. - PipelineDefinitionException(Pipeline, Problem) - Constructor for exception nz.org.riskscape.engine.pipeline.PipelineDefinitionException
- pipelineDescription - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- PipelineExecutor - Interface in nz.org.riskscape.engine.pipeline
- PipelineExpression - Interface in nz.org.riskscape.pipeline.ast
- pipelineId - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- PipelineJobContext - Interface in nz.org.riskscape.engine.output
-
Bits and pieces that are all relevant to the execution of a specific pipeline (aka A job) as it is being executed (or prepared for execution) as per the users wishes.
- PipelineMetadata - Class in nz.org.riskscape.pipeline
-
Some basic metadata that can be associated with a pipeline
- PipelineMetadata(URI, String, String) - Constructor for class nz.org.riskscape.pipeline.PipelineMetadata
- PipelineOutputContainer - Interface in nz.org.riskscape.engine.output
-
A container for storing outputs from a pipeline run.
- PipelineOutputOptions - Class in nz.org.riskscape.engine.output
-
Contains user specified options to use when saving results from a pipeline execution.
- PipelineOutputOptions(String) - Constructor for class nz.org.riskscape.engine.output.PipelineOutputOptions
- PipelineOutputStore - Interface in nz.org.riskscape.engine.output
-
Defines an output store that is able to store the results of pipeline execution, aka a pipeline job.
- PipelineOutputStores - Interface in nz.org.riskscape.engine.output
- PipelineParser - Class in nz.org.riskscape.pipeline
- PipelineParser() - Constructor for class nz.org.riskscape.pipeline.PipelineParser
- PipelineProblems - Interface in nz.org.riskscape.engine.pipeline
-
Factory for producing problems that involve pipelines or pipeline steps.
- PipelineSteps - Class in nz.org.riskscape.engine.pipeline
- PipelineSteps() - Constructor for class nz.org.riskscape.engine.pipeline.PipelineSteps
- plainString() - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns the plain text without any formatting.
- Plugin - Class in nz.org.riskscape.engine.plugin
-
A Riskscape Plugin.
- Plugin(PluginDescriptor) - Constructor for class nz.org.riskscape.engine.plugin.Plugin
- PluginDescriptor - Interface in nz.org.riskscape.engine.plugin
-
Contains meta data and standard methods for integrating a plugin's code base in to RiskScape
- PluginFeature - Interface in nz.org.riskscape.engine.plugin
-
Marker interface for any code that implements a feature that should be registered with an
ExtensionPoint
- PluginRuntimeException - Exception in nz.org.riskscape.engine.plugin
-
PluginRuntimeException
are thrown when the plugin system fails to initialize or start a plugin - PluginRuntimeException(String, Object...) - Constructor for exception nz.org.riskscape.engine.plugin.PluginRuntimeException
- PluginRuntimeException(Throwable, String, Object...) - Constructor for exception nz.org.riskscape.engine.plugin.PluginRuntimeException
- PluginRuntimeException(PluginDescriptor, Throwable, String, Object...) - Constructor for exception nz.org.riskscape.engine.plugin.PluginRuntimeException
- PLUS - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- Point() - Constructor for class nz.org.riskscape.engine.types.GeomType.Point
- POINT - Static variable in class nz.org.riskscape.engine.types.Types
- POINTER - Enum constant in enum class nz.org.riskscape.engine.pipeline.NestedPipelineStep.State
-
NestedPipelineStep.getNestedPipeline()
will return a pipeline with just an id set. - pointlessSelectAll(PropertyAccess) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
The user has done something like
bar.*
outside of a struct, which makes no sense - pointlessSelectAllInStruct(StructDeclaration.Member) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
The user has done something like
{foo: bar.*}
which is probably a mistake - it should be either{bar.*}
or{foo: bar}
- Polygon() - Constructor for class nz.org.riskscape.engine.types.GeomType.Polygon
- POLYGON - Static variable in class nz.org.riskscape.engine.types.Types
- POLYGONAL - Enum constant in enum class nz.org.riskscape.engine.geo.GeometryFamily
- populate(Pipeline) - Method in interface nz.org.riskscape.engine.pipeline.NestedPipelineStep
-
Update this nested pipeline to have values from populateUsing - this is a slight contradiction to the otherwise immutable-ness of steps, but is counter-acted with some explicit state tracking to prevent accidental or improper mutation during construction.
- populateCommand(T, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
- POPULATED - Enum constant in enum class nz.org.riskscape.engine.pipeline.NestedPipelineStep.State
-
NestedPipelineStep.getNestedPipeline()
will return a fully populated pipeline that is ready to be realized - populateSpec(Class<T>, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
- positionalParameters() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the list of positional parameters configured for this group.
- positionalParameters() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the list of positional parameters configured for this command.
- posixClusteredShortOptionsAllowed() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- posixClusteredShortOptionsAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- posixOptionsMap() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns a map of the short (single character) option names to option spec objects configured for this command.
- POW - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- precisionLoss(Number, Number) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
- prefixAll - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem.ToStringOptions
-
All problem lines begin with this string
- prefixChildren - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem.ToStringOptions
-
All children have this applied once after any indenting
- prepend(T, List<? extends T>) - Static method in class nz.org.riskscape.util.ListUtils
-
Fluid, immutable list prepending method that prepends the given element to the given list, returning a new list
- prepend(T, T...) - Static method in class nz.org.riskscape.util.ListUtils
-
Fluid, immutable list prepending method that prepends the given element to the given list, returning a new list
- print(Object) - Method in class nz.org.riskscape.cli.AnsiPrintStream
-
Print the given object's toString representation raw (no ansi escaping) to the underlying stream.
- print(String, Object...) - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
-
Convenience console error printing method, See
String.format(String, Object...)
- printerr(String, Object...) - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
-
Convenience console error printing method, See
String.format(String, Object...)
- printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.Ansi) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.executeHelpRequest(ParseResult)
instead - printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.ColorScheme) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.executeHelpRequest(ParseResult)
instead - printHelpIfRequested(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.printHelpIfRequested(ParseResult)
instead - printHelpIfRequested(CommandLine.ParseResult) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Delegates to
CommandLine.executeHelpRequest(ParseResult)
. - println() - Method in class nz.org.riskscape.cli.AnsiPrintStream
-
Print a new line to the underlying stream
- println(Object) - Method in class nz.org.riskscape.cli.AnsiPrintStream
-
Print the given object's toString representation raw (no ansi escaping) to the underlying stream.
- println(Object) - Method in interface nz.org.riskscape.cli.Terminal
-
Prints a line of text to the console with a new line after, returning an ansi print stream in case you want to print more
- printlnMarkup(String) - Method in class nz.org.riskscape.cli.AnsiPrintStream
-
Print the given text to the underlying stream, parsing picocli markup and converting it to have the correct escape codes.
- printlnStyles(String, CommandLine.Help.Ansi.Style...) - Method in class nz.org.riskscape.cli.AnsiPrintStream
-
Print the given text to the underlying stream, wrapping it in the given styles (if supported).
- printMarkup(String) - Method in class nz.org.riskscape.cli.AnsiPrintStream
-
Print the given text to the underlying stream, parsing picocli markup and converting it to have the correct escape codes
- printProblems(List<Problem>) - Method in interface nz.org.riskscape.cli.Terminal
-
Prints an array of problems using the given terminal's problem logging mechanism.
- printProblems(Problem...) - Method in interface nz.org.riskscape.cli.Terminal
-
Prints an array of problems using the given terminal's problem logging mechanism.
- printStackTrace(PrintStream) - Method in exception nz.org.riskscape.engine.pipeline.AutoClosingException
- printStackTrace(PrintWriter) - Method in exception nz.org.riskscape.engine.pipeline.AutoClosingException
- printStyles(String, CommandLine.Help.Ansi.IStyle...) - Method in class nz.org.riskscape.cli.AnsiPrintStream
-
Print the given text to the underlying stream, wrapping it in the given styles (if supported)
- printSuggestions(PrintStream) - Method in exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
-
Returns
true
and prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse
. - printSuggestions(PrintWriter) - Method in exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
-
Returns
true
and prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse
. - printSuggestions(CommandLine.ParameterException, PrintStream) - Static method in exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
-
Returns
true
and prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse
. - printSuggestions(CommandLine.ParameterException, PrintWriter) - Static method in exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
-
Returns
true
and prints suggested solutions to the specified writer if such solutions exist, otherwise returnsfalse
. - printVersionHelp(PrintStream) - Method in class nz.org.riskscape.picocli.CommandLine
-
Delegates to
CommandLine.printVersionHelp(PrintStream, Help.Ansi)
with the ANSI setting of the configured color scheme. - printVersionHelp(PrintStream, CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine
-
Prints version information from the
CommandLine.Command.version()
annotation to the specifiedPrintStream
. - printVersionHelp(PrintStream, CommandLine.Help.Ansi, Object...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Prints version information from the
CommandLine.Command.version()
annotation to the specifiedPrintStream
. - printVersionHelp(PrintWriter) - Method in class nz.org.riskscape.picocli.CommandLine
-
Delegates to
CommandLine.printVersionHelp(PrintWriter, Help.Ansi, Object...)
with the ANSI setting of the configured color scheme. - printVersionHelp(PrintWriter, CommandLine.Help.Ansi, Object...) - Method in class nz.org.riskscape.picocli.CommandLine
-
Prints version information from the
CommandLine.Command.version()
annotation to the specifiedPrintWriter
. - PRIORITY - Static variable in class nz.org.riskscape.rl.ast.BinaryOperation
- PRIORITY_DEFAULT - Static variable in interface nz.org.riskscape.engine.output.PipelineOutputStore
- PRIORITY_HIGH - Static variable in interface nz.org.riskscape.engine.output.PipelineOutputStore
- PRIORITY_NA - Static variable in interface nz.org.riskscape.engine.output.PipelineOutputStore
- PrjParser - Interface in nz.org.riskscape.engine.geo
-
Spi for plugins that can parse prj files.
- Problem - Class in nz.org.riskscape.problem
-
Class used for describing errors and other issues with user defined input.
- Problem(List<Problem>, Problem.Severity, String, Object[]) - Constructor for class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- Problem(List<Problem>, ProblemCode, Object...) - Constructor for class nz.org.riskscape.problem.Problem
- Problem(Problem.Severity, String) - Constructor for class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- Problem(Problem.Severity, String, Object[], Throwable) - Constructor for class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- Problem(Problem.Severity, String, Object[], Throwable, ProblemCode, Problem.AffectedMetadata, List<Problem>) - Constructor for class nz.org.riskscape.problem.Problem
- Problem(Problem.Severity, ProblemCode, Object...) - Constructor for class nz.org.riskscape.problem.Problem
-
Same as
Problem.error(ProblemCode, Object...)
, but where you need to use a different severity, e.g. - Problem.Severity - Enum Class in nz.org.riskscape.problem
- ProblemCode - Interface in nz.org.riskscape.problem
-
Interface for enums that describe a set of
ProblemCode
s - seeStandardCodes
for an example. - ProblemCodes - Enum Class in nz.org.riskscape.dsl
- ProblemException - Exception in nz.org.riskscape.problem
-
Thrown from
ResultOrProblems.getOrThrow()
as an alternative to using functional style flow control in your code withResultOrProblems
. - ProblemException(List<Problem>) - Constructor for exception nz.org.riskscape.problem.ProblemException
- ProblemException(Problem...) - Constructor for exception nz.org.riskscape.problem.ProblemException
-
Create a new
ProblemException
- ProblemException.Call<T> - Interface in nz.org.riskscape.problem
-
A function call that will either return an object or throw a
ProblemException
. - ProblemFactory - Interface in nz.org.riskscape.engine.problem
-
Indicates that a particular interface is solely used for generating
Problem
s. - ProblemFactoryProxy - Class in nz.org.riskscape.engine.problem
-
Works as a Proxy for a given
ProblemFactory
- ProblemFactoryProxy() - Constructor for class nz.org.riskscape.engine.problem.ProblemFactoryProxy
- ProblemFactoryProxy.JavaMethodCode - Class in nz.org.riskscape.engine.problem
- ProblemPlaceholder - Class in nz.org.riskscape.engine.problem
-
A convenient placeholder when constructing a
Problem
's args. - ProblemPlaceholder(String, Class<?>) - Constructor for class nz.org.riskscape.engine.problem.ProblemPlaceholder
- Problems - Class in nz.org.riskscape.problem
-
Helper for generating Problem objects.
- Problems() - Constructor for class nz.org.riskscape.problem.Problems
- PROBLEMS_FOUND - Enum constant in enum class nz.org.riskscape.problem.StandardCodes
- ProblemSink - Interface in nz.org.riskscape.problem
-
A place for problems to fall down when the user should know about them, but they're not going to stop execution.
- process() - Method in interface nz.org.riskscape.engine.rl.agg.Accumulator
-
Convert accumulated state in to a single value.
- process(T) - Method in interface nz.org.riskscape.engine.pipeline.Collector
-
Convert an accumulator in to a set of results.
- process(T) - Method in interface nz.org.riskscape.engine.pipeline.StreamingCollector
-
Convert an accumulator in to a set of results.
- project(Projection) - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- project(Projection) - Method in interface nz.org.riskscape.engine.relation.Relation
- Project - Interface in nz.org.riskscape.engine
-
Contains Riskscape project resources, such as: - types - functions - models - bookmarks
- Projection - Interface in nz.org.riskscape.engine.projection
-
A projection is a view of some underlying relation, where each tuple is potentially transformed.
- Projector - Interface in nz.org.riskscape.engine.projection
-
Realized
Projection
of oneStruct
to another. - projectType(Struct) - Method in interface nz.org.riskscape.engine.projection.Projection
- PropertiesDefaultProvider() - Constructor for class nz.org.riskscape.picocli.CommandLine.PropertiesDefaultProvider
-
Default constructor, used when this default value provider is specified in the annotations:
- PropertiesDefaultProvider(File) - Constructor for class nz.org.riskscape.picocli.CommandLine.PropertiesDefaultProvider
-
This constructor loads default values from the specified properties file.
- PropertiesDefaultProvider(Properties) - Constructor for class nz.org.riskscape.picocli.CommandLine.PropertiesDefaultProvider
-
This constructor loads default values from the specified properties object.
- PropertyAccess - Class in nz.org.riskscape.rl.ast
-
Property access represents an indexing of the scope or another expression, e.g.
- PropertyAccess(Optional<Expression>, List<Token>) - Constructor for class nz.org.riskscape.rl.ast.PropertyAccess
- propertyOutsideOfAggregationFunction(PropertyAccess) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
returned when an aggregate expression has property access expressions that aren't within an aggregate function
- PROTOCOL_BASED - Enum constant in enum class nz.org.riskscape.engine.output.Format.Characteristics
-
This format doesn't read/write bytes to some sort of file (or files), e.g.
- PseudoResource(URI) - Constructor for class nz.org.riskscape.engine.resource.Resource.PseudoResource
- PUNTAL - Enum constant in enum class nz.org.riskscape.engine.geo.GeometryFamily
- putValue(int, int, CommandLine.Help.Ansi.Text) - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Writes the specified value into the cell at the specified row and column and returns the last row and column written to.
Q
- qualifiedName() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the String to use as the program name in the synopsis line of the help message: this command's
name
, preceded by the qualified name of the parent command, if any, separated by a space. - qualifiedName(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns this command's fully qualified name, which is its
name
, preceded by the qualified name of the parent command, if this command has a parent command. - queryWithHints(Query, CoordinateReferenceSystem) - Method in class nz.org.riskscape.engine.SRIDSet
- quit() - Static method in exception nz.org.riskscape.engine.cli.ExitException
-
Throw an
ExitException
that will cause riskscape to exit immediately without error - QUOTED_IDENTIFIER - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- quoteIdent(String) - Static method in enum class nz.org.riskscape.rl.TokenTypes
- quoteText(String) - Static method in enum class nz.org.riskscape.rl.TokenTypes
- quoteTextIfNeeded(String) - Static method in enum class nz.org.riskscape.rl.TokenTypes
-
Will wrap text in single quotes if it is not already so that it could be parsed as a Riskscape string literal expression.
R
- RandomSingleton - Class in nz.org.riskscape.engine
-
A global source of randomness for a riskscape process to aid reproducability of results
- RandomSingleton() - Constructor for class nz.org.riskscape.engine.RandomSingleton
- RandomUtils - Class in nz.org.riskscape.engine.util
-
Helper functions for generating random numbers or sampling from random distributions.
- RandomUtils() - Constructor for class nz.org.riskscape.engine.util.RandomUtils
- range(String, Class<T>, int, int) - Static method in class nz.org.riskscape.engine.bind.Parameter
-
Constructs a
Parameter
with a specific min and max number of parameters and no defaults - Range(int, int, boolean, boolean, String) - Constructor for class nz.org.riskscape.picocli.CommandLine.Range
-
Constructs a new Range object with the specified parameters.
- Rangeable - Interface in nz.org.riskscape.engine.types
-
Marker interface to say that the underlying java representation of a type is
Comparable
- rawValue() - Method in class nz.org.riskscape.dsl.Token
- RBRACE - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- RBRACK - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- read(ByteBuffer) - Method in interface nz.org.riskscape.engine.io.TypeIO
-
Read a value from the given byte buffer
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Anything
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Bool
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Date
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Decimal
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Floating
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Geom
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.GeomType
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Integer
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Nothing
- read(ByteBuffer) - Method in class nz.org.riskscape.engine.types.Text
- read(Struct) - Method in interface nz.org.riskscape.engine.io.TupleReader
-
Read a
Tuple
of the given type from the underlying stream. - readAccessDenied(URI) - Method in interface nz.org.riskscape.engine.resource.ResourceProblems
- READER - Static variable in class nz.org.riskscape.engine.types.Geom
- readline() - Method in interface nz.org.riskscape.cli.Terminal
- ReadlineInterruptedException - Exception in nz.org.riskscape.engine.cli
-
Special case ExitException that is thrown from
Terminal#readline()
when a userctrl-c
s when entering text. - ReadlineInterruptedException() - Constructor for exception nz.org.riskscape.engine.cli.ReadlineInterruptedException
- realizableDidNotMatch(Class<?>, List<Type>) - Method in interface nz.org.riskscape.engine.ArgsProblems
- realizableDidNotMatch(IdentifiedFunction, List<Type>) - Method in interface nz.org.riskscape.engine.ArgsProblems
- RealizableFunction - Interface in nz.org.riskscape.engine.rl
-
An interface for functions to indicate that they can be realized for a particular set of input arguments in a riskscape language expression.
- RealizableFunction.MetadataIdentifiedRealizableFunction - Class in nz.org.riskscape.engine.rl
- RealizationContext - Interface in nz.org.riskscape.engine.rl
-
Access to contextual bits and pieces in which realization is going to happen - this metadata will also be relevant for the eventual execution of an
Expression
and can be passed through to anyRealizedExpression
s and their dependents that result from realization. - RealizationInput - Interface in nz.org.riskscape.engine.pipeline
- realize(ExecutionContext) - Method in class nz.org.riskscape.engine.model.BaseModel2
- realize(ExecutionContext) - Method in interface nz.org.riskscape.engine.model.Model
-
Produces an executable pipeline that will 'run' the model and produce results.
- realize(ExecutionContext, Pipeline) - Method in interface nz.org.riskscape.engine.pipeline.PipelineExecutor
- realize(Pipeline) - Method in interface nz.org.riskscape.engine.pipeline.ExecutionContext
-
Convenience method for realizing a pipeline using this
ExecutionContext
. - realize(RealizationInput) - Method in class nz.org.riskscape.engine.pipeline.NamedStep
- realize(RealizationInput) - Method in class nz.org.riskscape.engine.pipeline.NullStep
- realize(RealizationInput) - Method in interface nz.org.riskscape.engine.pipeline.Step
-
Does the parameter validation required to produce an functor for the next
Step
. - realize(RealizationContext, Type, FunctionCall) - Method in interface nz.org.riskscape.engine.rl.agg.AggregationFunction
-
Realize this function so that it can be called (via an Accumulator)
- realize(RealizationContext, FunctionCall, List<Type>) - Method in class nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter
- realize(RealizationContext, FunctionCall, List<Type>) - Method in interface nz.org.riskscape.engine.rl.RealizableFunction
-
Attempt to adapt a function call to the given types.
- realize(Type, String) - Method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
- realize(Type, Expression) - Method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
- realizeAggregate(Type, Expression) - Method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
- realizeConstant(String) - Method in interface nz.org.riskscape.engine.rl.RealizationContext
-
Convenience function for going straight from an expression string to a realized expression
- realizeConstant(Expression) - Method in interface nz.org.riskscape.engine.rl.ExpressionRealizer
-
Attempts to realize the given expression against an empty struct, returning a meaningful problem if it looks like it failed to realize because it had property access problems (meaning it wasn't constant as it relies on the input scope)
- Realized - Interface in nz.org.riskscape.engine.pipeline
-
Marker interface for other interfaces that can be returned from a
Step.realize(RealizationInput)
. - RealizedAggregateExpression - Interface in nz.org.riskscape.engine.rl.agg
-
An expression that can be evaluated across many inputs to eventually yield a single 'scalar' result
- RealizedExpression - Interface in nz.org.riskscape.engine.rl
-
Represents an Expression that has been realized against a specific RiskScape type.
- RealizedPipeline - Class in nz.org.riskscape.engine.pipeline
- RealizedPipeline(ExecutionContext, Pipeline, List<RealizedStep>) - Constructor for class nz.org.riskscape.engine.pipeline.RealizedPipeline
- RealizedStep - Class in nz.org.riskscape.engine.pipeline
-
A
Step
that has been realized, such that it has produced valid output. - RealizedStep(NamedStep, ResultOrProblems<? extends Realized>, Map<String, List<?>>, List<RealizedStep>, Struct) - Constructor for class nz.org.riskscape.engine.pipeline.RealizedStep
- Reference<T> - Interface in nz.org.riskscape.engine
- Referenced - Class in nz.org.riskscape.engine.types
-
Type that adds
CoordinateReferenceSystem
and an optional bounds to another type. - Referenced(Type, CoordinateReferenceSystem) - Constructor for class nz.org.riskscape.engine.types.Referenced
-
Convenience constructor that omits the bounds from the Referenced type.
- Referenced(Type, CoordinateReferenceSystem, Envelope) - Constructor for class nz.org.riskscape.engine.types.Referenced
-
Create a new Referenced type that wraps the given type with a crs and a bounds envelope.
- Referenced(Type, ReferencedEnvelope) - Constructor for class nz.org.riskscape.engine.types.Referenced
-
Convenience constructor that takes the crs and bounds from the given referenced envelope
- ReferencedAncestorRule - Class in nz.org.riskscape.engine.types.ancestor
-
Allows two Referenced geometry types to be ancestors, maintaining their
Referenced
wrapping type so long as they are in the same CRS. - ReferencedAncestorRule() - Constructor for class nz.org.riskscape.engine.types.ancestor.ReferencedAncestorRule
- ReflectionUtils - Class in nz.org.riskscape
- ReflectionUtils() - Constructor for class nz.org.riskscape.ReflectionUtils
- ReflectionUtils.SearchOptions - Enum Class in nz.org.riskscape
- registerCollection(IdentifiedCollection<?>) - Method in interface nz.org.riskscape.engine.Engine.Writeable
- registerConverter(Class<K>, CommandLine.ITypeConverter<K>) - Method in class nz.org.riskscape.picocli.CommandLine
-
Registers the specified type converter for the specified class.
- Relation - Interface in nz.org.riskscape.engine.relation
- RelationIOException - Exception in nz.org.riskscape.engine.relation
- RelationIOException(Relation, String, IOException) - Constructor for exception nz.org.riskscape.engine.relation.RelationIOException
- RelationType - Class in nz.org.riskscape.engine.types
-
Represents a
Relation
using Riskscape's type system. - RelationType(Struct) - Constructor for class nz.org.riskscape.engine.types.RelationType
- remaining() - Method in class nz.org.riskscape.dsl.Lexer
- remember(SimpleFeatureSource) - Method in class nz.org.riskscape.engine.SRIDSet
- remove() - Method in interface nz.org.riskscape.engine.io.TupleWriter
-
Remove the output that this writer may have created
- remove(String) - Method in class nz.org.riskscape.engine.Tuple
-
Clears a value from the tuple
- remove(Struct.StructMember) - Method in class nz.org.riskscape.engine.Tuple
-
Clears a value from the tuple
- remove(String) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- remove(String) - Method in interface nz.org.riskscape.engine.IdentifiedCollection
-
Removes an object from the collection
- remove(CommandLine.Model.ArgSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
(INCUBATING) Removes the specified option spec or positional parameter spec from the list of configured arguments to expect.
- removeAll(Collection<T>) - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base
- removePattern(String) - Method in class nz.org.riskscape.picocli.CommandLine.RegexTransformer.Builder
-
Removes the negative replacement and synopsis replacement for the specified regular expression.
- render(Messages, Object, Locale) - Method in interface nz.org.riskscape.engine.i18n.ObjectRenderer
-
Generate a localized string for an object
- render(CommandLine.Help) - Method in interface nz.org.riskscape.picocli.CommandLine.IHelpSectionRenderer
-
Renders a section of the usage help, like header heading, header, synopsis heading, synopsis, description heading, description, etc.
- render(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in interface nz.org.riskscape.picocli.CommandLine.Help.IOptionRenderer
-
Returns a text representation of the specified option and its parameter(s) if any.
- render(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in interface nz.org.riskscape.picocli.CommandLine.Help.IParameterRenderer
-
Returns a text representation of the specified positional parameter.
- renderedDescription() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Deprecated.Use
CommandLine.Model.ArgSpec.description()
instead - RenderedProblem - Class in nz.org.riskscape.engine.i18n
-
Returned from
Messages.renderProblem(Problem, java.util.Locale)
to translate a problem while maintaining its tree structure. - RenderedProblem(String, Problem) - Constructor for class nz.org.riskscape.engine.i18n.RenderedProblem
- RenderedProblem(String, Problem, int, List<RenderedProblem>) - Constructor for class nz.org.riskscape.engine.i18n.RenderedProblem
- RenderedProblem.ToStringOptions - Class in nz.org.riskscape.engine.i18n
-
Used for customizing the output of toString
- renderObject(Object, Locale) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Turn a java object in to something that can be displayed as a simple, brief bit of text, serving as a plug-able, translatable-toString mechanism for for RiskScape
- renderParameterLabel(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi, List<CommandLine.Help.Ansi.IStyle>) - Method in interface nz.org.riskscape.picocli.CommandLine.Help.IParamLabelRenderer
-
Returns a text rendering of the option parameter or positional parameter; returns an empty string
""
if the option is a boolean and does not take a parameter. - renderProblem(Throwable) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Convenience form for
renderProblem(Problems.caught(throwable), Locale.getDefault())
- renderProblem(Throwable, Locale) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Convenience form for
renderProblem(Problems.caught(throwable), locale)
- renderProblem(Problem) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Convenience form for
renderProblem(problem, Locale.getDefault())
- renderProblem(Problem, Locale) - Method in interface nz.org.riskscape.engine.i18n.Messages
-
Turn a
Problem
in to aRenderedProblem
- from there it can be transformed in to a string or otherwise. - replace(StepChain, StepChain) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Return a new
PipelineDeclaration
, with a replacement step chain - replace(String, Type) - Method in class nz.org.riskscape.engine.types.Struct
- replaceParameters(Map<ParameterToken, Expression>) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Builds a new PipelineDeclaration by replacing tokens with those specified, while trying to preserve whitespace
- reproject(Geometry, int) - Method in class nz.org.riskscape.engine.SRIDSet
-
Reprojects geom to be in the targetSrid.
- reproject(Geometry, MathTransform, CoordinateReferenceSystem, CoordinateReferenceSystem) - Method in class nz.org.riskscape.engine.SRIDSet
-
Reprojects geom using the supplied
MathTransform
and applies standard rules for the fixing and logging of geometry that may become invalid during the reprojection. - reprojectionIgnoringDatumShift(CoordinateReferenceSystem, CoordinateReferenceSystem) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
When a reprojection transform will ignore datum shifts.
- required() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns whether this is a required option or positional parameter.
- required() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns whether this is a required option or positional parameter without a default value.
- required() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Indicates whether this option is required.
- required(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets whether this is a required option or positional parameter, and returns this builder.
- required(Object) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Produces error: '
thing
' was required but not found - required(String) - Method in interface nz.org.riskscape.engine.ArgsProblems
-
A required keyword argument is not present
- required(String, Class<?>) - Static method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
Produces error: '
name
'typeOfThing
was required but not found. - required(String, Class<T>) - Static method in class nz.org.riskscape.engine.bind.Parameter
- required(String, Class<T>, T) - Static method in class nz.org.riskscape.engine.bind.Parameter
- requiredArgs() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the required options and positional parameters in this group; may be empty but not
null
. - requiredArgs() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the list of required options and positional parameters configured for this command.
- requiredOptionMarker() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Prefix required options with this character in the options list.
- requiredOptionMarker() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the character used to prefix required options in the options list.
- requiredOptionMarker(char) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the character used to prefix required options in the options list.
- requiresNamedInputs() - Method in class nz.org.riskscape.engine.pipeline.NamedStep
- requiresOneOf(Object, List<Type>, Type) - Method in interface nz.org.riskscape.engine.types.TypeProblems
-
When affected requires one of allowedTypes, but actual was provided.
- requiresReprojection(CoordinateReferenceSystem, CoordinateReferenceSystem) - Method in class nz.org.riskscape.engine.SRIDSet
-
Test if
Geometry
s in the inputCoordinateReferenceSystem
s would need to be reprojected before geometry operations could be performed accurately. - reset - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- resetOriginalStringValues() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Sets the
originalStringValues
to a new list instance. - resetStringValues() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Sets the
stringValues
to a new list instance. - resolve(Bookmark, BindingContext) - Method in interface nz.org.riskscape.engine.data.BookmarkResolver
- resolve(Bookmark, BindingContext) - Method in interface nz.org.riskscape.engine.data.BookmarkResolvers
-
Resolves a
Bookmark
without doing any error checking beyond asserting that aBookmarkResolver
appears to be able to access the data behind thisBookmark
. - resolve(RealizationContext, BinaryOperation, Type, Type, Type) - Method in interface nz.org.riskscape.engine.function.OperatorResolver
-
Attempt to find a
RiskscapeFunction
that can compute the givenBinaryOperation
- resolve(RealizationContext, BinaryOperation, Type, Type, Type) - Method in interface nz.org.riskscape.engine.FunctionSet
- resolve(RealizationContext, FunctionCall, Type, List<Type>, FunctionResolver) - Method in interface nz.org.riskscape.engine.FunctionSet
- resolve(RealizationContext, FunctionCall, Type, List<Type>, IdentifiedFunction) - Method in interface nz.org.riskscape.engine.function.FunctionResolver
-
Attempt to resolve a function against the given criteria.
- resolveAndValidate(Bookmark, BindingContext, Class<?>) - Method in interface nz.org.riskscape.engine.data.BookmarkResolvers
-
Alternative to getData that returns the
ResolvedBookmark
rather than the given data. - ResolvedBookmark - Interface in nz.org.riskscape.engine.data
-
Links a
Bookmark
to aBookmarkResolver
in order to access the useful data. - Resource - Interface in nz.org.riskscape.engine.resource
-
Represents a file type resource in a way that allows where the resource is from to be decoupled from how it is accessed.
- Resource.Options - Class in nz.org.riskscape.engine.resource
- Resource.PseudoResource - Class in nz.org.riskscape.engine.resource
-
A resource that can not be opened but is still useful for identifying some content.
- resourceBundle() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the base name of the ResourceBundle to find option and positional parameters descriptions, as well as usage help message sections and section headings.
- resourceBundle() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the resource bundle for this command.
- resourceBundle() - Method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns the ResourceBundle of this object or
null
. - resourceBundle(ResourceBundle) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Initializes the resource bundle for this command: sets the
UsageMessageSpec.messages
to aMessages
object created from this command spec and the specified bundle, and then sets theArgSpec.messages
of all options and positional parameters in this command to the sameMessages
instance. - resourceBundle(CommandLine.Model.Messages) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns the ResourceBundle of the specified Messages object or
null
if the specified Messages object isnull
. - resourceBundleBaseName() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the resource bundle base name for this command.
- resourceBundleBaseName() - Method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns the base name of the ResourceBundle of this object or
null
. - resourceBundleBaseName(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Initializes the resource bundle for this command: sets the
UsageMessageSpec.messages
to aMessages
object created from this command spec and the specified bundle, and then sets theArgSpec.messages
of all options and positional parameters in this command to the sameMessages
instance. - resourceBundleBaseName(CommandLine.Model.Messages) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.Messages
-
Returns the ResourceBundle of the specified Messages object or
null
if the specified Messages object isnull
. - ResourceFactory - Interface in nz.org.riskscape.engine.resource
- ResourceLoader - Interface in nz.org.riskscape.engine.resource
-
An object able to load certain kinds of
Resource
s. - ResourceLoadingException - Exception in nz.org.riskscape.engine.resource
-
Exception indicating a problem of some kind with the loading a
Resource
. - ResourceLoadingException(URI, String) - Constructor for exception nz.org.riskscape.engine.resource.ResourceLoadingException
- ResourceLoadingException(URI, String, Throwable) - Constructor for exception nz.org.riskscape.engine.resource.ResourceLoadingException
- ResourceLoadingException(URI, Problem) - Constructor for exception nz.org.riskscape.engine.resource.ResourceLoadingException
- ResourceProblems - Interface in nz.org.riskscape.engine.resource
- restrict(Restriction) - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- restrict(Restriction) - Method in interface nz.org.riskscape.engine.relation.Relation
- Restriction - Interface in nz.org.riskscape.engine.restriction
-
A glorified
Predicate
with support for riskscape type safety checks and geotoolsFilter
representation. - Restrictor - Interface in nz.org.riskscape.engine.restriction
-
A
Restriction
that has been built and verified to work with a given type. - restrictType(Struct) - Method in interface nz.org.riskscape.engine.restriction.Restriction
- ResultComputationException - Exception in nz.org.riskscape.problem
-
Thrown when
ResultOrProblems.get()
is called and there is no result. - ResultComputationException(List<Problem>) - Constructor for exception nz.org.riskscape.problem.ResultComputationException
- ResultOrProblems<T> - Class in nz.org.riskscape.problem
-
An optional-esque that contains the result of some result-yielding operation where it may have had problems which might have stopped it from producing a result.
- ResultOrProblems(T, List<Problem>) - Constructor for class nz.org.riskscape.problem.ResultOrProblems
- results - Variable in class nz.org.riskscape.engine.IdentifiedCollection.Base
- returning(Object) - Static method in class nz.org.riskscape.engine.function.ConstantFunction
- returnResultOrExit(R) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Convenience method for subclasses that returns the specified result object if no exit code was set, or otherwise, if an exit code was set, calls
System.exit
with the configured exit code to terminate the currently running Java virtual machine. - reverse - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- rewind(Token) - Method in class nz.org.riskscape.dsl.Lexer
-
Reposition the lexer so that
Lexer.next()
returns thisToken
again. - rewrap(Type, Function<Type, Type>) - Static method in class nz.org.riskscape.engine.types.Nullable
-
Apply a type-returning function to a type with null removed, applying nullable to the result if the given type was nullable
- RHS_STEP_INDEX - Static variable in interface nz.org.riskscape.engine.join.LopsidedJoiner
- RISK_METRICS - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- RISK_MODELLING - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- RiskscapeException - Exception in nz.org.riskscape.engine
-
Root exception that all exceptions from Riskscape engine code should extend.
- RiskscapeException(String) - Constructor for exception nz.org.riskscape.engine.RiskscapeException
-
Deprecated.Use
RiskscapeException(Problem)
instead to produce an internationalizable error message that works with riskscape's problem APIXXX do we want to split up the hierarchy somewhat in to : a) unexpected errors that are probably not recoverable/fixable and b) exceptions that are "semantic vessels for a problem" such as a NoSuchObjectExistsException - these things help us with flow control / where they serve as sort of case classes where a standard
ResultOrProblems
isn't sufficient, e.g. we need to do something different depending on the type ofProblem
. More thinking required... - RiskscapeException(String, Throwable) - Constructor for exception nz.org.riskscape.engine.RiskscapeException
-
Deprecated.Use
RiskscapeException(Problem, Throwable)
instead to produce an internationalizable error message that works with riskscape's problem API - RiskscapeException(Problem) - Constructor for exception nz.org.riskscape.engine.RiskscapeException
- RiskscapeException(Problem, Throwable) - Constructor for exception nz.org.riskscape.engine.RiskscapeException
- RiskscapeFunction - Interface in nz.org.riskscape.engine.function
-
General interface for any kind of function that accepts and returns riskscape types values.
- RiskscapeIOException - Exception in nz.org.riskscape.engine
-
Can be thrown by engine code to say there was some underlying IO issue that caused data processing to fail.
- RiskscapeIOException(String, Exception) - Constructor for exception nz.org.riskscape.engine.RiskscapeIOException
- RiskscapeIOException(Problem) - Constructor for exception nz.org.riskscape.engine.RiskscapeIOException
- RiskscapeMessage - Class in nz.org.riskscape.engine.i18n
- RiskscapeWriter - Class in nz.org.riskscape.engine.output
-
Interface for writing out riskscape values
- RiskscapeWriter() - Constructor for class nz.org.riskscape.engine.output.RiskscapeWriter
- row - Variable in class nz.org.riskscape.picocli.CommandLine.Help.TextTable.Cell
-
Table row index (zero based).
- rowCount() - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Returns the current number of rows of this
TextTable
. - RPAREN - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- RSList - Class in nz.org.riskscape.engine.types
-
Basic list type that can convert various arrays and list types to the required type
- RSList(Type) - Constructor for class nz.org.riskscape.engine.types.RSList
-
Deprecated.use
RSList.create(Type)
instead - reduces the amount of identical types being allocated All Riskscape code has been ported to use create, but there may be functions etc out there that are using this old constructor. We might want to log a stack trace when this is used if it becomes functionally important that the new static constructor be used. - RSList(Type, boolean) - Constructor for class nz.org.riskscape.engine.types.RSList
-
Internal, non-deprecated constructor - ignored flag is here just to provide a non-deprecated alternative
- RSListAncestorRule - Class in nz.org.riskscape.engine.types.ancestor
- RSListAncestorRule() - Constructor for class nz.org.riskscape.engine.types.ancestor.RSListAncestorRule
- run() - Method in interface nz.org.riskscape.engine.cli.ChildCommand
-
Execute the command, returning for the cli to deal with, or null if no output produced
- run() - Method in class nz.org.riskscape.picocli.CommandLine.HelpCommand
-
Invokes
usage
for the specified command, or for the parent command. - run(Class<R>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(Class<R>, CommandLine.IFactory, PrintStream, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(Class<R>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(Class<R>, CommandLine.IFactory, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, PrintStream, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, String...) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - RunAll() - Constructor for class nz.org.riskscape.picocli.CommandLine.RunAll
- RunFirst() - Constructor for class nz.org.riskscape.picocli.CommandLine.RunFirst
- RunLast() - Constructor for class nz.org.riskscape.picocli.CommandLine.RunLast
S
- SameRule - Class in nz.org.riskscape.engine.types.varule
-
Rule that passes when the source and target have the same
Type
object. - SameRule() - Constructor for class nz.org.riskscape.engine.types.varule.SameRule
- SCIENTIFIC_NOTATION - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- scope() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the
CommandLine.Model.IScope
that determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group. - scope() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the
CommandLine.Model.IScope
that determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group. - scope() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the
CommandLine.Model.IScope
that determines where the setter sets the value (or the getter gets the value) of this argument. - scope() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the
CommandLine.Model.IScope
that determines on which object to set the value (or from which object to get the value) of this argument. - scope() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- scope(CommandLine.Model.IScope) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the
CommandLine.Model.IScope
that targets where the setter sets the value of the annotated program element associated with this group, and returns this builder. - scope(CommandLine.Model.IScope) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the
CommandLine.Model.IScope
that targets where the setter sets the value, and returns this builder. - scoped(Struct) - Method in class nz.org.riskscape.engine.types.LambdaType
- ScopedLambdaType - Class in nz.org.riskscape.engine.types
-
A
LambdaType
that also includes the scope. - ScopedLambdaType(Struct, String...) - Constructor for class nz.org.riskscape.engine.types.ScopedLambdaType
- ScopedLambdaType(Struct, List<String>) - Constructor for class nz.org.riskscape.engine.types.ScopedLambdaType
- SEARCH_INTERFACES - Enum constant in enum class nz.org.riskscape.ReflectionUtils.SearchOptions
-
will search through interfaces for the desired interface, as well as classes
- Secret - Interface in nz.org.riskscape.engine.auth
-
Loosely termed thing that is typically used to gain privileged access to something else.
- SecretBuilder - Class in nz.org.riskscape.engine.auth
-
A thing that can build a particular type of secret from some well-known parameters
- SecretBuilder(String, Class<? extends Secret>, ParameterSet, Function<BoundParameters, ResultOrProblems<Secret>>) - Constructor for class nz.org.riskscape.engine.auth.SecretBuilder
- SecretBuilders - Class in nz.org.riskscape.engine.auth
- SecretBuilders() - Constructor for class nz.org.riskscape.engine.auth.SecretBuilders
- Secrets - Class in nz.org.riskscape.engine.auth
- Secrets() - Constructor for class nz.org.riskscape.engine.auth.Secrets
- SECTION_KEY_COMMAND_LIST - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_COMMAND_LIST_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_DESCRIPTION - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_DESCRIPTION_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_EXIT_CODE_LIST - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_EXIT_CODE_LIST_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_FOOTER - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_FOOTER_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_HEADER - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_HEADER_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_OPTION_LIST - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_OPTION_LIST_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_PARAMETER_LIST - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_PARAMETER_LIST_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_SYNOPSIS - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- SECTION_KEY_SYNOPSIS_HEADING - Static variable in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- sectionKeys() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the section keys in the order that the usage help message should render the sections.
- sectionKeys(List<String>) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the section keys in the order that the usage help message should render the sections.
- sectionMap() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the map of section keys and renderers used to construct the usage help message.
- sectionMap(Map<String, CommandLine.IHelpSectionRenderer>) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.
- SECURE_OPTIONS - Static variable in interface nz.org.riskscape.engine.resource.Resource
-
Options that will only allow a remote file to be fetched if it can be done over a secure connection.
- SelectAllExpression - Class in nz.org.riskscape.rl.ast
-
A 'select all' expression is an asterisk by itself (i.e.
- SelectAllExpression(Token) - Constructor for class nz.org.riskscape.rl.ast.SelectAllExpression
- selectAllMember(Token) - Static method in class nz.org.riskscape.rl.ast.StructDeclaration
-
Returns a select-all ({*}) struct member
- selectAllRequiresAStruct(StructDeclaration.Member, Type) - Method in interface nz.org.riskscape.rl.ast.ExpressionProblems
-
Given during realization when a .* is found against a non-struct type, like a list or a number
- self() - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Returns
this
to allow method chaining when calling the setters for a fluent API. - self() - Method in class nz.org.riskscape.picocli.CommandLine.DefaultExceptionHandler
-
Deprecated.
- self() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns this builder.
- self() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns this builder.
- self() - Method in class nz.org.riskscape.picocli.CommandLine.RunAll
- self() - Method in class nz.org.riskscape.picocli.CommandLine.RunFirst
- self() - Method in class nz.org.riskscape.picocli.CommandLine.RunLast
- SelfDescribingScalarData - Interface in nz.org.riskscape.engine.data
-
An optional interface for an object that can describe itself in terms of RiskScape types.
- SEND_IT_TO_HELL - Static variable in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
A 'useful' function for capping a pipeline with a black hole - results are thrown away.
- separator - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem.ToStringOptions
-
Problems are separated with this.
- separator() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
String that separates options from option parameters.
- separator() - Method in interface nz.org.riskscape.picocli.CommandLine.Help.IParamLabelRenderer
-
Returns the separator between option name and param label.
- separator() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Returns the String to use as the separator between options and option parameters.
- separator(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
-
Sets the String to use as the separator between options and option parameters.
- set(int, Object) - Method in class nz.org.riskscape.engine.Tuple
-
Set a value using its struct index
- set(String, Object) - Method in class nz.org.riskscape.engine.Tuple
-
Set a value by its key
- set(Struct.StructMember, Object) - Method in class nz.org.riskscape.engine.Tuple
-
Set a value using a
Struct.StructMember
as a key - set(T) - Method in interface nz.org.riskscape.picocli.CommandLine.Model.ISetter
-
Sets the new value of the option or positional parameter.
- setAccessible(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- setAddMethodSubcommands(Boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets whether method commands should be added as subcommands.
- setAdjustLineBreaksForWideCJKCharacters(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
- setAdjustLineBreaksForWideCJKCharacters(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
- setAll(int, Tuple) - Method in class nz.org.riskscape.engine.Tuple
-
Copies (appends) the values from the given source tuple into this tuple.
- setAll(List<Object>) - Method in class nz.org.riskscape.engine.Tuple
-
Populate this tuple with the given values
- setAll(Tuple) - Method in class nz.org.riskscape.engine.Tuple
-
Copies the values from the given source tuple into this tuple.
- setAllowInsecure(boolean) - Method in class nz.org.riskscape.engine.resource.Resource.Options
- setAtFileCommentChar(Character) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the character that starts a single-line comment or
null
if all content of argument files should be interpreted as arguments (without comments). - setAttributesNotAllowedWithType() - Method in interface nz.org.riskscape.engine.data.BookmarkProblems
- setCaseInsensitiveEnumValuesAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether the parser should ignore case when converting arguments to
enum
values. - setChecksum(boolean) - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
True, if the user would like to have a checksum generated for saved results.
- setChildren(List<Problem>) - Method in class nz.org.riskscape.problem.Problem
-
Copy this Problem but replace the children.
- setColorScheme(CommandLine.Help.ColorScheme) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the color scheme to use when printing help.
- setCommandName(String) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the command name (also called program name) displayed in the usage help synopsis to the specified value.
- setDefaultCreationOptions(CreateRequest) - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
A URI to use for storing results, typically with
ResourceFactory.create(nz.org.riskscape.engine.resource.CreateRequest)
- setDefaultValueProvider(CommandLine.IDefaultValueProvider) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets a default value provider for the command and sub-commands
- setEndOfOptionsDelimiter(String) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the end-of-options delimiter that signals that the remaining command line arguments should be treated as positional parameters.
- setEngine(Engine) - Method in interface nz.org.riskscape.engine.cli.EngineCommand
-
Give the command an instance of the engine.
- setErr(PrintWriter) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the writer to use when printing diagnostic (error) messages during command execution.
- setExecutionExceptionHandler(CommandLine.IExecutionExceptionHandler) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets a custom handler for dealing with exceptions that occurred in the
Callable
,Runnable
orMethod
user object of a command when the command was executed via the execute method. - setExecutionResult(Object) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the result of calling the business logic on the command's user object.
- setExecutionStrategy(CommandLine.IExecutionStrategy) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the execution strategy that the
execute
method should use to invoke the business logic on the user objects of this command and/or the user-specified subcommand(s). - setExitCodeExceptionMapper(CommandLine.IExitCodeExceptionMapper) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the mapper used by the
execute
method to map exceptions to exit codes. - setExpandAtFiles(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether arguments starting with
'@'
should be treated as the path to an argument file and its contents should be expanded into separate arguments for each line in the specified file. - setFallbackHandler(InterruptHandler) - Method in interface nz.org.riskscape.cli.Terminal
-
Specify an interrupt handler that will be called on ctrl-c when readline isn't in progress.
- setField(Field, Object, Object) - Static method in class nz.org.riskscape.ReflectionUtils
-
Calls field.set(instance, value), wrapping the checked exception in an unchecked runtime exception
- setFormat(Optional<Format>) - Method in class nz.org.riskscape.engine.output.SinkParameters
-
A format the user has asked the data to be saved in
- setFormat(Format) - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
- setGeometryValidation(GeometryValidation) - Method in interface nz.org.riskscape.engine.Project
- setHelpFactory(CommandLine.IHelpFactory) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets a new
IHelpFactory
to customize the usage help message. - setHelpSectionKeys(List<String>) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the section keys in the order that the usage help message should render the sections.
- setHelpSectionMap(Map<String, CommandLine.IHelpSectionRenderer>) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the map of section keys and renderers used to construct the usage help message.
- setIndex(int) - Method in class nz.org.riskscape.engine.function.FunctionArgument
- setInterpolateVariables(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether whether variables should be interpolated in String values.
- setMessages(Messages) - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
- setName(String) - Method in class nz.org.riskscape.engine.output.SinkParameters
-
A name associate with the
Sink
. - setNegatableOptionTransformer(CommandLine.INegatableOptionTransformer) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the
INegatableOptionTransformer
used to create the negative form of negatable options. - setNestedPipelineId(String) - Method in interface nz.org.riskscape.engine.pipeline.NestedPipelineStep
- setNotificationSink(ProblemSink) - Method in interface nz.org.riskscape.engine.Diagnostics
-
Sets a sink to display diagnostic messages that we want the user to see.
- setNumThreads(int) - Method in interface nz.org.riskscape.engine.pipeline.PipelineExecutor
-
Sets the number of worker threads that the PipelineExecutor can create and use.
- setOut(PrintWriter) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the writer to use when printing user-requested usage help or version help during command execution.
- setOutputBaseLocation(URI) - Method in interface nz.org.riskscape.engine.Project
- setOverwrittenOptionsAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether options for single-value fields can be specified multiple times on the command line without a
CommandLine.OverwrittenOptionException
being thrown. - setOwner(Struct) - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- setParameter(String, List<?>) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Sets the parameter values, discarding any values that already existed for that parameter.
- setParameter(Parameter) - Method in exception nz.org.riskscape.engine.bind.NoBindingAvailableException
-
Update this exception with some parameter context info
- setParameter(NamedStep, String, List<?>) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Convenience version of
that will construct the parameterKey to be <step-name>.<paramName></p>
- setParameterExceptionHandler(CommandLine.IParameterExceptionHandler) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the handler for dealing with invalid user input when the command is executed.
- setPipelineDeclaration(Optional<PipelineDeclaration>) - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
The
PipelineDeclaration
that the pipeline was realized from, if known. - setPosixClusteredShortOptionsAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether short options like
-x -v -f SomeFile
can be clustered together like-xvfSomeFile
. - setProblemReporter(Consumer<Problem>) - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
-
Set a problem report that this function may use to issue
Problem
s to if any are encountered whilst the function is being called. - setProgressMetrics(MetricRegistry) - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
A set of metrics that are useful to show progress to the user.
- setReference(String) - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
A reference to use for the job's output, usually the id of the pipeline or model being run.
- setRelativeTo(URI) - Method in interface nz.org.riskscape.engine.Project
-
Set the
URI
which relative resources should be resolved against. - setReplace(boolean) - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
-
True, if the user would like existing content to be replaced.
- setResourceBundle(ResourceBundle) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the ResourceBundle containing usage help message strings.
- setSaveFormat(Format) - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
The preferred file format that pipeline results should be saved in
- setSeed(long) - Static method in class nz.org.riskscape.engine.RandomSingleton
-
Replace the RANDOM object with a new one with the given seed.
- setSeparator(String) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the String the parser uses to separate option names from option values to the specified value.
- setSource(String) - Method in class nz.org.riskscape.engine.function.JavaFunction
- setSplitQuotedStrings(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Deprecated.Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use
CommandLine.Model.ParserSpec.splitQuotedStrings(boolean)
. - setStepCapper(Function<RealizedStep, SinkConstructor>) - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
-
A function to use for applying a
Sink
to any terminal steps that are not themselves sinks. - setStopAtPositional(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether the parser interprets the first positional parameter as "end of options" so the remaining arguments are all treated as positional parameters.
- setStopAtUnmatched(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether the parser should stop interpreting options and positional parameters as soon as it encounters an unmatched option.
- setTempDirectory(Optional<Path>) - Method in class nz.org.riskscape.engine.resource.Resource.Options
-
A directory to use for storing any temporary files that are created.
- setter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the
CommandLine.Model.ISetter
that is responsible for modifying the value of the annotated program element associated with this group. - setter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the
CommandLine.Model.ISetter
that is responsible for modifying the value of the annotated program element associated with this group. - setter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the
CommandLine.Model.ISetter
that is responsible for modifying the value of this argument. - setter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the
CommandLine.Model.ISetter
that is responsible for modifying the value of this argument. - setter() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- setter() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UnmatchedArgsBinding
-
Returns the setter responsible for consuming the unmatched arguments.
- setter(CommandLine.Model.ISetter) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the
CommandLine.Model.ISetter
that is responsible for modifying the value of the annotated program element associated with this group, and returns this builder. - setter(CommandLine.Model.ISetter) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the
CommandLine.Model.ISetter
that is responsible for modifying the value of this argument, and returns this builder. - setTerminal(Terminal) - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
-
Set the terminal for the command to use.
- setToggleBooleanFlags(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether the value of boolean flag options should be "toggled" when the option is matched.
- setTrimQuotes(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether the parser should trim quotes from command line arguments before processing them.
- setType(Struct) - Method in class nz.org.riskscape.engine.output.SinkParameters
-
The type of the data that the sink is going to receive via
Sink.accept(nz.org.riskscape.engine.Tuple)
. - setUnmatchedArgumentsAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether the end user may specify unmatched arguments on the command line without a
CommandLine.UnmatchedArgumentException
being thrown. - setUnmatchedOptionsArePositionalParams(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether arguments on the command line that resemble an option should be treated as positional parameters.
- setUsageHelpAutoWidth(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
- setUsageHelpWidth(int) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets the maximum width of the usage help message.
- setUseSimplifiedAtFiles(boolean) - Method in class nz.org.riskscape.picocli.CommandLine
-
Sets whether to use a simplified argument file format that is compatible with JCommander.
- setValidationPostReproject(GeometryValidation) - Method in class nz.org.riskscape.engine.SRIDSet
-
Controls if geometries should be validated after a re-projection and what to do if they have become invalid.
- setValue(T) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Sets the value of this argument to the specified value and returns the previous value.
- setValue(T, CommandLine) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Deprecated.use
CommandLine.Model.ArgSpec.setValue(Object)
instead. This was a design mistake. - severity - Variable in class nz.org.riskscape.problem.Problem
- SeverityLevel - Annotation Interface in nz.org.riskscape.engine.problem
- shortestFirst() - Static method in class nz.org.riskscape.picocli.CommandLine.Help
-
Sorts short strings before longer strings.
- shortestName() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns the shortest option name.
- showDefaultValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns whether this option or positional parameter's default value should be shown in the usage help.
- showDefaultValue() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns whether this option or positional parameter's default value should be shown in the usage help.
- showDefaultValue() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Use this attribute to control for a specific option whether its default value should be shown in the usage help message.
- showDefaultValue() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Use this attribute to control for a specific positional parameter whether its default value should be shown in the usage help message.
- showDefaultValue(CommandLine.Help.Visibility) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets whether this option or positional parameter's default value should be shown in the usage help, and returns this builder.
- showDefaultValues() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Specify
true
to show default values in the description column of the options list (except for boolean options). - showDefaultValues() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns whether the options list in the usage help message should show default values for all non-boolean options.
- showDefaultValues(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets whether the options list in the usage help message should show default values for all non-boolean options.
- shutDown() - Method in class nz.org.riskscape.engine.plugin.Plugin
-
Shutdown the plugin.
- SimpleType - Class in nz.org.riskscape.engine.types
-
Represents the simplest single-value type, e.g.
- SimpleType() - Constructor for class nz.org.riskscape.engine.types.SimpleType
- SimpleTypeConstructor - Interface in nz.org.riskscape.engine.typexp
-
Function interface that redeclares
TypeConstructor.construct(TypeBuilder, AST.Symbol)
- SingleGeomToMultiGeomRule - Class in nz.org.riskscape.engine.types.eqrule
-
Allows a singular specific geometry type (LINE, POINT, POLYGON) to be coerced to a multi form of the same type.
- SingleGeomToMultiGeomRule() - Constructor for class nz.org.riskscape.engine.types.eqrule.SingleGeomToMultiGeomRule
- singleton(Tuple) - Static method in interface nz.org.riskscape.engine.relation.TupleIterator
- Singleton - Class in nz.org.riskscape.engine.relation
-
Special case
TupleIterator
for a singleTuple
. - Singleton(Tuple) - Constructor for class nz.org.riskscape.engine.relation.Singleton
- SingleValueStructRule - Class in nz.org.riskscape.engine.types.eqrule
-
Allows assignment between structs and simple values if the struct has a single member who's type matches the single value.
- SingleValueStructRule() - Constructor for class nz.org.riskscape.engine.types.eqrule.SingleValueStructRule
- Sink - Interface in nz.org.riskscape.engine.pipeline
-
Accepts output tuples from a pipeline step, possibly for saving results, but also potentially for processing them before having them emerge somewhere else in the pipeline.
- SinkConstructor - Interface in nz.org.riskscape.engine.pipeline
- SinkParameters - Class in nz.org.riskscape.engine.output
-
Defines options that are useful when constructing a
Sink
- SinkParameters(String, Struct) - Constructor for class nz.org.riskscape.engine.output.SinkParameters
- SinkParameters(String, Struct, Optional<Format>) - Constructor for class nz.org.riskscape.engine.output.SinkParameters
- SinkParameters(SinkParameters) - Constructor for class nz.org.riskscape.engine.output.SinkParameters
- size - Variable in class nz.org.riskscape.engine.pipeline.Manifest.OutputInfo
- size() - Method in class nz.org.riskscape.engine.function.ArgumentList
- size() - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- size() - Method in interface nz.org.riskscape.engine.relation.Relation
-
Get a rough count of the untransformed tuples in the relation.
- size() - Method in class nz.org.riskscape.engine.Tuple
- size() - Method in class nz.org.riskscape.engine.types.Struct
- size() - Method in class nz.org.riskscape.engine.types.Struct.StructBuilder
- size() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- size() - Method in class nz.org.riskscape.pipeline.ast.StepChain
- size() - Method in class nz.org.riskscape.rl.ast.ListDeclaration
- size(T) - Method in interface nz.org.riskscape.engine.pipeline.Collector
- skipInvalid(ProblemSink) - Method in class nz.org.riskscape.engine.relation.EmptyRelation
- skipInvalid(ProblemSink) - Method in interface nz.org.riskscape.engine.relation.Relation
- SOFTWARE - Static variable in class nz.org.riskscape.picocli.CommandLine.ExitCode
-
Return value from the
execute
method signifying internal software error: an exception occurred when invoking the Runnable, Callable or Method user object of a command. - SortBy - Class in nz.org.riskscape.engine.sort
-
Defines an sort by, consisting of an
Expression
to obtain a comparable value andSortBy.Direction
. - SortBy(Expression, SortBy.Direction) - Constructor for class nz.org.riskscape.engine.sort.SortBy
- SortBy(Expression, SortBy.Direction, SortBy) - Constructor for class nz.org.riskscape.engine.sort.SortBy
- SortBy.Direction - Enum Class in nz.org.riskscape.engine.sort
- sortOptions() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Specify
false
to show Options in declaration order. - sortOptions() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns whether the options list in the usage help message should be sorted alphabetically.
- sortOptions(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets whether the options list in the usage help message should be sorted alphabetically.
- source - Variable in class nz.org.riskscape.dsl.Token
- source - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem
-
The thing that caused all the problems
- SPACE - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- SPAN - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Column.Overflow
- SpatialMetadata - Class in nz.org.riskscape.engine.relation
-
Optional meta data for a
Relation
- SpatialMetadata(CoordinateReferenceSystem, Struct.StructMember) - Constructor for class nz.org.riskscape.engine.relation.SpatialMetadata
- specElements() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the list of program elements annotated with
{@literal @}Spec
configured for this command. - split() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Specify a regular expression to use to split option parameter values before applying them to the field.
- split() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
-
Specify a regular expression to use to split positional parameter values before applying them to the field.
- splitLines() - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
- splitQuotedStrings() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- splitQuotedStrings(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- splitRegex() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns a regular expression to split option parameter values or
""
if the value should not be split. - splitRegex() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns a regular expression to split option parameter values or
""
if the value should not be split. - splitRegex(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets a regular expression to split option parameter values or
""
if the value should not be split, and returns this builder. - spuriousKeys(ConfigSection, Set<String>) - Method in interface nz.org.riskscape.config.ConfigProblems
- spuriousSectionInProject(String, URI, List<String>) - Method in interface nz.org.riskscape.config.ConfigProblems
- sqlStyleMember(Token, Expression, Token) - Static method in class nz.org.riskscape.rl.ast.StructDeclaration
-
Returns an sql style (bar as foo) struct member
- sridByCrs - Variable in class nz.org.riskscape.engine.SRIDSet
- sridByMetadataFreeCrs - Variable in class nz.org.riskscape.engine.SRIDSet
- SRIDSet - Class in nz.org.riskscape.engine
-
SRIDSet is the "central authority" in riskscape for managing CoordinateReferenceSystems.
- SRIDSet() - Constructor for class nz.org.riskscape.engine.SRIDSet
- SRIDSet(ProblemSink) - Constructor for class nz.org.riskscape.engine.SRIDSet
- StandardCodes - Enum Class in nz.org.riskscape.problem
-
A pre-defined set of common types of problems.
- START - Static variable in class nz.org.riskscape.engine.pipeline.Pipeline
- startTime - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- startUp(Map<String, List<String>>) - Method in class nz.org.riskscape.engine.plugin.Plugin
-
Will be invoked on plugin start up and before
Plugin.initializeEngine(Engine, ProblemSink)
is called. - startUp(Map<String, List<String>>, ProblemSink) - Method in class nz.org.riskscape.engine.plugin.Plugin
- stderr() - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
- stdin() - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
- stdout() - Method in interface nz.org.riskscape.engine.cli.TerminalCommand
- Step - Interface in nz.org.riskscape.engine.pipeline
- STEP_ALREADY_ADDED - Enum constant in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Attempt to add a step with a name that already has been used in the pipeline
- STEP_NAME_UNKNOWN - Enum constant in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Attempt to reference a step by a name that doesn't exist in the pipeline
- StepAlreadyAddedException - Exception in nz.org.riskscape.engine.pipeline
- StepAlreadyAddedException(Pipeline, NamedStep) - Constructor for exception nz.org.riskscape.engine.pipeline.StepAlreadyAddedException
- StepChain - Class in nz.org.riskscape.pipeline.ast
-
AST for a list of
StepDeclaration
s that are chained together. - StepChain(List<StepDeclaration>) - Constructor for class nz.org.riskscape.pipeline.ast.StepChain
- StepChain(List<StepDeclaration>, List<Token>) - Constructor for class nz.org.riskscape.pipeline.ast.StepChain
- StepDeclaration - Class in nz.org.riskscape.pipeline.ast
-
AST for a single step.
- StepDeclaration(Token, Optional<Token>) - Constructor for class nz.org.riskscape.pipeline.ast.StepDeclaration
- StepDefinition - Class in nz.org.riskscape.pipeline.ast
-
Defines a step.
- StepDefinition(String) - Constructor for class nz.org.riskscape.pipeline.ast.StepDefinition
- StepDefinition(FunctionCall, Optional<Token>, Optional<Token>) - Constructor for class nz.org.riskscape.pipeline.ast.StepDefinition
- stepDefinitionIterator() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
- StepDescription(String, String, List<String>, Map<String, List<String>>) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- StepDescription(RealizedStep) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- stepId - Variable in class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- StepLink - Class in nz.org.riskscape.pipeline.ast
- StepLink(StepDeclaration, Token, StepDeclaration) - Constructor for class nz.org.riskscape.pipeline.ast.StepLink
- stepName - Variable in class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- StepNamingPolicy - Interface in nz.org.riskscape.pipeline
-
Slightly-over-engineered way of determining an implicit name, if possible, for a step definition.
- stepRedefinition(String, int, int) - Method in interface nz.org.riskscape.engine.pipeline.PipelineProblems
-
The pipeline contains two steps with the same name.
- StepReference - Class in nz.org.riskscape.pipeline.ast
-
Reference to a step that should have been declared previously.
- StepReference(String) - Constructor for class nz.org.riskscape.pipeline.ast.StepReference
- StepReference(String, String) - Constructor for class nz.org.riskscape.pipeline.ast.StepReference
- StepReference(Token, Optional<Token>) - Constructor for class nz.org.riskscape.pipeline.ast.StepReference
- steps - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- stopAtPositional() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- stopAtPositional(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- stopAtUnmatched() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- stopAtUnmatched(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- store() - Method in class nz.org.riskscape.engine.resource.CreateHandle
-
Store data written to the handle, returning the URI it is now available at.
- store(CreateHandle.Callback) - Method in class nz.org.riskscape.engine.resource.CreateHandle
-
Provide a callback that will store bytes associated with the resource.
- stream() - Method in interface nz.org.riskscape.engine.relation.Relation
- STREAMABLE - Enum constant in enum class nz.org.riskscape.engine.output.Format.Characteristics
-
This format can read/write tuples from a stream of bytes without needing all the contents at once
- StreamingCollector<T> - Interface in nz.org.riskscape.engine.pipeline
- string(String) - Method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Returns a String where any markup like
@|bg(red),white,underline some text|@
is converted to ANSI escape codes if this Ansi is ON, or suppressed if this Ansi is OFF. - string(String) - Static method in class nz.org.riskscape.rl.ast.Constant
-
Handy testing constructor to create a string constant
- STRING - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- STRINGS - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- stringValues() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the untyped command line arguments matched by this option or positional parameter spec.
- strip(Type) - Static method in class nz.org.riskscape.engine.types.Nullable
- strip(Type) - Static method in class nz.org.riskscape.engine.typeset.IdentifiedType
-
Strips off an outer IdentifiedType from the given type (if present)
- stripQuotes(String) - Static method in enum class nz.org.riskscape.rl.TokenTypes
- Struct - Class in nz.org.riskscape.engine.types
-
Permissive struct-like type that allows a c-like struct (like a java class with only fields) to be declared with members being other riskscape types.
- Struct.StructBuilder - Class in nz.org.riskscape.engine.types
-
Builder class for constructing struct types with a fluid api
- Struct.StructMember - Class in nz.org.riskscape.engine.types
- StructBuilder() - Constructor for class nz.org.riskscape.engine.types.Struct.StructBuilder
- StructBuilder(int) - Constructor for class nz.org.riskscape.engine.types.Struct.StructBuilder
- StructDeclaration - Class in nz.org.riskscape.rl.ast
- StructDeclaration(List<StructDeclaration.Member>, Optional<Pair<Token, Token>>) - Constructor for class nz.org.riskscape.rl.ast.StructDeclaration
- StructDeclaration.Member - Class in nz.org.riskscape.rl.ast
- StructGeometryRule - Class in nz.org.riskscape.engine.types.eqrule
- StructGeometryRule() - Constructor for class nz.org.riskscape.engine.types.eqrule.StructGeometryRule
- StructMember(String, Type, int) - Constructor for class nz.org.riskscape.engine.types.Struct.StructMember
- StructMemberAncestorRule - Class in nz.org.riskscape.engine.types.ancestor
- StructMemberAncestorRule() - Constructor for class nz.org.riskscape.engine.types.ancestor.StructMemberAncestorRule
- structMemberMustBeOfType(Object, String, Type, Type) - Method in interface nz.org.riskscape.engine.types.TypeProblems
-
Struct member named
member
must be of typeexpected
- structMemberNotProvided(Struct.StructMember, Struct) - Method in interface nz.org.riskscape.engine.types.TypeProblems
- structMustBeNonEmpty(Object) - Method in interface nz.org.riskscape.engine.types.TypeProblems
-
Struct must have at least one member (non-empty)
- structMustHaveMemberType(Type, Struct) - Method in interface nz.org.riskscape.engine.types.TypeProblems
-
Struct must have a single
member, but none were found among - stub(Bookmark, Object, List<Problem>, List<Problem>) - Static method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Useful testing constructor to return a pre-constructed Object with a fake Bookmark object that has the desired bookmarkId.
- subcommand() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns the
ParseResult
for the subcommand of this command that was matched on the command line, ornull
if no subcommand was matched. - subcommand(CommandLine.ParseResult) - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.Builder
-
Sets the specified
ParseResult
for a subcommand that was matched on the command line. - subcommands() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
A list of classes to instantiate and register as subcommands.
- subcommands() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the map of subcommand
Help
instances for this command Help. - subcommands() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns a read-only view of the subcommand map.
- subgroups() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the list of subgroups that this group is composed of.
- subgroups() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Return the subgroups that this group is composed of; may be empty but not
null
. - substring(int) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns a new
Text
instance that is a substring of this Text. - substring(int, int) - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns a new
Text
instance that is a substring of this Text. - sum(Expression, Expression) - Static method in class nz.org.riskscape.rl.ast.Expressions
- supportedParameters() - Method in interface nz.org.riskscape.engine.data.BookmarkResolver
-
Deprecated.
- supportsFeature(Class<T>) - Method in class nz.org.riskscape.engine.plugin.Plugin
-
Deprecated.use the new ExtensionPoint API instead. We should start moving Features across to that as and when we touch them.
- SURPLUS_IGNORED - Enum constant in enum class nz.org.riskscape.engine.Tuple.CoerceOptions
-
Any extra keys in the map will be ignored and not included in the resulting tuple
- Symbol(Token) - Constructor for class nz.org.riskscape.engine.typexp.AST.Symbol
- synopsis() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Deprecated.use
CommandLine.Help.synopsis(int)
instead - synopsis() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the synopsis of this group.
- synopsis(int) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns a synopsis for the command, reserving the specified space for the synopsis heading.
- synopsisAutoIndentThreshold() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the fraction of the usage help
CommandLine.Model.UsageMessageSpec.width()
that is the threshold up to which the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name. - synopsisAutoIndentThreshold(double) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the fraction of the usage help
CommandLine.Model.UsageMessageSpec.width()
that is the threshold up to which the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name. - synopsisHeading() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the heading preceding the synopsis text.
- synopsisHeading() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the optional heading preceding the synopsis.
- synopsisHeading(Object...) - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the text displayed before the synopsis text; the result of
String.format(synopsisHeading, params)
. - synopsisHeading(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the optional heading preceding the synopsis.
- synopsisHeadingLength() - Method in class nz.org.riskscape.picocli.CommandLine.Help
-
Returns the number of characters the synopsis heading will take on the same line as the synopsis.
- synopsisIndent() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis when the length of the synopsis heading and the fully qualified command name exceed the
CommandLine.Model.UsageMessageSpec.width()
times theCommandLine.Model.UsageMessageSpec.synopsisAutoIndentThreshold()
,-1
by default. - synopsisIndent(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis when the length of the synopsis heading and the fully qualified command name exceed the
CommandLine.Model.UsageMessageSpec.synopsisAutoIndentThreshold()
fraction of theCommandLine.Model.UsageMessageSpec.width()
,-1
by default. - synopsisSubcommandLabel() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Specify the String to show in the synopsis for the subcommands of this command.
- synopsisSubcommandLabel() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the String representing the subcommands in the synopsis.
- synopsisSubcommandLabel(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the String representing the subcommands in the synopsis.
- synopsisText(CommandLine.Help.ColorScheme, Set<CommandLine.Model.ArgSpec>) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the synopsis of this group.
T
- TAB - Enum constant in enum class nz.org.riskscape.rl.TokenTypes
- table - Variable in class nz.org.riskscape.picocli.CommandLine.Help.Layout
- tempDirectory - Variable in class nz.org.riskscape.engine.resource.Resource.Options
-
A directory to use for storing any temporary files that are created.
- Terminal - Interface in nz.org.riskscape.cli
- TerminalCommand - Interface in nz.org.riskscape.engine.cli
-
A command that wants access to a
Terminal
- terminateWith - Variable in class nz.org.riskscape.engine.i18n.RenderedProblem.ToStringOptions
-
Applied to the end of the string after all other text is output
- test(Tuple) - Method in class nz.org.riskscape.engine.restriction.DefaultRestrictor
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.JavaRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.AnythingRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.ContainingTypeRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.EmptyListRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.EqualityRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.GeometryRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.LinkedTypeRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.LookupTableTypeRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.NothingRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.NullableTargetRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.SameRule
- test(TypeRules, Type, Type) - Method in interface nz.org.riskscape.engine.types.varule.VarianceRule
- test(TypeRules, Type, Type) - Method in class nz.org.riskscape.engine.types.varule.WrappingTypesRule
- testVariance(Type, Type) - Method in interface nz.org.riskscape.engine.typeset.TypeRules
-
Search through the list of
VarianceRule
s to determine whether a value of sourceType can be assigned to a receiver of targetType - testVariance(Type, Type) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- text(String) - Method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Returns a new Text object for this Ansi mode, encapsulating the specified string which may contain markup like
@|bg(red),white,underline some text|@
. - Text - Class in nz.org.riskscape.engine.types
-
A plain old string.
- Text() - Constructor for class nz.org.riskscape.engine.types.Text
- Text(int) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Constructs a Text with the specified max length (for use in a TextTable Column).
- Text(String) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Constructs a Text with the specified String, which may contain markup like
@|bg(red),white,underline some text|@
. - Text(CommandLine.Help.Ansi.Text) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Copy constructor.
- TEXT - Static variable in class nz.org.riskscape.engine.types.Nullable
- TEXT - Static variable in class nz.org.riskscape.engine.types.Types
- textAt(int, int) - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Returns the
Text
slot at the specified row and column to write a text value into. - TextTable(CommandLine.Help.Ansi, CommandLine.Help.Column[]) - Constructor for class nz.org.riskscape.picocli.CommandLine.Help.TextTable
- throwIfErrors(List<Problem>, Function<List<Problem>, T>) - Static method in class nz.org.riskscape.problem.Problem
- throwOrExit(CommandLine.ExecutionException) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.Convenience method for subclasses that throws the specified ExecutionException if no exit code was set, or otherwise, if an exit code was set, prints the stacktrace of the specified exception to the diagnostic error stream and calls
System.exit
with the configured exit code to terminate the currently running Java virtual machine. - throwUnlessEmpty(List<Problem>) - Static method in exception nz.org.riskscape.problem.ProblemException
- to - Variable in class nz.org.riskscape.engine.pipeline.Edge
- toArray() - Method in class nz.org.riskscape.engine.Tuple
- toBuilder() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns a new Builder initialized with the attributes from this
OptionSpec
. - toBuilder() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec
-
Returns a new Builder initialized with the attributes from this
PositionalParamSpec
. - toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Anything
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Bool
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.CoverageType
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Date
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Decimal
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.EmptyList
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Enumeration
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Floating
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.FunctionType
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Geom
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Integer
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.LambdaType
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.LookupTableType
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Nothing
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Nullable
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.RelationType
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.RSList
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Struct
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.types.Text
- toBytes(DataOutputStream, Object) - Method in interface nz.org.riskscape.engine.types.Type
- toBytes(DataOutputStream, Object) - Method in interface nz.org.riskscape.engine.types.WrappingType
- toBytes(DataOutputStream, Object) - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- toEntity() - Method in interface nz.org.riskscape.engine.function.IdentifiedFunction
-
Returns a map-view of this fragility function
- toExitCode(Messages) - Method in exception nz.org.riskscape.engine.cli.ExitException
- toggleBooleanFlags() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- toggleBooleanFlags(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- token(TokenType, String) - Static method in class nz.org.riskscape.dsl.Token
-
Handy constructor for testing situations
- Token - Class in nz.org.riskscape.dsl
- Token(TokenType, String, int, int, String) - Constructor for class nz.org.riskscape.dsl.Token
- Token.Location - Class in nz.org.riskscape.dsl
- TokenMatcher - Interface in nz.org.riskscape.dsl
-
Functional interface that replaces using
Pattern
for sometimes easier, more understandable and more flexible pattern matching during lexing - tokens() - Static method in enum class nz.org.riskscape.rl.TokenTypes
- Tokens(Class<T>, T, List<T>) - Constructor for class nz.org.riskscape.dsl.Lexer.Tokens
- TokenType - Interface in nz.org.riskscape.dsl
-
Interface for enum members used by
Lexer
- TokenTypes - Enum Class in nz.org.riskscape.rl
-
Tokens used by
ExpressionParser
- toKey() - Method in class nz.org.riskscape.engine.CustomCode
- toKey() - Method in class nz.org.riskscape.engine.problem.ProblemFactoryProxy.JavaMethodCode
- toKey() - Method in interface nz.org.riskscape.problem.ProblemCode
-
A key to use for i18n look ups to describe this problem.
- toList() - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
-
Convert this RenderedProblem in to a list, as per a depth-first search of this RenderedProblem
- toList(Expression) - Method in class nz.org.riskscape.rl.ExpressionParser
-
Return a version of the given expression as a
ListDeclaration
. - toMap() - Method in interface nz.org.riskscape.config.ConfigSection
- toMap() - Method in class nz.org.riskscape.engine.Tuple
- toMap() - Static method in class nz.org.riskscape.engine.util.Pair
-
Returns a collector that can be used to reduce a stream of
Pair
s to a map, throwing an exception on duplicates. - toMultiMap() - Method in interface nz.org.riskscape.config.ConfigSection
- toNative() - Method in class nz.org.riskscape.engine.typexp.AST.Constant
-
Return a Java representation of the parsed value
- topologyExceptionTip() - Method in interface nz.org.riskscape.engine.GeometryProblems
-
Tip for the user when a JTS
TopologyException
is hit. - toResult() - Method in exception nz.org.riskscape.problem.ProblemException
- toSingleProblem(List<Problem>) - Static method in class nz.org.riskscape.problem.Problems
-
Helper for wrapping a list of problems with a single problem - useful where you go from a multiple problem API to a single problem API (sigh).
- toSource() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
- toSource() - Method in interface nz.org.riskscape.pipeline.ast.PipelineExpression
- toSource() - Method in class nz.org.riskscape.rl.ast.ParameterToken
- toSource() - Method in interface nz.org.riskscape.rl.ast.Expression
- toSource() - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- toSource() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- toString - Variable in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
- toString() - Method in class nz.org.riskscape.dsl.ConditionalParse
- toString() - Method in class nz.org.riskscape.dsl.Token.Location
- toString() - Method in class nz.org.riskscape.dsl.Token
- toString() - Method in class nz.org.riskscape.engine.bind.BoundParameters
- toString() - Method in class nz.org.riskscape.engine.bind.Parameter
- toString() - Method in class nz.org.riskscape.engine.bind.ParameterSet
- toString() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate.Choice
- toString() - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- toString() - Method in class nz.org.riskscape.engine.BuildInfo
- toString() - Method in class nz.org.riskscape.engine.data.Bookmark.BookmarkBuilder
- toString() - Method in class nz.org.riskscape.engine.data.Bookmark
- toString() - Method in class nz.org.riskscape.engine.function.BinaryOperatorFunction
- toString() - Method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- toString() - Method in class nz.org.riskscape.engine.function.FunctionArgument
- toString() - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- toString() - Method in class nz.org.riskscape.engine.function.JavaFunction
- toString() - Method in class nz.org.riskscape.engine.function.NullSafeFunction
- toString() - Method in class nz.org.riskscape.engine.i18n.HasMessages
- toString() - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
-
Returns a line separated, indented version of this problem and its children
- toString() - Method in class nz.org.riskscape.engine.i18n.TranslationContext
- toString() - Method in class nz.org.riskscape.engine.IdentifiedCollection.Base.Handle
- toString() - Method in class nz.org.riskscape.engine.output.PipelineOutputOptions
- toString() - Method in class nz.org.riskscape.engine.output.SinkParameters
- toString() - Method in class nz.org.riskscape.engine.pipeline.Edge
- toString() - Method in class nz.org.riskscape.engine.pipeline.ExecutionOptions
- toString() - Method in class nz.org.riskscape.engine.pipeline.ExecutionResult
- toString() - Method in class nz.org.riskscape.engine.pipeline.Manifest.StepDescription
- toString() - Method in class nz.org.riskscape.engine.pipeline.NamedStep
- toString() - Method in class nz.org.riskscape.engine.pipeline.NullStep
- toString() - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- toString() - Method in class nz.org.riskscape.engine.pipeline.RealizedStep
- toString() - Method in class nz.org.riskscape.engine.plugin.ConstructorFeature
- toString() - Method in class nz.org.riskscape.engine.plugin.ExtensionPoint
- toString() - Method in class nz.org.riskscape.engine.problem.ProblemFactoryProxy.JavaMethodCode
- toString() - Method in class nz.org.riskscape.engine.problem.ProblemPlaceholder
- toString() - Method in class nz.org.riskscape.engine.relation.Singleton
- toString() - Method in class nz.org.riskscape.engine.resource.CreateHandle
- toString() - Method in class nz.org.riskscape.engine.resource.CreateRequest
- toString() - Method in class nz.org.riskscape.engine.resource.Resource.Options
- toString() - Method in class nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction
- toString() - Method in class nz.org.riskscape.engine.sort.SortBy
- toString() - Method in class nz.org.riskscape.engine.spi.EngineBootstrapper
- toString() - Method in class nz.org.riskscape.engine.Tuple
- toString() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
- toString() - Method in class nz.org.riskscape.engine.types.ancestor.AncestorTypeList
- toString() - Method in class nz.org.riskscape.engine.types.CoverageType
- toString() - Method in class nz.org.riskscape.engine.types.EmptyList
- toString() - Method in class nz.org.riskscape.engine.types.Enumeration
- toString() - Method in class nz.org.riskscape.engine.types.FunctionType
- toString() - Method in class nz.org.riskscape.engine.types.LambdaType
- toString() - Method in class nz.org.riskscape.engine.types.LookupTableType
- toString() - Method in class nz.org.riskscape.engine.types.MultiGeom
- toString() - Method in class nz.org.riskscape.engine.types.Nullable
- toString() - Method in class nz.org.riskscape.engine.types.Referenced
- toString() - Method in class nz.org.riskscape.engine.types.RelationType
- toString() - Method in class nz.org.riskscape.engine.types.RSList
- toString() - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- toString() - Method in class nz.org.riskscape.engine.types.SimpleType
- toString() - Method in class nz.org.riskscape.engine.types.Struct.StructMember
- toString() - Method in class nz.org.riskscape.engine.types.Struct
- toString() - Method in class nz.org.riskscape.engine.types.Value
- toString() - Method in class nz.org.riskscape.engine.types.WithinRange
- toString() - Method in class nz.org.riskscape.engine.types.WithinSet
- toString() - Method in class nz.org.riskscape.engine.types.WithMetadata
- toString() - Method in class nz.org.riskscape.engine.typeset.IdentifiedType
- toString() - Method in class nz.org.riskscape.engine.typexp.AST
- toString() - Method in class nz.org.riskscape.engine.util.Pair
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text
-
Returns a String representation of the text with ANSI escape codes embedded, unless ANSI is CommandLine.Help.Ansi.enabled() not enabled}, in which case the plain text is returned.
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Help.Layout
-
Returns the section of the usage help message accumulated in the TextTable owned by this layout.
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns a string respresentation of this option or positional parameter.
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns a string representation of this command, used in error messages and trace messages.
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Model.MethodParam
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatch
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult.GroupMatchContainer
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.PropertiesDefaultProvider
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.Range
- toString() - Method in class nz.org.riskscape.picocli.CommandLine.RegexTransformer
- toString() - Method in class nz.org.riskscape.pipeline.ast.StepDefinition
-
Returns a simplified view of the ast in a source-like fashion, but with a lot of details left out for conciseness
- toString() - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration.Found
- toString() - Method in class nz.org.riskscape.pipeline.PipelineMetadata
- toString() - Method in class nz.org.riskscape.problem.Problem
- toString() - Method in class nz.org.riskscape.problem.ResultOrProblems
- toString() - Method in class nz.org.riskscape.rl.ast.ParameterToken
- toString() - Method in class nz.org.riskscape.rl.ast.FunctionCall.Argument
- toString() - Method in class nz.org.riskscape.rl.ast.StructDeclaration.Member
- toString(Object) - Method in class nz.org.riskscape.engine.types.Geom
- toString(Object) - Method in interface nz.org.riskscape.engine.types.Type
-
A Riskscape specific toString of the given value, as an alternative to the java type's native toString representation.
- toString(StringBuilder) - Method in class nz.org.riskscape.picocli.CommandLine.Help.TextTable
-
Copies the text representation that we built up from the options into the specified StringBuilder.
- toString(Consumer<RenderedProblem.ToStringOptions>) - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
-
Returns a line separated, indented version of this problem and its children
- toString(RenderedProblem.ToStringOptions) - Method in class nz.org.riskscape.engine.i18n.RenderedProblem
- ToStringOptions() - Constructor for class nz.org.riskscape.engine.i18n.RenderedProblem.ToStringOptions
- ToStringOptions(Consumer<RenderedProblem.ToStringOptions>) - Constructor for class nz.org.riskscape.engine.i18n.RenderedProblem.ToStringOptions
- toStruct() - Method in class nz.org.riskscape.engine.types.Value
- toStruct(Expression) - Method in class nz.org.riskscape.rl.ExpressionParser
-
Return a version of the given expression as a struct.
- toUserFriendlyString(String) - Method in class nz.org.riskscape.engine.model.ModelParameter
- TranslationContext - Class in nz.org.riskscape.engine.i18n
-
Represents the current context of the translation, i.e.
- TranslationContext(Locale, MessageSource) - Constructor for class nz.org.riskscape.engine.i18n.TranslationContext
- trimQuotes() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- trimQuotes(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- TRUE - Static variable in interface nz.org.riskscape.engine.rl.RealizedExpression
- TRUE - Static variable in class nz.org.riskscape.rl.ast.Constant
- TRUNCATE - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Column.Overflow
- tryThese(ConditionalParse<U>...) - Method in class nz.org.riskscape.dsl.Lexer
- Tuple - Class in nz.org.riskscape.engine
- Tuple(Struct) - Constructor for class nz.org.riskscape.engine.Tuple
- Tuple(Struct, Map<String, String>) - Constructor for class nz.org.riskscape.engine.Tuple
- Tuple.CoerceOptions - Enum Class in nz.org.riskscape.engine
-
Options for error suppression/checking when using the
Tuple.coerce(Struct, Map)
method - TupleIterator - Interface in nz.org.riskscape.engine.relation
-
Brings together the
AutoCloseable
andIterator
interface foIterator
s that come fromRelation
s, so that iterators can clean up any resources they are derived from. - TupleReader - Interface in nz.org.riskscape.engine.io
-
Simple interface for something that reads
Tuple
s from an underlying stream of data - TupleStorage - Interface in nz.org.riskscape.engine.io
-
Generic, and slightly wip, interface for creating
TupleReader
s andTupleWriter
s - TupleUtils - Class in nz.org.riskscape.engine.query
- TupleUtils() - Constructor for class nz.org.riskscape.engine.query.TupleUtils
- TupleUtils.FindOption - Enum Class in nz.org.riskscape.engine.query
- TupleWriter - Interface in nz.org.riskscape.engine.io
-
Stripped back interface for writing tuples out, presumably to some sort of underlying output stream.
- TWO - Static variable in class nz.org.riskscape.engine.types.Decimal
-
A constant value of two.
- type - Variable in class nz.org.riskscape.dsl.Token
- type - Variable in class nz.org.riskscape.engine.bind.Parameter.MutableFields
- type() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the type to convert the option or positional parameter to before setting the value.
- type() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the type to convert the option or positional parameter to before setting the value.
- type() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Optionally specify a
type
to control exactly what Class the option parameter should be converted to. - type() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Parameters
- type(Class<?>) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the type to convert the option or positional parameter to before setting the value, and returns this builder.
- Type - Interface in nz.org.riskscape.engine.types
-
The root interface for Riskscape's type system.
- TYPE - Static variable in class nz.org.riskscape.engine.types.Anything
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.CoverageType
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.Enumeration
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.LambdaType
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.Nullable
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.RelationType
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.RSList
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.WithinRange
- TYPE_CONSTRUCTOR - Static variable in class nz.org.riskscape.engine.types.WithinSet
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.CoverageType
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.Enumeration
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.LambdaType
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.Nullable
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.RelationType
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.RSList
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.Struct
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.WithinRange
- TYPE_INFORMATION - Static variable in class nz.org.riskscape.engine.types.WithinSet
- TypeArgumentException - Exception in nz.org.riskscape.engine.typexp
-
Thrown when a particular argument received by a
TypeConstructor
isn't valid for the type - TypeArgumentException(AST.ComplexType, String) - Constructor for exception nz.org.riskscape.engine.typexp.TypeArgumentException
- TypeArgumentException(AST.ComplexType, TypeConstructor, String) - Constructor for exception nz.org.riskscape.engine.typexp.TypeArgumentException
- TypeBuilder - Interface in nz.org.riskscape.engine.typexp
-
Interface for constructing riskscape
Type
objects from a riskscape type-expression, e.g. - TypeBuildingException - Exception in nz.org.riskscape.engine.typexp
- TypeBuildingException(String) - Constructor for exception nz.org.riskscape.engine.typexp.TypeBuildingException
- TypeBuildingException(String, Throwable) - Constructor for exception nz.org.riskscape.engine.typexp.TypeBuildingException
- TypeBuildingException(Problem) - Constructor for exception nz.org.riskscape.engine.typexp.TypeBuildingException
- TypeConstructor - Interface in nz.org.riskscape.engine.typexp
- TypeConversionException(String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.TypeConversionException
- TypedCoverage - Interface in nz.org.riskscape.engine.coverage
-
A provider of
Type
values backed by aCoverage
. - TypedCoverage.Empty - Class in nz.org.riskscape.engine.coverage
-
An empty coverage, useful for testing, stubs, or proxy implementations
- typedValues() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the typed command line arguments matched by this option or positional parameter spec.
- typeInfo() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns the type info for the annotated program element associated with this group.
- typeInfo() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns the type info for the annotated program element associated with this group.
- typeInfo() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the type info for this option or positional parameter.
- typeInfo() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the
ITypeInfo
that can be used both at compile time (by annotation processors) and at runtime. - typeInfo(CommandLine.Model.ITypeInfo) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets the type info for the annotated program element associated with this group, and returns this builder.
- typeInfo(CommandLine.Model.ITypeInfo) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the type info for this option or positional parameter, and returns this builder.
- TypeInformation - Class in nz.org.riskscape.engine.types
-
Meta-class for riskscape types that allows types to be plugged in to the riskscape engine.
- TypeInformation(String, Class<? extends Type>, Class<?>, TypeConstructor) - Constructor for class nz.org.riskscape.engine.types.TypeInformation
- TypeInformation(String, Class<? extends Type>, Class<?>, TypeConstructor, Optional<TypeIOConstructor>) - Constructor for class nz.org.riskscape.engine.types.TypeInformation
- TypeIO - Interface in nz.org.riskscape.engine.io
-
java.nio based interface for reading and writing riskscape-typed objects from and to a
ByteBuffer
. - TypeIOBuilder - Interface in nz.org.riskscape.engine.io
-
Builder/Factory interface for a type that can construct
TypeIO
objects for arbitrary types - TypeIOConstructor - Interface in nz.org.riskscape.engine.io
-
Functional interface for constructing a
TypeIO
object from a type. - TypeProblems - Interface in nz.org.riskscape.engine.types
- TypeProvider - Interface in nz.org.riskscape.engine.types
- TypeRegistry - Class in nz.org.riskscape.engine.types
- TypeRegistry() - Constructor for class nz.org.riskscape.engine.types.TypeRegistry
- TypeRules - Interface in nz.org.riskscape.engine.typeset
-
Minimal
TypeSet
interface for use when only testing of types is required/allowed. - Types - Class in nz.org.riskscape.engine.types
-
Singleton instances of SimpleValued types to avoid needless construction TODO maybe make the constructors package level to hammer it home?
- Types() - Constructor for class nz.org.riskscape.engine.types.Types
- TypeSafeAncestorRule<T1 extends Type,
T2 extends Type> - Class in nz.org.riskscape.engine.types.ancestor -
Type safety wrapper around an
AncestorRule
to avoid having to instanceof test the types - TypeSafeAncestorRule() - Constructor for class nz.org.riskscape.engine.types.ancestor.TypeSafeAncestorRule
- TypeSafeAncestorRule(Class<T1>, Class<T2>) - Constructor for class nz.org.riskscape.engine.types.ancestor.TypeSafeAncestorRule
- TypeSet - Class in nz.org.riskscape.engine.typeset
- TypeSet() - Constructor for class nz.org.riskscape.engine.typeset.TypeSet
- TypeSet(TypeRegistry) - Constructor for class nz.org.riskscape.engine.typeset.TypeSet
- TypeVisitor<T,
U> - Interface in nz.org.riskscape.engine.types -
A Visitor interface for descending through an arbitrary type 'tree' - the other half of
Type.visit(TypeVisitor, Object)
.
U
- UnaryFunction<T> - Class in nz.org.riskscape.engine.function
- UnaryFunction(Type, Type, Function<T, Object>) - Constructor for class nz.org.riskscape.engine.function.UnaryFunction
- UNASSIGNED - Enum constant in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
- UnbindableParameterException - Exception in nz.org.riskscape.engine.bind
-
Deprecated.Move over to APIs that use
NoBindingAvailableException
- UnbindableParameterException(Parameter, String, Object...) - Constructor for exception nz.org.riskscape.engine.bind.UnbindableParameterException
-
Deprecated.
- UNCATEGORIZED - Static variable in class nz.org.riskscape.engine.function.FunctionMetadata
- unchecked(Predicate<Tuple>) - Static method in interface nz.org.riskscape.engine.join.JoinCondition
- unchecked(String) - Static method in class nz.org.riskscape.problem.ResultOrProblems
- Unchecked - Class in nz.org.riskscape.engine
- Unchecked(String) - Constructor for class nz.org.riskscape.engine.Unchecked
- underline - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
- UNEXPECTED_CHARACTER - Enum constant in enum class nz.org.riskscape.dsl.LexerException.ProblemCodes
- UNEXPECTED_EOF - Enum constant in enum class nz.org.riskscape.dsl.LexerException.ProblemCodes
- UNEXPECTED_IDENTIFIER - Enum constant in enum class nz.org.riskscape.dsl.ProblemCodes
- UNEXPECTED_TOKEN - Enum constant in enum class nz.org.riskscape.dsl.ProblemCodes
- UNEXPECTED_WHITESPACE - Enum constant in enum class nz.org.riskscape.dsl.ProblemCodes
- unexpectedNullValue(String, String) - Method in interface nz.org.riskscape.engine.data.InputDataProblems
-
A null value was encountered unexpectedly, which is highly likely to be coming directly from the user's input data file, e.g.
- UnexpectedNullValueException - Exception in nz.org.riskscape.engine.relation
-
Thrown when a null value was unexpectedly encountered in the input data.
- UnexpectedNullValueException(Problem) - Constructor for exception nz.org.riskscape.engine.relation.UnexpectedNullValueException
- UnexpectedTokenException - Exception in nz.org.riskscape.dsl
-
Thrown by a Parser when we got a token we weren't expecting
- UnexpectedTokenException(Set<? extends TokenType>, Token) - Constructor for exception nz.org.riskscape.dsl.UnexpectedTokenException
- UnexpectedTokenException(Problem, Set<? extends TokenType>, Token) - Constructor for exception nz.org.riskscape.dsl.UnexpectedTokenException
- uniform(TokenTypes, Type, Class<T>, BiPredicate<T, T>) - Static method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- UNKNOWN - Enum constant in enum class nz.org.riskscape.engine.types.varule.Variance
-
This rule is not applicable for the given types - not a yes or a no.
- UNKNOWN - Static variable in class nz.org.riskscape.engine.BuildInfo
-
Useful default for various testing scenarios
- UNKNOWN - Static variable in interface nz.org.riskscape.engine.resource.Resource
-
Null alternative for a Resource - use this in place of null where there is no obvious resource to provide as metadata.
- UNKNOWN_LOCATION - Static variable in class nz.org.riskscape.dsl.Token
- UNKNOWN_URI - Static variable in interface nz.org.riskscape.engine.resource.Resource
-
A URI for use with UNKNOWN
- unknownCrsCode(String) - Method in interface nz.org.riskscape.engine.GeometryProblems
-
Return this to explain that a CRS name couldn't be turned in to a
CoordinateReferenceSystem
. - unknownFormatTip() - Method in interface nz.org.riskscape.engine.data.BookmarkProblems
-
Format was explicitly specified, but not recognized.
- UnknownFunctionException - Exception in nz.org.riskscape.engine
-
Thrown when an object is asked for by id from the engine, but the engine doesn't know a function by that id.
- UnknownFunctionException(String) - Constructor for exception nz.org.riskscape.engine.UnknownFunctionException
- UnknownFunctionException(String, Collection<String>) - Constructor for exception nz.org.riskscape.engine.UnknownFunctionException
- UnknownSRIDException - Exception in nz.org.riskscape.engine
-
Thrown by
SRIDSet
when theSRIDSet.get(int)
method does not have aCoordinateReferenceSystem
by that id - UnknownSRIDException(int) - Constructor for exception nz.org.riskscape.engine.UnknownSRIDException
- UnknownTypeException - Exception in nz.org.riskscape.engine.typexp
-
Thrown by a
TypeBuilder
when aAST.Symbol
orAST.ComplexType
is encountered that is not known to the type builder, e.g. - UnknownTypeException(String, AST) - Constructor for exception nz.org.riskscape.engine.typexp.UnknownTypeException
- UnknownTypeException(AST.ComplexType) - Constructor for exception nz.org.riskscape.engine.typexp.UnknownTypeException
- UnknownTypeException(AST.Symbol) - Constructor for exception nz.org.riskscape.engine.typexp.UnknownTypeException
- unmatched() - Method in class nz.org.riskscape.picocli.CommandLine.ParseResult
-
Returns a list of command line arguments that did not match any options or positional parameters.
- unmatchedArgsBindings() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the list of
UnmatchedArgumentsBindings
configured for this command; eachUnmatchedArgsBinding
captures the arguments that could not be matched to any options or positional parameters. - UnmatchedArgumentException(CommandLine, String) - Constructor for exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
- UnmatchedArgumentException(CommandLine, List<String>) - Constructor for exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
- UnmatchedArgumentException(CommandLine, Stack<String>) - Constructor for exception nz.org.riskscape.picocli.CommandLine.UnmatchedArgumentException
- unmatchedArgumentsAllowed() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- unmatchedArgumentsAllowed(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- unmatchedOptionsArePositionalParams() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- unmatchedOptionsArePositionalParams(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- UNSET_SRID - Static variable in class nz.org.riskscape.engine.SRIDSet
-
Geometry's with this srid have not had an srid assigned by an SridSet.
- unspecified(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Range
-
Returns a new Range object with the
isUnspecified
value replaced by the specified value. - unsupportedCrs(CoordinateReferenceSystem) - Method in interface nz.org.riskscape.engine.OutputProblems
-
A fallback problem when an Output format is unable to handle a non EPSG defined CRS.
- unsupportedFormat(File) - Method in interface nz.org.riskscape.engine.FileProblems
-
Produces an error like:
is in an unsupported format - unsupportedScheme(String) - Method in interface nz.org.riskscape.engine.resource.ResourceProblems
- untyped(TokenTypes, Type, Type, BiPredicate<Object, Object>) - Static method in class nz.org.riskscape.engine.function.BinaryPredicateFunction
- UntypedFunction - Interface in nz.org.riskscape.engine.function
-
A minimal
RiskscapeFunction
interface, which exists for two reasons: 1) store a reference to a first-class function in a tuple 2) a minimal functional interface for use with creating minimal riskscape functions without having to implementRiskscapeFunction
. - unwrap() - Method in class nz.org.riskscape.engine.types.Nothing
- unwrap() - Method in interface nz.org.riskscape.engine.types.Type
- unwrap(Type) - Static method in class nz.org.riskscape.engine.types.Nullable
- updateArgGroupAttributes(CommandLine.ArgGroup) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Updates this builder from the specified annotation values.
- updateCommandAttributes(CommandLine.Command, CommandLine.IFactory) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Updates the following attributes from the specified
@Command
annotation: aliases,parser separator
, command name, version, help command, version provider, default provider andusage message spec
. - updateStatus(List<String>) - Method in interface nz.org.riskscape.cli.Terminal
-
Update the terminal's status area with the following text.
- usage(PrintStream) - Method in class nz.org.riskscape.picocli.CommandLine
-
Delegates to
CommandLine.usage(PrintStream, Help.ColorScheme)
with the configured color scheme. - usage(PrintStream, CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine
-
Delegates to
CommandLine.usage(PrintStream, Help.ColorScheme)
with the default color scheme. - usage(PrintStream, CommandLine.Help.ColorScheme) - Method in class nz.org.riskscape.picocli.CommandLine
-
Prints a usage help message for the annotated command class to the specified
PrintStream
. - usage(PrintWriter) - Method in class nz.org.riskscape.picocli.CommandLine
-
Delegates to
CommandLine.usage(PrintWriter, Help.ColorScheme)
with the configured color scheme. - usage(PrintWriter, CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine
-
Similar to
CommandLine.usage(PrintStream, Help.Ansi)
but with the specifiedPrintWriter
instead of aPrintStream
. - usage(PrintWriter, CommandLine.Help.ColorScheme) - Method in class nz.org.riskscape.picocli.CommandLine
-
Similar to
CommandLine.usage(PrintStream, Help.ColorScheme)
, but with the specifiedPrintWriter
instead of aPrintStream
. - usage(Object, PrintStream) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Equivalent to
new CommandLine(command).usage(out)
. - usage(Object, PrintStream, CommandLine.Help.Ansi) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Equivalent to
new CommandLine(command).usage(out, ansi)
. - usage(Object, PrintStream, CommandLine.Help.ColorScheme) - Static method in class nz.org.riskscape.picocli.CommandLine
-
Equivalent to
new CommandLine(command).usage(out, colorScheme)
. - USAGE - Static variable in class nz.org.riskscape.picocli.CommandLine.ExitCode
-
Return value from the
execute
method signifying command line usage error: user input for the command was incorrect, e.g., the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever. - usageHelp() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns whether this option allows the user to request usage help.
- usageHelp() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns whether this option allows the user to request usage help.
- usageHelp() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Set
usageHelp=true
for the--help
option that triggers display of the usage help message. - usageHelp(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Sets whether this option allows the user to request usage help, and returns this builder.
- usageHelpAutoWidth() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
If
true
, picocli will attempt to detect the terminal width and adjust the usage help message accordingly. - usageHelpWidth() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Set the
usage help message width
. - usageMessage() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the usage help message specification for this command.
- usageMessage(CommandLine.Model.UsageMessageSpec) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.
- UsageMessageSpec() - Constructor for class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
- useAnsi(CommandLine.Help.Ansi) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.
- useErr(PrintStream) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.use
CommandLine.setErr(PrintWriter)
andCommandLine.execute(String...)
instead - useOut(PrintStream) - Method in class nz.org.riskscape.picocli.CommandLine.AbstractHandler
-
Deprecated.use
CommandLine.setOut(PrintWriter)
andCommandLine.execute(String...)
instead - user - Variable in class nz.org.riskscape.engine.pipeline.Manifest.LocalInfo
- UserDefinedParameter - Interface in nz.org.riskscape.engine.bind
- userObject() - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Returns the user object associated with this option or positional parameters.
- userObject() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgSpec
-
Returns the user object associated with this option or positional parameters.
- userObject() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the user object associated with this command.
- userObject() - Method in interface nz.org.riskscape.picocli.CommandLine.Model.IAnnotatedElement
- userObject(Object) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the user object associated with this option or positional parameters, and returns this builder.
- userSpecifiedFormatIgnored(Format, PipelineOutputStore) - Method in interface nz.org.riskscape.engine.OutputProblems
-
The user has specified that outputs should be saved in the given format, but this will be ignored.
- useSimplifiedAtFiles() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- useSimplifiedAtFiles(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ParserSpec
- usingAst(PipelineDeclaration) - Static method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Create a pipeline with the given ast as metadata - it won't necessarily have been built from the ast yet.
V
- validate() - Method in interface nz.org.riskscape.engine.data.ResolvedBookmark
- validate() - Method in interface nz.org.riskscape.engine.function.JavaFunction.Delegate
- validate() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.ArgGroup
-
Determines whether picocli should validate the rules of this group (
true
by default). - validate() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-ocurring group this means that all arguments in the group are specified on the command line.
- validate() - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec
-
Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-ocurring group this means that all arguments in the group are specified on the command line.
- validate(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.ArgGroupSpec.Builder
-
Sets whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-ocurring group this means that all arguments in the group are specified on the command line.
- validate(Consumer<Problem>) - Method in interface nz.org.riskscape.engine.Project
-
Validates the project for correctness, passing any error/problems encountered to the problem consumer.
- validate(Consumer<Problem>) - Method in class nz.org.riskscape.engine.typeset.TypeSet
- validate(BindingContext, Object) - Method in class nz.org.riskscape.engine.bind.Parameter
-
Performs optional additional validation on a value bound to this parameter.
- validate(BindingContext, Object) - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
-
Optionally validates that the bound value for the parameter conforms to this property, e.g.
- validate(BindingContext, Object) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- validate(BindingContext, Consumer<Problem>) - Method in interface nz.org.riskscape.engine.FunctionSet
-
Validates that the functions are valid.
- validate(Project, Consumer<Problem>) - Method in interface nz.org.riskscape.engine.data.Bookmarks
- validate(RealizationContext) - Method in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- validate(RealizationContext) - Method in class nz.org.riskscape.engine.function.JavaFunction
- validate(RealizationContext) - Method in interface nz.org.riskscape.engine.function.RiskscapeFunction
-
Validate that the function can be run.
- validate(Struct) - Method in interface nz.org.riskscape.engine.join.JoinCondition
- validate(Struct) - Method in interface nz.org.riskscape.engine.restriction.Restriction
- validate(Struct, ExpressionRealizer) - Method in class nz.org.riskscape.engine.sort.SortBy
-
Validate that tupleType would be able to be sorted by this SortBy.
- validateBoundParameters(List<Parameter>, Map<String, List<?>>) - Method in interface nz.org.riskscape.engine.bind.BindingContext
-
Checks that the given map of bound parameter objects are valid according to the list of parameters.
- validateExistingFileOrUri(Parameter, String) - Static method in interface nz.org.riskscape.engine.bind.ParameterBinder
-
Useful pre-emptive validation for values before they go in to geotools to check whether they look openable.
- value - Variable in class nz.org.riskscape.dsl.Token
- value - Variable in class nz.org.riskscape.engine.typexp.AST
- value() - Element in annotation interface nz.org.riskscape.engine.problem.Affecting
- value() - Element in annotation interface nz.org.riskscape.engine.problem.SeverityLevel
- Value - Class in nz.org.riskscape.engine.types
-
Represents any java object that has been coerced to the associated type.
- Value(Type, Object) - Constructor for class nz.org.riskscape.engine.types.Value
-
Creates a new value.
- ValueList(Token, List<AST>) - Constructor for class nz.org.riskscape.engine.typexp.AST.ValueList
- valueOf(boolean) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Returns Ansi.ON if the specified
enabled
flag is true, Ansi.OFF otherwise. - valueOf(String) - Static method in enum class nz.org.riskscape.dsl.LexerException.ProblemCodes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.dsl.ProblemCodes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.geo.GeometryFamily
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.geo.GeometryValidation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.join.JoinType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.output.Format.Characteristics
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.pipeline.Collector.Characteristic
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.pipeline.NestedPipelineStep.State
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.problem.Affecting.Target
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.query.TupleUtils.FindOption
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.rl.ExpressionRealizer.ProblemCodes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.sort.SortBy.Direction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.Tuple.CoerceOptions
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.engine.types.varule.Variance
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Column.Overflow
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Visibility
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in class nz.org.riskscape.picocli.CommandLine.Range
-
Leniently parses the specified String as an
Range
value and return the result. - valueOf(String) - Static method in enum class nz.org.riskscape.problem.Problem.Severity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.problem.StandardCodes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.ReflectionUtils.SearchOptions
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nz.org.riskscape.rl.TokenTypes
-
Returns the enum constant of this class with the specified name.
- valueOutOfRange(Object, T, Range<T>) - Method in interface nz.org.riskscape.engine.problem.GeneralProblems
-
A given value was outside of an expected range.
- values - Variable in class nz.org.riskscape.engine.typexp.AST.Dictionary
- values - Variable in class nz.org.riskscape.engine.typexp.AST.ValueList
- values() - Static method in enum class nz.org.riskscape.dsl.LexerException.ProblemCodes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.dsl.ProblemCodes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.function.IdentifiedFunction.Category
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.geo.GeometryFamily
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.geo.GeometryValidation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.join.JoinType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.output.Format.Characteristics
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.pipeline.Collector.Characteristic
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.pipeline.NestedPipelineStep.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.pipeline.Pipeline.ProblemCodes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.problem.Affecting.Target
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.query.TupleUtils.FindOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.rl.ExpressionRealizer.ProblemCodes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.sort.SortBy.Direction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.Tuple.CoerceOptions
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.engine.types.varule.Variance
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi.Style
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Ansi
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Column.Overflow
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.picocli.CommandLine.Help.Visibility
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.problem.Problem.Severity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.problem.StandardCodes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.ReflectionUtils.SearchOptions
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nz.org.riskscape.rl.TokenTypes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Variance - Enum Class in nz.org.riskscape.engine.types.varule
-
Represents the result of a
TypeSet.testVariance(nz.org.riskscape.engine.types.Type,nz.org.riskscape.engine.types.Type)
- VarianceRule - Interface in nz.org.riskscape.engine.types.varule
-
Variance rules allow the type system to advise whether one type's values can be directly assigned to another without having to alter the receiving type (and consequently value).
- verify(Path, Formatter) - Static method in class nz.org.riskscape.engine.pipeline.Manifest
-
Verifies that the output files contained in manifest.txt have not been tampered with.
- version - Variable in class nz.org.riskscape.engine.pipeline.Manifest.VersionInfo
- version() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Version information for this command, to print to the console when the user specifies an option to request version help.
- version() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns version information for this command, to print to the console when the user specifies an option to request version help.
- version(String...) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets version information literals for this command, to print to the console when the user specifies an option to request version help.
- VERSION - Static variable in class nz.org.riskscape.picocli.CommandLine
-
This is picocli version "4.1.2".
- versionHelp() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Returns whether this option allows the user to request version information.
- versionHelp() - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec
-
Returns whether this option allows the user to request version information.
- versionHelp() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Option
-
Set
versionHelp=true
for the--version
option that triggers display of the version information. - versionHelp(boolean) - Method in class nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder
-
Sets whether this option allows the user to request version information, and returns this builder.
- versionInfo - Variable in class nz.org.riskscape.engine.pipeline.Manifest
- VersionInfo(String, String) - Constructor for class nz.org.riskscape.engine.pipeline.Manifest.VersionInfo
- versionProvider() - Element in annotation interface nz.org.riskscape.picocli.CommandLine.Command
-
Class that can provide version information dynamically at runtime.
- versionProvider() - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Returns the version provider for this command, to generate the
CommandLine.Model.CommandSpec.version()
strings. - versionProvider(CommandLine.IVersionProvider) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets version provider for this command, to generate the
CommandLine.Model.CommandSpec.version()
strings. - visit(BiFunction<NamedStep, List<T>, T>) - Method in class nz.org.riskscape.engine.pipeline.Pipeline
-
Visit all steps in the DAG in dependency order.
- visit(TypeVisitor<T, U>, T) - Method in interface nz.org.riskscape.engine.types.ContainingType
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.EmptyList
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.Enumeration
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.FunctionType
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.GeomType
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.LambdaType
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.LookupTableType
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.MultiGeom
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.ScopedLambdaType
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.SimpleType
- visit(TypeVisitor<T, U>, T) - Method in class nz.org.riskscape.engine.types.Struct
- visit(TypeVisitor<T, U>, T) - Method in interface nz.org.riskscape.engine.types.Type
-
Type specific visiting logic.
- visit(TypeVisitor<T, U>, T) - Method in interface nz.org.riskscape.engine.types.WrappingType
- visit(BinaryOperation, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(BinaryOperation, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(BinaryOperation, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(BinaryOperation, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(BracketedExpression, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(BracketedExpression, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(BracketedExpression, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(BracketedExpression, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(Constant, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(Constant, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(Constant, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(Constant, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(FunctionCall, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(FunctionCall, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(FunctionCall, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(FunctionCall, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(Lambda, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(Lambda, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(Lambda, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(Lambda, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(ListDeclaration, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(ListDeclaration, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(ListDeclaration, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(ListDeclaration, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(ParameterToken, List<ParameterToken>) - Method in class nz.org.riskscape.pipeline.ast.ParameterReplacer
- visit(ParameterToken, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(ParameterToken, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(ParameterToken, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(ParameterToken, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(PropertyAccess, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(PropertyAccess, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(PropertyAccess, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(PropertyAccess, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(SelectAllExpression, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(SelectAllExpression, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(SelectAllExpression, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(SelectAllExpression, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- visit(StructDeclaration, T) - Method in class nz.org.riskscape.rl.ast.BaseExpressionConverter
- visit(StructDeclaration, T) - Method in class nz.org.riskscape.rl.ast.ExpressionConverter
- visit(StructDeclaration, T) - Method in interface nz.org.riskscape.rl.ast.ExpressionVisitor
- visit(StructDeclaration, T) - Method in class nz.org.riskscape.rl.ast.MinimalVisitor
- VISITOR_META_KEY - Static variable in class nz.org.riskscape.engine.types.LookupTableType
- VISITOR_META_RETURNS - Static variable in class nz.org.riskscape.engine.types.FunctionType
- VISITOR_META_VALUE - Static variable in class nz.org.riskscape.engine.types.LookupTableType
W
- WARN - Enum constant in enum class nz.org.riskscape.engine.geo.GeometryValidation
-
Geometry validation is checked, any invalid geometries should cause the user to be warned.
- warning(String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- warning(Throwable, String, Object...) - Static method in class nz.org.riskscape.problem.Problem
-
Deprecated.use the ProblemCode-based constructor instead
- WARNING - Enum constant in enum class nz.org.riskscape.problem.Problem.Severity
- width - Variable in class nz.org.riskscape.picocli.CommandLine.Help.Column
-
Column width in characters
- width() - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Returns the maximum usage help message width.
- width(int) - Method in class nz.org.riskscape.picocli.CommandLine.Model.UsageMessageSpec
-
Sets the maximum usage help message width to the specified value.
- wild(Map<String, List<String>>) - Static method in interface nz.org.riskscape.config.ConfigSection
-
Defeat Java's generics checking - it's safe to treat a list of strings as a list of wild things, but to do this with java's generics requires us to declare the receiver as
? extends List<?>
which complicates the receiver a lot. - WILD - Static variable in class nz.org.riskscape.engine.types.CoverageType
- WILD - Static variable in class nz.org.riskscape.engine.types.FunctionType
-
Wildcard style function type object, typically used with
RealizableFunction
s to say that some kind ofFunctionType
will be accepted, or in type problems to report a broad mismatch, e.g. - WILD - Static variable in class nz.org.riskscape.engine.types.LookupTableType
- WILD - Static variable in class nz.org.riskscape.engine.types.RelationType
-
Useful constant that represents a relation of any kind, in as much as a relation with no specific members is going to accept any other relation.
- WILDCARD_2D - Static variable in class nz.org.riskscape.engine.SRIDSet
-
A 2D wild card CRS.
- withArgumentTypes(List<Type>) - Method in class nz.org.riskscape.engine.function.JavaFunction
- withArgumentTypes(Type...) - Method in class nz.org.riskscape.engine.function.JavaFunction
- withChildren(List<? extends Problem>) - Method in class nz.org.riskscape.problem.Problem
-
Copy this Problem but add in more children.
- withChildren(Problem...) - Method in class nz.org.riskscape.problem.Problem
- withDefault(String, String, Object...) - Static method in class nz.org.riskscape.engine.i18n.RiskscapeMessage
-
Build a
RiskscapeMessage
with desired code and messageArguments. - withDefaults() - Static method in class nz.org.riskscape.engine.types.TypeRegistry
- withDefaultValue(String) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- withDescription(String) - Method in class nz.org.riskscape.pipeline.PipelineMetadata
- withException(Throwable) - Method in class nz.org.riskscape.problem.Problem
-
Copy this Problem but with a new exception
- withExtraArgument(String, Type) - Method in class nz.org.riskscape.engine.function.ArgumentList
-
Convenience version of
that accepts the keyword and type of the extra argument</p>
- withExtraArgument(FunctionArgument...) - Method in class nz.org.riskscape.engine.function.ArgumentList
-
Return a new argument list which has the same arguments has this one but with extraArg appended.
- withFormat(String) - Method in class nz.org.riskscape.engine.data.Bookmark
- withId(String, Object, List<Problem>, List<Problem>) - Static method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Useful testing constructor to return a pre-constructed Object with a fake Bookmark object that has the desired bookmarkId.
- withId(String) - Static method in class nz.org.riskscape.engine.function.JavaFunction
- withId(String, Object) - Static method in interface nz.org.riskscape.engine.data.ResolvedBookmark
-
Useful testing constructor to return a pre-constructed Object with a fake Bookmark object that has the desired bookmarkId.
- withIdAndSource(String, String) - Static method in class nz.org.riskscape.engine.function.JavaFunction
- WithinRange - Class in nz.org.riskscape.engine.types
-
Type that limits value to be within a specified range.
- WithinRange(Rangeable, Object, Object) - Constructor for class nz.org.riskscape.engine.types.WithinRange
- WithinSet - Class in nz.org.riskscape.engine.types
-
Can be one of the given values.
- WithinSet(Type, Object...) - Constructor for class nz.org.riskscape.engine.types.WithinSet
- WithinSet(Type, Collection<?>) - Constructor for class nz.org.riskscape.engine.types.WithinSet
- withLabel(String) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- withLocation(URI) - Method in class nz.org.riskscape.engine.data.Bookmark
- withLocation(URI) - Method in class nz.org.riskscape.pipeline.PipelineMetadata
- withMetadata(PipelineMetadata) - Method in class nz.org.riskscape.engine.pipeline.RealizedPipeline
- withMetadata(PipelineMetadata) - Method in class nz.org.riskscape.pipeline.ast.PipelineDeclaration
-
Clones this PipelineDeclaration but with different metadata.
- WithMetadata - Class in nz.org.riskscape.engine.types
-
Wrapping type that stores extra metadata along with a given type.
- withMoreProblems(Collection<Problem>) - Method in class nz.org.riskscape.problem.ResultOrProblems
- withMoreProblems(Function<T, List<Problem>>) - Method in class nz.org.riskscape.problem.ResultOrProblems
-
Applies the given validation function to the computed result, and returns a new ResultOrProblems with any additional problems that were found
- withMoreProblems(List<Problem>) - Method in class nz.org.riskscape.engine.bind.BoundParameters
-
Lets the calling code include more bespoke validation problems besides the straight-forward binding errors.
- withMoreProblems(Problem...) - Method in class nz.org.riskscape.problem.ResultOrProblems
- withName(String) - Method in class nz.org.riskscape.pipeline.PipelineMetadata
- withNewDefaults(BiFunction<BindingContext, Parameter, List<?>>) - Method in class nz.org.riskscape.engine.bind.Parameter
-
Builds a new Parameter based on this one, but with new default value(s)
- withNewMembers(List<StructDeclaration.Member>, Optional<Pair<Token, Token>>) - Method in class nz.org.riskscape.rl.ast.StructDeclaration
- withNewName(String) - Method in class nz.org.riskscape.engine.bind.Parameter
- withNewRelativeTo(URI) - Method in interface nz.org.riskscape.engine.bind.BindingContext
- withNewType(Class<?>) - Method in class nz.org.riskscape.engine.bind.Parameter
- withNewType(Type) - Method in class nz.org.riskscape.engine.types.ancestor.AncestorType
-
Return a new
AncestorType
with the same conversion function, but a new type - withProperties(Set<ParameterProperty>) - Method in class nz.org.riskscape.engine.bind.ParameterTemplate
- withReturnType(Type) - Method in class nz.org.riskscape.engine.function.JavaFunction
- withSeverity(Problem.Severity) - Method in class nz.org.riskscape.problem.Problem
-
Copy this Problem but with a new severity
- withToString(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.PositionalParamSpec.Builder
-
Sets the string respresentation of this option or positional parameter to the specified value, and returns this builder.
- withToString(String) - Method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Sets the string representation of this command, used in error messages and trace messages.
- withValidation(BiFunction<BindingContext, Object, List<Problem>>) - Method in class nz.org.riskscape.engine.bind.Parameter
- withValue(Object) - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
- withValue(BindingContext, Object) - Method in interface nz.org.riskscape.engine.bind.ParameterProperty
-
Clones this ParameterProperty with the value part of a key-value pair.
- wrap(String, String, Model) - Static method in interface nz.org.riskscape.engine.model.IdentifiedModel
- wrap(String, ParameterTemplate) - Static method in interface nz.org.riskscape.engine.bind.UserDefinedParameter
- wrap(RiskscapeFunction) - Static method in class nz.org.riskscape.engine.function.NullSafeFunction
-
Wrap the given target function in a null-safe version.
- wrap(Type) - Method in class nz.org.riskscape.engine.types.Referenced
-
Returns a new Type with underlyingType of toWrap with the same crs and bounds as this referenced.
- wrap(Type, Object...) - Static method in class nz.org.riskscape.engine.types.WithMetadata
-
Creates a new WithMetadata that wraps the given type and associates the metadata with it
- WRAP - Enum constant in enum class nz.org.riskscape.picocli.CommandLine.Help.Column.Overflow
- wrapFailedObject(Parameter, String, IdentifiedCollection<T>) - Static method in interface nz.org.riskscape.engine.bind.ParameterBinder
-
Helper method for wrapping a lookup to wrap a
FailedObjectException
in aParameterBindingException
- wrapIgnoringArgs(RiskscapeFunction) - Static method in class nz.org.riskscape.engine.function.NullSafeFunction
-
Wrap the given target function in a null-safe version.
- wrapLookup(Parameter, String, BindingContext, Class<T>) - Static method in interface nz.org.riskscape.engine.bind.ParameterBinder
-
Helper method for wrapping a lookup to wrap it in a
ParameterBindingException
- wrapNullable(Type) - Method in class nz.org.riskscape.engine.types.Referenced
-
Returns a new Type with underlyingType of toWrap with the same crs and bounds as this referenced.
- wrapped - Variable in class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- wrapped(Iterator<Tuple>, Optional<Runnable>) - Static method in interface nz.org.riskscape.engine.relation.TupleIterator
-
Wraps a normal iterator with this interface, making the close a noop.
- wrappedAndMapped(Iterator<T>, Function<T, Tuple>) - Static method in interface nz.org.riskscape.engine.relation.TupleIterator
-
Wraps a possibly normal Iterator with this interface, applying the given mapping functions to values yielded from the
Tuple
- WrappedTypeAncestorRule - Class in nz.org.riskscape.engine.types.ancestor
-
'peels' the onion of two wrapped types to find the common kernel.
- WrappedTypeAncestorRule() - Constructor for class nz.org.riskscape.engine.types.ancestor.WrappedTypeAncestorRule
- Wrapping(RiskscapeFunction, String, String, String, IdentifiedFunction.Category) - Constructor for class nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping
- WrappingType - Interface in nz.org.riskscape.engine.types
-
Wrapping types add extra restrictions or metadata to a type that narrows that type.
- WrappingTypesRule - Class in nz.org.riskscape.engine.types.varule
-
Will allow assignment if the source type is more specific than the target type.
- WrappingTypesRule() - Constructor for class nz.org.riskscape.engine.types.varule.WrappingTypesRule
- wrapWithoutInspection(Object) - Static method in class nz.org.riskscape.picocli.CommandLine.Model.CommandSpec
-
Creates and returns a new
CommandSpec
with the specified associated user object. - write(OutputStream) - Method in class nz.org.riskscape.engine.pipeline.Manifest
-
Write the manifest to pipelineDirectory.
- write(ByteBuffer, Object) - Method in interface nz.org.riskscape.engine.io.TypeIO
-
Write a value out to the given byte buffer
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Anything
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Bool
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Date
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Decimal
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Floating
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Geom
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.GeomType
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Integer
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Nothing
- write(ByteBuffer, Object) - Method in class nz.org.riskscape.engine.types.Text
- write(Tuple) - Method in interface nz.org.riskscape.engine.io.TupleWriter
-
Write a
Tuple
to the underlying stream. - write(Tuple) - Method in class nz.org.riskscape.engine.output.RiskscapeWriter
-
Appends a value to the output
- WriterConstructor - Interface in nz.org.riskscape.engine.output
-
Functional interface for something that is able to create a
RiskscapeWriter
. - writesType() - Method in interface nz.org.riskscape.engine.io.TypeIO
- writesType() - Method in class nz.org.riskscape.engine.types.SimpleType
- writeTo(Formatter) - Method in class nz.org.riskscape.engine.pipeline.Manifest
-
Write the manifest file describing a pipeline run.
- wrongNumber(int, int) - Method in interface nz.org.riskscape.engine.ArgsProblems
- wrongNumber(Range<Integer>, int) - Method in interface nz.org.riskscape.engine.ArgsProblems
- wrongNumberGiven(String, String, int) - Method in interface nz.org.riskscape.engine.bind.ParamProblems
- wrongNumberRange(int, int, int) - Method in interface nz.org.riskscape.engine.ArgsProblems
-
When a variable number of arguments is allowed, but the number supplied is outside of that range.
Z
- ZERO_LENGTH_TOKEN - Enum constant in enum class nz.org.riskscape.dsl.LexerException.ProblemCodes
- zeroBased(String...) - Static method in class nz.org.riskscape.engine.types.Enumeration
-
Construct a Riskscape Enumeration from the given array of strings.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form