Module spring.data.relational

Package org.springframework.data.relational.core.conversion

Class RowDocumentAccessor

java.lang.Object

org.springframework.data.relational.core.conversion.RowDocumentAccessor

public class RowDocumentAccessor
extends Object

Wrapper value object for a RowDocument to be able to access raw values by RelationalPersistentProperty references. The accessors will transparently resolve nested document values that a RelationalPersistentProperty might refer to through a path expression in field names.

Since:

3.2

Author:

Mark Paluch, Chanhyeong Cho

Method Summary

Modifier and Type	Method	Description
RowDocument	document()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.6, this method was not intended to be exposed publicly.
boolean	equals(Object obj)
Object	get(RelationalPersistentProperty property)	Returns the value the given RelationalPersistentProperty refers to.
RowDocument	getDocument()
int	hashCode()
boolean	hasValue(RelationalPersistentProperty property)	Returns whether the underlying RowDocument has a value (null or non-null) for the given RelationalPersistentProperty.
void	put(RelationalPersistentProperty prop, Object value)	Puts the given value into the backing RowDocument based on the coordinates defined through the given RelationalPersistentProperty.
void	putAll(RowDocument source)	Copies all mappings from the given RowDocument to the underlying target RowDocument.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getDocument

public RowDocument getDocument()

Returns:

the underlying document.

putAll

public void putAll(RowDocument source)

Copies all mappings from the given RowDocument to the underlying target RowDocument. These mappings will replace any mappings that the target document had for any of the keys currently in the specified map.

Parameters:

source -

put

public void put(RelationalPersistentProperty prop,
 @Nullable
 Object value)

Puts the given value into the backing RowDocument based on the coordinates defined through the given RelationalPersistentProperty. By default, this will be the plain field name. But field names might also consist of path traversals so we might need to create intermediate RowDocuments.

Parameters:

prop - must not be null.

value - can be null.

get

@Nullable
public Object get(RelationalPersistentProperty property)

Returns the value the given RelationalPersistentProperty refers to. By default, this will be a direct field but the method will also transparently resolve nested values the RelationalPersistentProperty might refer to through a path expression in the field name metadata.

Parameters:

property - must not be null.

Returns:

can be null.

hasValue

public boolean hasValue(RelationalPersistentProperty property)

Returns whether the underlying RowDocument has a value (null or non-null) for the given RelationalPersistentProperty.

Parameters:

property - must not be null.

Returns:

true if no non null value present.

document

@Deprecated(since="3.2.6",
            forRemoval=true)
public RowDocument document()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.6, this method was not intended to be exposed publicly. Use getDocument() instead.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object