org.neo4j.driver.v1

Interface Record

All Superinterfaces:

MapAccessorWithDefaultValue

@Immutable
public interface Record
extends MapAccessorWithDefaultValue

Container for Cypher result values.

Streams of records are returned from Cypher statement execution, contained within a StatementResult.

A record is a form of ordered map and, as such, contained values can be accessed by either positional index or textual key.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Return this record as a map, where each value has been converted to a default java object using Value.asObject().
<T> Map<String,T>	asMap(Function<Value,T> mapper) Return this record as a map, where each value has been converted using the provided mapping function.
boolean	containsKey(String key) Check if the list of keys contains the given key
List<Pair<String,Value>>	fields() Retrieve all record fields
Value	get(int index) Retrieve the value at the given field index
Value	get(String key) Retrieve the value of the property with the given key
int	index(String key) Retrieve the index of the field with the given key
List<String>	keys() Retrieve the keys of the underlying map
int	size() Retrieve the number of fields in this record
List<Value>	values() Retrieve the values of the underlying map

Methods inherited from interface org.neo4j.driver.v1.types.MapAccessorWithDefaultValue

get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get

Method Detail

keys

List<String> keys()

Retrieve the keys of the underlying map

Returns:

all field keys in order

values

List<Value> values()

Retrieve the values of the underlying map

Returns:

all field keys in order

containsKey

boolean containsKey(String key)

Check if the list of keys contains the given key

Parameters:

key - the key

Returns:

true if this map keys contains the given key otherwise false

index

int index(String key)

Retrieve the index of the field with the given key

Parameters:

key - the give key

Returns:

the index of the field as used by get(int)

Throws:

NoSuchElementException - if the given key is not from keys()

get

Value get(String key)

Retrieve the value of the property with the given key

Parameters:

key - the key of the property

Returns:

the property's value or a NullValue if no such key exists

Throws:

NoSuchRecordException - if the associated underlying record is not available

get

Value get(int index)

Retrieve the value at the given field index

Parameters:

index - the index of the value

Returns:

the value or a NullValue if the index is out of bounds

Throws:

ClientException - if record has not been initialized

size

int size()

Retrieve the number of fields in this record

Returns:

the number of fields in this record

asMap

Map<String,Object> asMap()

Return this record as a map, where each value has been converted to a default java object using Value.asObject(). This is equivalent to calling asMap(Function) with Values.ofObject().

Returns:

this record as a map

asMap

<T> Map<String,T> asMap(Function<Value,T> mapper)

Return this record as a map, where each value has been converted using the provided mapping function. You can find a library of common mapping functions in Values.

Type Parameters:

T - the type to convert to

Parameters:

mapper - the mapping function

Returns:

this record as a map

See Also:

for a long list of built-in conversion functions

fields

List<Pair<String,Value>> fields()

Retrieve all record fields

Returns:

all fields in key order

Throws:

NoSuchRecordException - if the associated underlying record is not available