Package dev.dokimos.core

Record Class Example

java.lang.Object

java.lang.Record

dev.dokimos.core.Example

Record Components:

inputs - the input values

expectedOutputs - the expected output values

metadata - additional metadata

public record Example(Map<String,Object> inputs, Map<String,Object> expectedOutputs, Map<String,Object> metadata)
extends Record

A dataset example with inputs, expected outputs, and metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Example.Builder	Builder for constructing examples with multiple inputs and outputs.

Constructor Summary

Constructors

Constructor	Description
Example(Map<String,Object> inputs, Map<String,Object> expectedOutputs, Map<String,Object> metadata)	Compact constructor that creates immutable copies of all maps.

Method Summary

Modifier and Type	Method	Description
static Example.Builder	builder()	Creates a new builder for constructing examples.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	expectedOutput()	Returns the primary expected output value.
Map<String,Object>	expectedOutputs()	Returns the value of the expectedOutputs record component.
final int	hashCode()	Returns a hash code value for this object.
String	input()	Returns the primary input value.
Map<String,Object>	inputs()	Returns the value of the inputs record component.
Map<String,Object>	metadata()	Returns the value of the metadata record component.
static Example	of(String input, String expectedOutput)	Creates an example with a single input and expected output.
final String	toString()	Returns a string representation of this record class.
EvalTestCase	toTestCase(String actualOutput)	Converts this example to a test case with a single actual output.
EvalTestCase	toTestCase(Map<String,Object> actualOutputs)	Converts this example to a test case with the given actual outputs.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Example

public Example(Map<String,Object> inputs,
 Map<String,Object> expectedOutputs,
 Map<String,Object> metadata)

Compact constructor that creates immutable copies of all maps.

Method Details

of

public static Example of(String input,
 String expectedOutput)

Creates an example with a single input and expected output.

Parameters:

input - the input value

expectedOutput - the expected output value

Returns:

a new example

builder

public static Example.Builder builder()

Creates a new builder for constructing examples.

Returns:

a new builder

input

public String input()

Returns the primary input value.

Returns:

the input value or null if not present

expectedOutput

public String expectedOutput()

Returns the primary expected output value.

Returns:

the expected output value or null if not present

toTestCase

public EvalTestCase toTestCase(Map<String,Object> actualOutputs)

Converts this example to a test case with the given actual outputs.

Parameters:

actualOutputs - the actual outputs produced by the system

Returns:

a new test case

toTestCase

public EvalTestCase toTestCase(String actualOutput)

Converts this example to a test case with a single actual output.

Parameters:

actualOutput - the actual output value

Returns:

a new test case

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

inputs

public Map<String,Object> inputs()

Returns the value of the inputs record component.

Returns:

the value of the inputs record component

expectedOutputs

public Map<String,Object> expectedOutputs()

Returns the value of the expectedOutputs record component.

Returns:

the value of the expectedOutputs record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component