Package com.clickhouse.data.value

Class ClickHouseArrayValue<T>

java.lang.Object

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

com.clickhouse.data.value.ClickHouseArrayValue<T>

All Implemented Interfaces:

ClickHouseArraySequence, ClickHouseValue, Serializable

public class ClickHouseArrayValue<T>
extends ClickHouseObjectValue<T[]>
implements ClickHouseArraySequence

Wrapper class of Array.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClickHouseArrayValue(T[] value)

Method Summary

Modifier and Type	Method	Description
ClickHouseArraySequence	allocate(int length, Class<?> clazz, int level)	Allocates an array according to given arguments.
Object[]	asArray()	Gets value as an object array.
<E> E[]	asArray(Class<E> clazz)	Gets value as an array.
<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).
ClickHouseArrayValue<T>	copy(boolean deep)	Gets a copy of this value object.
boolean	equals(Object obj)
<V extends ClickHouseValue> V	getValue(int index, V value)	Gets value at the specified position in this array.
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.
int	length()	Gets length of this array.
static <T> ClickHouseArrayValue<T>	of(ClickHouseValue ref, T[] value)	Update value of the given object or create a new instance if ref is null.
static <T> ClickHouseArrayValue<T>	of(T[] value)	Wrap the given value.
static <T> ClickHouseArrayValue<T>	ofEmpty()	Creates an empty array.
static <T> ClickHouseArrayValue<T>	ofEmpty(Class<T> clazz)	Creates an empty array.
ClickHouseArrayValue<T>	resetToDefault()	Resets to default value of corresponding data type.
ClickHouseArrayValue<T>	resetToNullOrEmpty()	Resets value to null, or empty when null is not supported(e.g.
protected ClickHouseArrayValue<T>	set(T[] value)
ClickHouseArraySequence	setValue(int index, ClickHouseValue value)	Sets value to the specified position in this array.
String	toSqlExpression()	Converts the value to escaped SQL expression.
ClickHouseArrayValue<T>	update(boolean[] value)	Updates value.
ClickHouseArrayValue<T>	update(byte value)	Updates value.
ClickHouseArrayValue<T>	update(byte[] value)	Updates value.
ClickHouseArrayValue<T>	update(char[] value)	Updates value.
ClickHouseArrayValue<T>	update(double value)	Updates value.
ClickHouseArrayValue<T>	update(double[] value)	Updates value.
ClickHouseArrayValue<T>	update(float value)	Updates value.
ClickHouseArrayValue<T>	update(float[] value)	Updates value.
ClickHouseArrayValue<T>	update(int value)	Updates value.
ClickHouseArrayValue<T>	update(int[] value)	Updates value.
ClickHouseArrayValue<T>	update(long value)	Updates value.
ClickHouseArrayValue<T>	update(long[] value)	Updates value.
ClickHouseArrayValue<T>	update(short value)	Updates value.
ClickHouseArrayValue<T>	update(short[] value)	Updates value.
ClickHouseArrayValue<T>	update(ClickHouseValue value)	Updates value.
ClickHouseArrayValue<T>	update(Enum<?> value)	Updates value.
ClickHouseArrayValue<T>	update(Object value)	Updates value.
ClickHouseArrayValue<T>	update(Object[] value)	Updates value.
ClickHouseArrayValue<T>	update(String value)	Updates value.
ClickHouseArrayValue<T>	update(BigDecimal value)	Updates value.
ClickHouseArrayValue<T>	update(BigInteger value)	Updates value.
ClickHouseArrayValue<T>	update(Inet4Address value)	Updates value.
ClickHouseArrayValue<T>	update(Inet6Address value)	Updates value.
ClickHouseArrayValue<T>	update(LocalDate value)	Updates value.
ClickHouseArrayValue<T>	update(LocalDateTime value)	Updates value.
ClickHouseArrayValue<T>	update(LocalTime value)	Updates value.
ClickHouseArrayValue<T>	update(Collection<?> value)	Updates value.
ClickHouseArrayValue<T>	update(Enumeration<?> value)	Updates value.
ClickHouseArrayValue<T>	update(Map<?,?> value)	Updates value.
ClickHouseArrayValue<T>	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.ClickHouseArraySequence

allocate, allocate, copy

Methods inherited from interface com.clickhouse.data.ClickHouseValue

asBigDecimal, asBigDecimal, asBigInteger, asBinary, asBinary, asBinary, asBinary, asBoolean, asByte, asByteStream, asCharacter, asCharacterStream, asDate, asDateTime, asDateTime, asDouble, asEnum, asFloat, asInet4Address, asInet6Address, asInstant, asInstant, asInteger, asLong, asMap, asObject, asObject, asOffsetDateTime, asOffsetDateTime, asRawObject, asShort, asTime, asTime, asTuple, asUuid, asZonedDateTime, asZonedDateTime, isInfinity, isNaN, newUnsupportedException, update, update, update, update, update, update, update

Constructor Details

ClickHouseArrayValue

protected ClickHouseArrayValue(T[] value)

Method Details

ofEmpty

public static <T> ClickHouseArrayValue<T> ofEmpty()

Creates an empty array.

Type Parameters:

T - type of the array

Returns:

empty array

ofEmpty

public static <T> ClickHouseArrayValue<T> ofEmpty(Class<T> clazz)

Creates an empty array.

Type Parameters:

T - type of the array

Parameters:

clazz - non-null component class

Returns:

empty array

of

public static <T> ClickHouseArrayValue<T> of(T[] value)

Wrap the given value.

Type Parameters:

T - type of element

Parameters:

value - value

Returns:

object representing the value

of

public static <T> ClickHouseArrayValue<T> of(ClickHouseValue ref,
 T[] value)

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

Type Parameters:

T - type of element

Parameters:

ref - object to update, could be null

value - value

Returns:

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

set

protected ClickHouseArrayValue<T> set(T[] value)

Overrides:

set in class ClickHouseObjectValue<T[]>

asArray

public Object[] asArray()

Description copied from interface: ClickHouseValue

Gets value as an object array.

Specified by:

asArray in interface ClickHouseValue

Returns:

non-null object array

asArray

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

Description copied from interface: ClickHouseValue

Gets value as an array.

Specified by:

asArray in interface ClickHouseValue

Type Parameters:

E - type of the element

Parameters:

clazz - class of the element

Returns:

non-null array

asMap

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

Description copied from interface: ClickHouseValue

Gets value as a map.

Specified by:

asMap in interface ClickHouseValue

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<T[]>

Returns:

string value, could be null

copy

public ClickHouseArrayValue<T> copy(boolean deep)

Description copied from interface: ClickHouseValue

Gets a copy of this value object.

Specified by:

copy in interface ClickHouseArraySequence

Specified by:

copy in interface ClickHouseValue

Parameters:

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

Returns:

copy of this value object

isNullable

public boolean isNullable()

Description copied from interface: ClickHouseValue

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

Specified by:

isNullable in interface ClickHouseValue

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<T[]>

Returns:

true if the value is null or empty; false otherwise

resetToDefault

public ClickHouseArrayValue<T> resetToDefault()

Description copied from interface: ClickHouseValue

Resets to default value of corresponding data type.

Specified by:

resetToDefault in interface ClickHouseValue

Returns:

this object

resetToNullOrEmpty

public ClickHouseArrayValue<T> 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<T[]>

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<T[]>

Returns:

escaped SQL expression

update

public ClickHouseArrayValue<T> update(boolean[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(char[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(byte value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(byte[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(short value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(short[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(int value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(int[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(long value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(long[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(float value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(float[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(double value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(double[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(BigInteger value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(BigDecimal value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(Enum<?> value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(Inet4Address value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(Inet6Address value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(LocalDate value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(LocalTime value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(LocalDateTime value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(Collection<?> value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(Enumeration<?> value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(Map<?,?> value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(String value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(UUID value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(ClickHouseValue value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> update(Object[] value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

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.

Specified by:

updateUnknown in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseArrayValue<T> 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<T[]>

Parameters:

value - value to update, could be null

Returns:

this object

equals

public boolean equals(Object obj)

Overrides:

equals in class ClickHouseObjectValue<T[]>

hashCode

public int hashCode()

Overrides:

hashCode in class ClickHouseObjectValue<T[]>

allocate

public ClickHouseArraySequence allocate(int length,
 Class<?> clazz,
 int level)

Description copied from interface: ClickHouseArraySequence

Allocates an array according to given arguments. Pay attention that this will will not create new array but reuse existing one, when length are clazz not changed.

Specified by:

allocate in interface ClickHouseArraySequence

Parameters:

length - length of the array

clazz - optional value type, null means Object.class

level - level of the array, zero or negative number is treated as 1

Returns:

this value

length

public int length()

Description copied from interface: ClickHouseArraySequence

Gets length of this array.

Specified by:

length in interface ClickHouseArraySequence

Returns:

length of this array

getValue

public <V extends ClickHouseValue> V getValue(int index,
 V value)

Description copied from interface: ClickHouseArraySequence

Gets value at the specified position in this array.

Specified by:

getValue in interface ClickHouseArraySequence

Type Parameters:

V - type of the value

Parameters:

index - index which is greater than or equal to zero and it's always smaller than ClickHouseArraySequence.length()

value - non-null template object to retrieve the value

Returns:

non-null value which is same as value

setValue

public ClickHouseArraySequence setValue(int index,
 ClickHouseValue value)

Description copied from interface: ClickHouseArraySequence

Sets value to the specified position in this array.

Specified by:

setValue in interface ClickHouseArraySequence

Parameters:

index - index which is greater than or equal to zero and it's always smaller than ClickHouseArraySequence.length()

value - non-null container of the value

Returns:

this value