com.cultofbits.integrationm.service.dictionary.recordm

Class RecordmInstance

java.lang.Object

com.cultofbits.integrationm.service.dictionary.recordm.RecordmInstance

public class RecordmInstance
extends Object

This class wraps Map representing instances in a way that simplifies the most common cases.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RecordmInstance.Field Represents a field from an Instance.

Constructor Summary

Constructors

Constructor and Description
RecordmInstance(Map<String,Object> instance)

Method Summary

Modifier and Type	Method and Description
RecordmInstance.Field	field(String name) Selects a field by name.
Object	get(String name) The value of a matching property.
List<Map<String,Object>>	getFields() Returns all fields.
Integer	getId() The instance identifier
Map<String,Object>	getRaw() Get the raw representation of the instance as a Map.
String	toString()
String	value(Function<Map<String,Object>,Boolean> predicate) The first value of a matching field.
String	value(String name) The first value of a matching field.
Object	value(String name, Class aClass) The first value of a matching field converted to a specific type.
List<String>	values(Function<Map<String,Object>,Boolean> predicate) Get all the values of fields that match a predicate.
List<String>	values(String name) Get all the values of fields with the specified name.
List<Object>	values(String name, Class aClass) Get all the values of fields with the specified name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordmInstance

public RecordmInstance(Map<String,Object> instance)

Method Detail

field

public RecordmInstance.Field field(String name)

Selects a field by name.

Parameters:

name - the name of the field

get

public Object get(String name)

The value of a matching property.

Parameters:

name - the name of the property

Returns:

the value of the property.

getFields

public List<Map<String,Object>> getFields()

Returns all fields.
It simplifies access to fields even when they come organized in a tree. Such is the case, for example, if a RecordmInstance is built with the output of a RecordmActionPack.get(int).

getId

public Integer getId()

The instance identifier

getRaw

public Map<String,Object> getRaw()

Get the raw representation of the instance as a Map.

toString

public String toString()

Overrides:

toString in class Object

value

public String value(Function<Map<String,Object>,Boolean> predicate)

The first value of a matching field.

Parameters:

predicate - a Function that accepts a Map representing each field and returns true when the field matches.

Returns:

the String value of the field.

value

public String value(String name)

The first value of a matching field.

Parameters:

name - the name of the field

Returns:

the String value of the field. Use ${value(String, Class)} to get the value as a specific type

value

public Object value(String name,
                    Class aClass)

The first value of a matching field converted to a specific type.

The accepted types for this method can be divided into number types:

• Integer
• Long
• Double
• BigDecimal

and date types:

• Date
• LocalDate
• LocalDateTime
• Instant

Parameters:

name - the name of the field

aClass - the type to convert the field to

Returns:

the value of the field.

values

public List<String> values(Function<Map<String,Object>,Boolean> predicate)

Get all the values of fields that match a predicate.

Parameters:

predicate - a Function that accepts a Map representing each field and returns true when the field matches.

Returns:

a List of the values of the fields.

values

public List<String> values(String name)

Get all the values of fields with the specified name.
Multiple values can be returned for either multiple fields or different fields with the same name.

Parameters:

name - the name of the field(s)

Returns:

a List of the String values of the fields. Use ${values(String, Class)} to get the values as a specific type

values

public List<Object> values(String name,
                           Class aClass)

Get all the values of fields with the specified name.
Multiple values can be returned for either multiple fields or different fields with the same name.

Parameters:

name - the name of the field(s)

aClass - the type to convert the field to. See value(String, Class) for supported types.

Returns:

a List of the values of the fields.