Package com.clickhouse.data.value

Class ClickHouseNestedValue

java.lang.Object

com.clickhouse.data.value.ClickHouseObjectValue<Object[][]>

com.clickhouse.data.value.ClickHouseNestedValue

All Implemented Interfaces:

ClickHouseValue, Serializable

public class ClickHouseNestedValue
extends ClickHouseObjectValue<Object[][]>

Wrapper class of Nested.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClickHouseNestedValue(List<ClickHouseColumn> columns, Object[][] values)

Method Summary

Modifier and Type	Method	Description
Object[]	asArray()	Gets value as an object array.
<T> T[]	asArray(Class<T> clazz)	Gets value as an array.
Map<Object,Object>	asMap()	Gets value as a map.
<K, V> Map<K,V>	asMap(Class<K> keyClass, Class<V> valueClass)	Gets value as a map.
String	asString()	Gets value as unbounded string, using default charset(usually UTF-8).
protected static Object[][]	check(List<ClickHouseColumn> columns, Object[][] value)
ClickHouseNestedValue	copy(boolean deep)	Gets a copy of this value object.
boolean	equals(Object obj)
List<ClickHouseColumn>	getColumns()	Gets immutable list of nested columns.
protected Object	getSingleValue()
int	hashCode()
boolean	isNullable()	Checks whether the value is nullable.
boolean	isNullOrEmpty()	Checks if the value is null, or empty for non-null types like Array, Tuple and Map.
static ClickHouseNestedValue	of(ClickHouseValue ref, List<ClickHouseColumn> columns, Object[][] values)	Update value of the given object or create a new instance if ref is null.
static ClickHouseNestedValue	of(List<ClickHouseColumn> columns, Object[][] values)	Wrap the given value.
static ClickHouseNestedValue	ofEmpty(List<ClickHouseColumn> columns)	Creates an empty nested value.
ClickHouseNestedValue	resetToDefault()	Resets to default value of corresponding data type.
ClickHouseNestedValue	resetToNullOrEmpty()	Resets value to null, or empty when null is not supported(e.g.
protected ClickHouseNestedValue	set(Object[][] value)
String	toSqlExpression()	Converts the value to escaped SQL expression.
ClickHouseNestedValue	update(boolean value)	Updates value.
ClickHouseNestedValue	update(boolean[] value)	Updates value.
ClickHouseNestedValue	update(byte value)	Updates value.
ClickHouseNestedValue	update(byte[] value)	Updates value.
ClickHouseNestedValue	update(char value)	Updates value.
ClickHouseNestedValue	update(char[] value)	Updates value.
ClickHouseNestedValue	update(double value)	Updates value.
ClickHouseNestedValue	update(double[] value)	Updates value.
ClickHouseNestedValue	update(float value)	Updates value.
ClickHouseNestedValue	update(float[] value)	Updates value.
ClickHouseNestedValue	update(int value)	Updates value.
ClickHouseNestedValue	update(int[] value)	Updates value.
ClickHouseNestedValue	update(long value)	Updates value.
ClickHouseNestedValue	update(long[] value)	Updates value.
ClickHouseNestedValue	update(short value)	Updates value.
ClickHouseNestedValue	update(short[] value)	Updates value.
ClickHouseNestedValue	update(ClickHouseValue value)	Updates value.
ClickHouseNestedValue	update(Enum<?> value)	Updates value.
ClickHouseNestedValue	update(Object value)	Updates value.
ClickHouseNestedValue	update(Object[] value)	Updates value.
ClickHouseNestedValue	update(String value)	Updates value.
ClickHouseNestedValue	update(BigDecimal value)	Updates value.
ClickHouseNestedValue	update(BigInteger value)	Updates value.
ClickHouseNestedValue	update(Inet4Address value)	Updates value.
ClickHouseNestedValue	update(Inet6Address value)	Updates value.
ClickHouseNestedValue	update(LocalDate value)	Updates value.
ClickHouseNestedValue	update(LocalDateTime value)	Updates value.
ClickHouseNestedValue	update(LocalTime value)	Updates value.
ClickHouseNestedValue	update(Collection<?> value)	Updates value.
ClickHouseNestedValue	update(Enumeration<?> value)	Updates value.
ClickHouseNestedValue	update(Map<?,?> value)	Updates value.
ClickHouseNestedValue	update(UUID value)	Updates value.
ClickHouseValue	updateUnknown(Object value)	Updates value when the type is not supported.

Methods inherited from class com.clickhouse.data.value.ClickHouseObjectValue

asBigDecimal, asBigInteger, asByte, asDouble, asFloat, asInteger, asLong, asObject, asShort, getValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.clickhouse.data.ClickHouseValue

asBigDecimal, asBinary, asBinary, asBinary, asBinary, asBoolean, asByteStream, asCharacter, asCharacterStream, asDate, asDateTime, asDateTime, asEnum, asInet4Address, asInet6Address, asInstant, asInstant, asObject, asOffsetDateTime, asOffsetDateTime, asRawObject, asTime, asTime, asTuple, asUuid, asZonedDateTime, asZonedDateTime, copy, isInfinity, isNaN, newUnsupportedException, update, update, update, update, update

Constructor Details

ClickHouseNestedValue

protected ClickHouseNestedValue(List<ClickHouseColumn> columns,
 Object[][] values)

Method Details

ofEmpty

public static ClickHouseNestedValue ofEmpty(List<ClickHouseColumn> columns)

Creates an empty nested value.

Parameters:

columns - non-null columns

Returns:

empty nested value

of

public static ClickHouseNestedValue of(List<ClickHouseColumn> columns,
 Object[][] values)

Wrap the given value.

Parameters:

columns - columns

values - values

Returns:

object representing the value

of

public static ClickHouseNestedValue of(ClickHouseValue ref,
 List<ClickHouseColumn> columns,
 Object[][] values)

Update value of the given object or create a new instance if ref is null.

Parameters:

ref - object to update, could be null

columns - columns

values - values

Returns:

same object as ref or a new instance if it's null

check

protected static Object[][] check(List<ClickHouseColumn> columns,
 Object[][] value)

getSingleValue

protected Object getSingleValue()

set

protected ClickHouseNestedValue set(Object[][] value)

Overrides:

set in class ClickHouseObjectValue<Object[][]>

getColumns

public List<ClickHouseColumn> getColumns()

Gets immutable list of nested columns.

Returns:

immutable list of columns

copy

public ClickHouseNestedValue copy(boolean deep)

Description copied from interface: ClickHouseValue

Gets a copy of this value object.

Parameters:

deep - true to create a deep copy; false for a shallow copy

Returns:

copy of this value object

asArray

public Object[] asArray()

Description copied from interface: ClickHouseValue

Gets value as an object array.

Returns:

non-null object array

asArray

public <T> T[] asArray(Class<T> clazz)

Description copied from interface: ClickHouseValue

Gets value as an array.

Type Parameters:

T - type of the element

Parameters:

clazz - class of the element

Returns:

non-null array

asMap

public Map<Object,Object> asMap()

Description copied from interface: ClickHouseValue

Gets value as a map.

Returns:

non-null map value

asMap

public <K,
V> Map<K,V> asMap(Class<K> keyClass,
 Class<V> valueClass)

Description copied from interface: ClickHouseValue

Gets value as a map.

Type Parameters:

K - type of key

V - type of value

Parameters:

keyClass - non-null class of key

valueClass - non-null class of value

Returns:

non-null map value

asString

public String asString()

Description copied from interface: ClickHouseValue

Gets value as unbounded string, using default charset(usually UTF-8).

Specified by:

asString in interface ClickHouseValue

Overrides:

asString in class ClickHouseObjectValue<Object[][]>

Returns:

string value, could be null

isNullable

public boolean isNullable()

Description copied from interface: ClickHouseValue

Checks whether the value is nullable. This always returns false for nested value type.

Returns:

true if the value is nullable; false otherwise

isNullOrEmpty

public boolean isNullOrEmpty()

Description copied from interface: ClickHouseValue

Checks if the value is null, or empty for non-null types like Array, Tuple and Map.

Please pay attention that only nullability will be considered for String, meaning this method will return false for an empty string. This is because String is treated as value-based type instead of a container like Array.

Specified by:

isNullOrEmpty in interface ClickHouseValue

Overrides:

isNullOrEmpty in class ClickHouseObjectValue<Object[][]>

Returns:

true if the value is null or empty; false otherwise

resetToDefault

public ClickHouseNestedValue resetToDefault()

Description copied from interface: ClickHouseValue

Resets to default value of corresponding data type.

Returns:

this object

resetToNullOrEmpty

public ClickHouseNestedValue resetToNullOrEmpty()

Description copied from interface: ClickHouseValue

Resets value to null, or empty when null is not supported(e.g. Array, Tuple and Map etc.).

Keep in mind that String is value-based type, so this method will change its value to null instead of an empty string.

Specified by:

resetToNullOrEmpty in interface ClickHouseValue

Overrides:

resetToNullOrEmpty in class ClickHouseObjectValue<Object[][]>

Returns:

this object

toSqlExpression

public String toSqlExpression()

Description copied from interface: ClickHouseValue

Converts the value to escaped SQL expression. For example, number 123 will be converted to 123, while string "12'3" will be converted to @{code '12\'3'}.

Specified by:

toSqlExpression in interface ClickHouseValue

Overrides:

toSqlExpression in class ClickHouseObjectValue<Object[][]>

Returns:

escaped SQL expression

update

public ClickHouseNestedValue update(boolean value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(boolean[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(char value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(char[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(byte value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(byte[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(short value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(short[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(int value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(int[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(long value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(long[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(float value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(float[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(double value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(double[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(BigInteger value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(BigDecimal value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Enum<?> value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Inet4Address value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Inet6Address value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(LocalDate value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(LocalTime value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(LocalDateTime value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Collection<?> value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Enumeration<?> value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Map<?,?> value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(String value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(UUID value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(ClickHouseValue value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Object[] value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

updateUnknown

public ClickHouseValue updateUnknown(Object value)

Description copied from interface: ClickHouseValue

Updates value when the type is not supported. This method will be called at the end of ClickHouseValue.update(Object) after trying all known classes. By default, it's same as update(String.valueOf(value)).

Please avoid to call ClickHouseValue.update(Object) here as it will create endless loop.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseNestedValue update(Object value)

Description copied from interface: ClickHouseValue

Updates value. This method tries to identify type of value and then use corresponding update method to proceed. Unknown value will be passed to ClickHouseValue.updateUnknown(Object).

Specified by:

update in interface ClickHouseValue

Overrides:

update in class ClickHouseObjectValue<Object[][]>

Parameters:

value - value to update, could be null

Returns:

this object

equals

public boolean equals(Object obj)

Overrides:

equals in class ClickHouseObjectValue<Object[][]>

hashCode

public int hashCode()

Overrides:

hashCode in class ClickHouseObjectValue<Object[][]>