com.chemaxon.apidiscovery.linenote

Interface Linenote<T>

Type Parameters:

T - Created instances

public interface Linenote<T>

Linear notation of a parameterization. Linear parameterization notation is typically used in creating dynamic user interfaces through a remoting protocol (like REST). Description of the parameterization (choiceDescriptors() is typically sent to the user interface in a serialized (like JSON) format. This description is use to provide the user the necessary inputs and to build a single string representation of the user's choice.

Method Summary

Modifier and Type	Method and Description
List<ChoiceDescriptor>	choiceDescriptors() Available choices.
default ImmutableSet<String>	getChoiceLabels() Get all available choice labels.
T	parse(String s) Parse a line notation.
T	parseWithVariableSubstitution(String s, String pattern, Function<String,String> variables) Parse linenote with value parameter substitutions.

Method Detail

choiceDescriptors

List<ChoiceDescriptor> choiceDescriptors()

Available choices. The returned choices represent the rules to compose a valid linear parameterization. Typically this description is used by the UI layer.

Returns:

Choices to expose to the UI

parse

T parse(String s)

Parse a line notation. Typically the linear notation is composed by the UI layer and parsed on the backend.

Parameters:

s - Line notation to apply

Returns:

Instance created

Throws:

IllegalArgumentException - if creation failed

parseWithVariableSubstitution

T parseWithVariableSubstitution(String s,
                                String pattern,
                                Function<String,String> variables)

Parse linenote with value parameter substitutions.

Parameters:

s - Line notation to apply

pattern - Regular expression to capture parameter expressions

variables - Lookup for variable values

Returns:

Instance created

Throws:

IllegalArgumentException - if creation failed

getChoiceLabels

default ImmutableSet<String> getChoiceLabels()

Get all available choice labels.

Returns:

All choice labels