org.apache.datasketches.tuple.strings

Class ArrayOfStringsSummary

java.lang.Object

org.apache.datasketches.tuple.strings.ArrayOfStringsSummary

All Implemented Interfaces:

Summary, UpdatableSummary<String[]>

public class ArrayOfStringsSummary
extends Object
implements UpdatableSummary<String[]>

Author:

Lee Rhodes

Method Summary

Modifier and Type	Method and Description
ArrayOfStringsSummary	copy() Deep copy.
boolean	equals(Object summary)
static DeserializeResult<ArrayOfStringsSummary>	fromMemory(org.apache.datasketches.memory.Memory mem)
String[]	getValue()
int	hashCode()
static long	stringHash(String s)
byte[]	toByteArray() This is to serialize a Summary instance to a byte array.
void	update(String[] value) This is to provide a method of updating summaries.

Methods inherited from class java.lang.Object

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

Method Detail

copy

public ArrayOfStringsSummary copy()

Description copied from interface: Summary

Deep copy.

Caution: This must implement a deep copy.

Specified by:

copy in interface Summary

Returns:

deep copy of the Summary

getValue

public String[] getValue()

Returns:

the nodes array for this summary.

toByteArray

public byte[] toByteArray()

Description copied from interface: Summary

This is to serialize a Summary instance to a byte array.

The user should encode in the byte array its total size, which is used during deserialization, especially if the Summary has variable sized elements.

Specified by:

toByteArray in interface Summary

Returns:

serialized representation of the Summary

fromMemory

public static DeserializeResult<ArrayOfStringsSummary> fromMemory(org.apache.datasketches.memory.Memory mem)

Parameters:

mem - the given memory

Returns:

the DeserializeResult

update

public void update(String[] value)

Description copied from interface: UpdatableSummary

This is to provide a method of updating summaries. This should not be called by the user.

Specified by:

update in interface UpdatableSummary<String[]>

Parameters:

value - update value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object summary)

Overrides:

equals in class Object

stringHash

public static long stringHash(String s)

Parameters:

s - the string to hash

Returns:

the hash of the string