Package org.apache.cassandra.db.marshal

Class VectorType<T>

java.lang.Object

org.apache.cassandra.db.marshal.AbstractType<List<T>>

org.apache.cassandra.db.marshal.VectorType<T>

All Implemented Interfaces:

Comparator<ByteBuffer>, AssignmentTestable

public final class VectorType<T>
extends AbstractType<List<T>>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VectorType.VectorSerializer

Nested classes/interfaces inherited from class org.apache.cassandra.db.marshal.AbstractType

AbstractType.ComparisonType, AbstractType.DefaultArgumentDeserializer

Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.AssignmentTestable

AssignmentTestable.TestResult

Field Summary

Fields

Modifier and Type	Field	Description
final int	dimension
final AbstractType<T>	elementType

Fields inherited from class org.apache.cassandra.db.marshal.AbstractType

comparatorSet, comparisonType, isByteOrderComparable, reverseComparator

Method Summary

Modifier and Type	Method	Description
<V> ByteSource	asComparableBytes(ValueAccessor<V> accessor, V value, ByteComparable.Version version)	Produce a byte-comparable representation of the given value, i.e.
CQL3Type	asCQL3Type()
<VL, VR> int	compareCustom(VL left, ValueAccessor<VL> accessorL, VR right, ValueAccessor<VR> accessorR)	Implement IFF ComparisonType is CUSTOM Compares the byte representation of two instances of this class, for types where this cannot be done by simple in-order comparison of the unsigned bytes Standard Java compare semantics
float[]	composeAsFloat(ByteBuffer input)
<V> float[]	composeAsFloat(V input, ValueAccessor<V> accessor)
ByteBuffer	decompose(T... values)
ByteBuffer	decomposeAsFloat(float[] value)
<V> V	decomposeAsFloat(ValueAccessor<V> accessor, float[] value)
ByteBuffer	decomposeRaw(List<ByteBuffer> elements)
<V> V	decomposeRaw(List<V> elements, ValueAccessor<V> accessor)
boolean	equals(Object o)
<V> V	fromComparableBytes(ValueAccessor<V> accessor, ByteSource.Peekable comparableBytes, ByteComparable.Version version)	Translates the given byte-ordered representation to the common, non-byte-ordered binary representation of a payload for this abstract type (the latter, common binary representation is what we mostly work with in the storage engine internals).
Term	fromJSONObject(Object parsed)	Given a parsed JSON string, return a byte representation of the object.
ByteBuffer	fromString(String source)	get a byte representation of the given string.
AbstractType<T>	getElementsType()
static <T> VectorType<T>	getInstance(AbstractType<T> elements, int dimension)
static VectorType<?>	getInstance(TypeParser parser)
ByteBuffer	getMaskedValue()
VectorType<T>.VectorSerializer	getSerializer()
<V> String	getString(V value, ValueAccessor<V> accessor)	get a string representation of the bytes used for various identifier (NOT just for log messages)
int	hashCode()
boolean	isVector()
List<ByteBuffer>	split(ByteBuffer buffer)
<V> List<V>	split(V buffer, ValueAccessor<V> accessor)
List<AbstractType<?>>	subTypes()
String	toJSONString(ByteBuffer buffer, ProtocolVersion protocolVersion)	Converts the specified value into its JSON representation.
<V> String	toJSONString(V value, ValueAccessor<V> accessor, ProtocolVersion protocolVersion)
String	toString()	This must be overriden by subclasses if necessary so that for any AbstractType, this == TypeParser.parse(toString()).
String	toString(boolean ignoreFreezing)
int	valueLengthIfFixed()	The length of values for this type if all values are of fixed length, -1 otherwise.

Methods inherited from class org.apache.cassandra.db.marshal.AbstractType

