org.apache.cassandra.db.marshal.TupleType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-unit-shaded Show documentation
Show all versions of cassandra-unit-shaded Show documentation
Shaded version of cassandra-unit
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.cassandra.db.marshal;
import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import com.google.common.base.Objects;
import org.apache.cassandra.cql3.*;
import org.apache.cassandra.exceptions.ConfigurationException;
import org.apache.cassandra.exceptions.InvalidRequestException;
import org.apache.cassandra.exceptions.SyntaxException;
import org.apache.cassandra.serializers.*;
import org.apache.cassandra.transport.ProtocolVersion;
import org.apache.cassandra.utils.ByteBufferUtil;
/**
* This is essentially like a CompositeType, but it's not primarily meant for comparison, just
* to pack multiple values together so has a more friendly encoding.
*/
public class TupleType extends AbstractType
{
private static final String COLON = ":";
private static final Pattern COLON_PAT = Pattern.compile(COLON);
private static final String ESCAPED_COLON = "\\\\:";
private static final Pattern ESCAPED_COLON_PAT = Pattern.compile(ESCAPED_COLON);
private static final String AT = "@";
private static final Pattern AT_PAT = Pattern.compile(AT);
private static final String ESCAPED_AT = "\\\\@";
private static final Pattern ESCAPED_AT_PAT = Pattern.compile(ESCAPED_AT);
protected final List> types;
public TupleType(List> types)
{
this(types, true);
}
protected TupleType(List> types, boolean freezeInner)
{
super(ComparisonType.CUSTOM);
if (freezeInner)
this.types = types.stream().map(AbstractType::freeze).collect(Collectors.toList());
else
this.types = types;
}
public static TupleType getInstance(TypeParser parser) throws ConfigurationException, SyntaxException
{
List> types = parser.getTypeParameters();
for (int i = 0; i < types.size(); i++)
types.set(i, types.get(i).freeze());
return new TupleType(types);
}
@Override
public boolean referencesUserType(String name)
{
return allTypes().stream().anyMatch(f -> f.referencesUserType(name));
}
@Override
public boolean referencesDuration()
{
return allTypes().stream().anyMatch(f -> f.referencesDuration());
}
public AbstractType type(int i)
{
return types.get(i);
}
public int size()
{
return types.size();
}
public List> allTypes()
{
return types;
}
public int compareCustom(ByteBuffer o1, ByteBuffer o2)
{
if (!o1.hasRemaining() || !o2.hasRemaining())
return o1.hasRemaining() ? 1 : o2.hasRemaining() ? -1 : 0;
ByteBuffer bb1 = o1.duplicate();
ByteBuffer bb2 = o2.duplicate();
for (int i = 0; bb1.remaining() > 0 && bb2.remaining() > 0; i++)
{
AbstractType comparator = types.get(i);
int size1 = bb1.getInt();
int size2 = bb2.getInt();
// Handle nulls
if (size1 < 0)
{
if (size2 < 0)
continue;
return -1;
}
if (size2 < 0)
return 1;
ByteBuffer value1 = ByteBufferUtil.readBytes(bb1, size1);
ByteBuffer value2 = ByteBufferUtil.readBytes(bb2, size2);
int cmp = comparator.compare(value1, value2);
if (cmp != 0)
return cmp;
}
// handle trailing nulls
while (bb1.remaining() > 0)
{
int size = bb1.getInt();
if (size > 0) // non-null
return 1;
}
while (bb2.remaining() > 0)
{
int size = bb2.getInt();
if (size > 0) // non-null
return -1;
}
return 0;
}
@Override
public void validate(ByteBuffer bytes) throws MarshalException
{
ByteBuffer input = bytes.duplicate();
for (int i = 0; i < size(); i++)
{
// we allow the input to have less fields than declared so as to support field addition.
if (!input.hasRemaining())
return;
if (input.remaining() < Integer.BYTES)
throw new MarshalException(String.format("Not enough bytes to read size of %dth component", i));
int size = input.getInt();
// size < 0 means null value
if (size < 0)
continue;
if (input.remaining() < size)
throw new MarshalException(String.format("Not enough bytes to read %dth component", i));
ByteBuffer field = ByteBufferUtil.readBytes(input, size);
types.get(i).validate(field);
}
// We're allowed to get less fields than declared, but not more
if (input.hasRemaining())
throw new MarshalException("Invalid remaining data after end of tuple value");
}
/**
* Split a tuple value into its component values.
*/
public ByteBuffer[] split(ByteBuffer value)
{
ByteBuffer[] components = new ByteBuffer[size()];
ByteBuffer input = value.duplicate();
for (int i = 0; i < size(); i++)
{
if (!input.hasRemaining())
return Arrays.copyOfRange(components, 0, i);
int size = input.getInt();
if (input.remaining() < size)
throw new MarshalException(String.format("Not enough bytes to read %dth component", i));
// size < 0 means null value
components[i] = size < 0 ? null : ByteBufferUtil.readBytes(input, size);
}
// error out if we got more values in the tuple/UDT than we expected
if (input.hasRemaining())
{
throw new InvalidRequestException(String.format(
"Expected %s %s for %s column, but got more",
size(), size() == 1 ? "value" : "values", this.asCQL3Type()));
}
return components;
}
public static ByteBuffer buildValue(ByteBuffer[] components)
{
int totalLength = 0;
for (ByteBuffer component : components)
totalLength += 4 + (component == null ? 0 : component.remaining());
ByteBuffer result = ByteBuffer.allocate(totalLength);
for (ByteBuffer component : components)
{
if (component == null)
{
result.putInt(-1);
}
else
{
result.putInt(component.remaining());
result.put(component.duplicate());
}
}
result.rewind();
return result;
}
@Override
public String getString(ByteBuffer value)
{
if (value == null)
return "null";
StringBuilder sb = new StringBuilder();
ByteBuffer input = value.duplicate();
for (int i = 0; i < size(); i++)
{
if (!input.hasRemaining())
return sb.toString();
if (i > 0)
sb.append(":");
AbstractType type = type(i);
int size = input.getInt();
if (size < 0)
{
sb.append("@");
continue;
}
ByteBuffer field = ByteBufferUtil.readBytes(input, size);
// We use ':' as delimiter, and @ to represent null, so escape them in the generated string
String fld = COLON_PAT.matcher(type.getString(field)).replaceAll(ESCAPED_COLON);
fld = AT_PAT.matcher(fld).replaceAll(ESCAPED_AT);
sb.append(fld);
}
return sb.toString();
}
public ByteBuffer fromString(String source)
{
// Split the input on non-escaped ':' characters
List fieldStrings = AbstractCompositeType.split(source);
if (fieldStrings.size() > size())
throw new MarshalException(String.format("Invalid tuple literal: too many elements. Type %s expects %d but got %d",
asCQL3Type(), size(), fieldStrings.size()));
ByteBuffer[] fields = new ByteBuffer[fieldStrings.size()];
for (int i = 0; i < fieldStrings.size(); i++)
{
String fieldString = fieldStrings.get(i);
// We use @ to represent nulls
if (fieldString.equals("@"))
continue;
AbstractType type = type(i);
fieldString = ESCAPED_COLON_PAT.matcher(fieldString).replaceAll(COLON);
fieldString = ESCAPED_AT_PAT.matcher(fieldString).replaceAll(AT);
fields[i] = type.fromString(fieldString);
}
return buildValue(fields);
}
@Override
public Term fromJSONObject(Object parsed) throws MarshalException
{
if (parsed instanceof String)
parsed = Json.decodeJson((String) parsed);
if (!(parsed instanceof List))
throw new MarshalException(String.format(
"Expected a list representation of a tuple, but got a %s: %s", parsed.getClass().getSimpleName(), parsed));
List list = (List) parsed;
if (list.size() > types.size())
throw new MarshalException(String.format("Tuple contains extra items (expected %s): %s", types.size(), parsed));
else if (types.size() > list.size())
throw new MarshalException(String.format("Tuple is missing items (expected %s): %s", types.size(), parsed));
List terms = new ArrayList<>(list.size());
Iterator> typeIterator = types.iterator();
for (Object element : list)
{
if (element == null)
{
typeIterator.next();
terms.add(Constants.NULL_VALUE);
}
else
{
terms.add(typeIterator.next().fromJSONObject(element));
}
}
return new Tuples.DelayedValue(this, terms);
}
@Override
public String toJSONString(ByteBuffer buffer, ProtocolVersion protocolVersion)
{
StringBuilder sb = new StringBuilder("[");
for (int i = 0; i < types.size(); i++)
{
if (i > 0)
sb.append(", ");
ByteBuffer value = CollectionSerializer.readValue(buffer, protocolVersion);
if (value == null)
sb.append("null");
else
sb.append(types.get(i).toJSONString(value, protocolVersion));
}
return sb.append("]").toString();
}
public TypeSerializer getSerializer()
{
return BytesSerializer.instance;
}
@Override
public boolean isCompatibleWith(AbstractType previous)
{
if (!(previous instanceof TupleType))
return false;
// Extending with new components is fine, removing is not
TupleType tt = (TupleType)previous;
if (size() < tt.size())
return false;
for (int i = 0; i < tt.size(); i++)
{
AbstractType tprev = tt.type(i);
AbstractType tnew = type(i);
if (!tnew.isCompatibleWith(tprev))
return false;
}
return true;
}
@Override
public boolean isValueCompatibleWithInternal(AbstractType otherType)
{
if (!(otherType instanceof TupleType))
return false;
// Extending with new components is fine, removing is not
TupleType tt = (TupleType) otherType;
if (size() < tt.size())
return false;
for (int i = 0; i < tt.size(); i++)
{
AbstractType tprev = tt.type(i);
AbstractType tnew = type(i);
if (!tnew.isValueCompatibleWith(tprev))
return false;
}
return true;
}
@Override
public int hashCode()
{
return Objects.hashCode(types);
}
@Override
public boolean equals(Object o)
{
if(!(o instanceof TupleType))
return false;
TupleType that = (TupleType)o;
return types.equals(that.types);
}
@Override
public boolean isTuple()
{
return true;
}
@Override
public CQL3Type asCQL3Type()
{
return CQL3Type.Tuple.create(this);
}
@Override
public String toString()
{
return getClass().getName() + TypeParser.stringifyTypeParameters(types, true);
}
}