allowsEmpty, asComparableBytes, asCQLTypeStringList, checkComparable, compare, compare, compareCollectionMembers, compareForCQL, compose, compose, decompose, decomposeUntyped, expandUserTypes, freeze, freezeNestedMulticellTypes, fromComparableBytes, getArgumentDeserializer, getCompatibleTypeIfKnown, getComponents, getString, getString, isCollection, isCompatibleWith, isCounter, isEmptyValueMeaningless, isFreezable, isFrozenCollection, isMultiCell, isNull, isNull, isReversed, isSerializationCompatibleWith, isTuple, isUDT, isValueCompatibleWith, isValueCompatibleWithInternal, isValueLengthFixed, parseDefaultParameters, read, readArray, readBuffer, readBuffer, referencesDuration, referencesUserType, referencesUserType, skipValue, testAssignment, testAssignment, toCQLString, udfType, unfreeze, unwrap, validate, validate, validateCellValue, validateCollectionMember, withUpdatedUserType, writeValue, writeValue, writtenLength, writtenLength

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

elementType

public final AbstractType<T> elementType

dimension

public final int dimension

Method Details

getInstance

public static <T> VectorType<T> getInstance(AbstractType<T> elements,
 int dimension)

getInstance

public static VectorType<?> getInstance(TypeParser parser)

isVector

public boolean isVector()

Overrides:

isVector in class AbstractType<List<T>>

compareCustom

public <VL,
VR> int compareCustom(VL left,
 ValueAccessor<VL> accessorL,
 VR right,
 ValueAccessor<VR> accessorR)

Description copied from class: AbstractType

Implement IFF ComparisonType is CUSTOM Compares the byte representation of two instances of this class, for types where this cannot be done by simple in-order comparison of the unsigned bytes Standard Java compare semantics

Overrides:

compareCustom in class AbstractType<List<T>>

valueLengthIfFixed

public int valueLengthIfFixed()

Description copied from class: AbstractType

The length of values for this type if all values are of fixed length, -1 otherwise. This has an impact on serialization.

see AbstractType.writeValue(java.nio.ByteBuffer, org.apache.cassandra.io.util.DataOutputPlus)

see AbstractType.read(org.apache.cassandra.db.marshal.ValueAccessor<V>, org.apache.cassandra.io.util.DataInputPlus, int)

see AbstractType.writtenLength(java.nio.ByteBuffer)

see AbstractType.skipValue(org.apache.cassandra.io.util.DataInputPlus)

Overrides:

valueLengthIfFixed in class AbstractType<List<T>>

getSerializer

public VectorType<T>.VectorSerializer getSerializer()

Specified by:

getSerializer in class AbstractType<List<T>>

split

public List<ByteBuffer> split(ByteBuffer buffer)

split

public <V> List<V> split(V buffer,
 ValueAccessor<V> accessor)

composeAsFloat

public float[] composeAsFloat(ByteBuffer input)

composeAsFloat

public <V> float[] composeAsFloat(V input,
 ValueAccessor<V> accessor)

decompose

public ByteBuffer decompose(T... values)

decomposeAsFloat

public ByteBuffer decomposeAsFloat(float[] value)

decomposeAsFloat

public <V> V decomposeAsFloat(ValueAccessor<V> accessor,
 float[] value)

decomposeRaw

public ByteBuffer decomposeRaw(List<ByteBuffer> elements)

decomposeRaw

public <V> V decomposeRaw(List<V> elements,
 ValueAccessor<V> accessor)

asComparableBytes

public <V> ByteSource asComparableBytes(ValueAccessor<V> accessor,
 V value,
 ByteComparable.Version version)

Description copied from class: AbstractType

Produce a byte-comparable representation of the given value, i.e. a sequence of bytes that compares the same way using lexicographical unsigned byte comparison as the original value using the type's comparator. We use a slightly stronger requirement to be able to use the types in tuples. Precisely, for any pair x, y of non-equal valid values of this type and any bytes b1, b2 between 0x10 and 0xEF, (+ stands for concatenation) compare(x, y) == compareLexicographicallyUnsigned(asByteComparable(x)+b1, asByteComparable(y)+b2) (i.e. the values compare like the original type, and an added 0x10-0xEF byte at the end does not change that) and: asByteComparable(x)+b1 is not a prefix of asByteComparable(y) (weakly prefix free) (i.e. a valid representation of a value may be a prefix of another valid representation of a value only if the following byte in the latter is smaller than 0x10 or larger than 0xEF). These properties are trivially true if the encoding compares correctly and is prefix free, but also permits a little more freedom that enables somewhat more efficient encoding of arbitrary-length byte-comparable blobs. Depending on the type, this method can be called for null or empty input, in which case the output is allowed to be null (the clustering/tuple encoding will accept and handle it).

Overrides:

asComparableBytes in class AbstractType<List<T>>

fromComparableBytes

public <V> V fromComparableBytes(ValueAccessor<V> accessor,
 ByteSource.Peekable comparableBytes,
 ByteComparable.Version version)

Description copied from class: AbstractType

Translates the given byte-ordered representation to the common, non-byte-ordered binary representation of a payload for this abstract type (the latter, common binary representation is what we mostly work with in the storage engine internals). If the given bytes don't correspond to the encoding of some payload value for this abstract type, an IllegalArgumentException may be thrown.

Overrides:

fromComparableBytes in class AbstractType<List<T>>

Parameters:

accessor - value accessor used to construct the value.

comparableBytes - A byte-ordered representation (presumably of a payload for this abstract type).

version - The byte-comparable version used to construct the representation.

Returns:

A of a payload for this abstract type, corresponding to the given byte-ordered representation, constructed using the supplied value accessor.

See Also:

• AbstractType.asComparableBytes(org.apache.cassandra.db.marshal.ValueAccessor<V>, V, org.apache.cassandra.utils.bytecomparable.ByteComparable.Version)

asCQL3Type

public CQL3Type asCQL3Type()

Overrides:

asCQL3Type in class AbstractType<List<T>>

getElementsType

public AbstractType<T> getElementsType()

getString

public <V> String getString(V value,
 ValueAccessor<V> accessor)

Description copied from class: AbstractType

get a string representation of the bytes used for various identifier (NOT just for log messages)

Overrides:

getString in class AbstractType<List<T>>

fromString

public ByteBuffer fromString(String source)
                      throws MarshalException

Description copied from class: AbstractType

get a byte representation of the given string.

Specified by:

fromString in class AbstractType<List<T>>

Throws:

MarshalException

subTypes

public List<AbstractType<?>> subTypes()

Overrides:

subTypes in class AbstractType<List<T>>

toJSONString

public String toJSONString(ByteBuffer buffer,
 ProtocolVersion protocolVersion)

Description copied from class: AbstractType

Converts the specified value into its JSON representation.

The buffer position will stay the same.

Overrides:

toJSONString in class AbstractType<List<T>>

Parameters:

buffer - the value to convert

protocolVersion - the protocol version to use for the conversion

Returns:

a JSON string representing the specified value

toJSONString

public <V> String toJSONString(V value,
 ValueAccessor<V> accessor,
 ProtocolVersion protocolVersion)

Overrides:

toJSONString in class AbstractType<List<T>>

fromJSONObject

public Term fromJSONObject(Object parsed)
                    throws MarshalException

Description copied from class: AbstractType

Given a parsed JSON string, return a byte representation of the object.

Specified by:

fromJSONObject in class AbstractType<List<T>>

Parameters:

parsed - the result of parsing a json string

Throws:

MarshalException

equals

public boolean equals(Object o)

Specified by:

equals in interface Comparator<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from class: AbstractType

This must be overriden by subclasses if necessary so that for any AbstractType, this == TypeParser.parse(toString()). Note that for backwards compatibility this includes the full classname. For CQL purposes the short name is fine.

Overrides:

toString in class AbstractType<List<T>>

toString

public String toString(boolean ignoreFreezing)

Overrides:

toString in class AbstractType<List<T>>

Parameters:

ignoreFreezing - if true, the type string will not be wrapped with FrozenType(...), even if this type is frozen.

getMaskedValue

public ByteBuffer getMaskedValue()

Overrides:

getMaskedValue in class AbstractType<List<T>>

Returns:

A fixed, serialized value to be used when the column is masked, to be returned instead of the real value.