From 06f4a585e84cbdb6c00571d6249c0bc34756efdd Mon Sep 17 00:00:00 2001 From: Nick Dimiduk Date: Tue, 30 Jul 2013 17:12:53 -0700 Subject: [PATCH] HBASE-8693 Extensible data types API This patch introduces an extensible data types API for HBase. It is inspired by the following systems: - PostgreSQL. Postgres has a user-extensible data type API, which has been used to great effect by it's user community (ie, PostGIS). The desire is for HBase to expose an equally extensible data type API. One aspect of the Postgres data type is the ability to provide equivalence functions for index operations. This appears to be of critical performance utility for its execution engine. - Orderly. Orderly handles the issue of compound rowkeys by providing convenience classes for handling these kinds of data types. This influence is reflected in the Struct and Union family of classes. - Phoenix. The PDataType enum used in Phoenix provides type hints, similar Postgres's equivalence functions. These appear to be used during query execution for numerical type promotion. This patch introduces an interface, DataType, along with a number of data type implementations based on the Bytes encoding. Also included are Struct and Union types, demonstrating simple implementations of compound types. Helper classes around the Struct implementation are also provided. This patch does not address the type compatibility concerns expressed by Phoenix's PDataType API (ie, isComparableTo, isCoercibleTo); these will be addressed in HBASE-8863. HBASE-8693 Extensible data types API This patch introduces an extensible data types API for HBase. It is inspired by the following systems: - PostgreSQL. Postgres has a user-extensible data type API, which has been used to great effect by it's user community (ie, PostGIS). The desire is for HBase to expose an equally extensible data type API. One aspect of the Postgres data type is the ability to provide equivalence functions for index operations. This appears to be of critical performance utility for its execution engine. - Orderly. Orderly handles the issue of compound rowkeys by providing convenience classes for handling these kinds of data types. This influence is reflected in the Struct and Union family of classes. - Phoenix. The PDataType enum used in Phoenix provides type hints, similar Postgres's equivalence functions. These appear to be used during query execution for numerical type promotion. This patch introduces an interface, DataType, along with a number of data type implementations based on the Bytes encoding. Also included are Struct and Union types, demonstrating simple implementations of compound types. Helper classes around the Struct implementation are also provided. This patch does not address the type compatibility concerns expressed by Phoenix's PDataType API (ie, isComparableTo, isCoercibleTo); these will be addressed in HBASE-8863. --- .../org/apache/hadoop/hbase/types/DataType.java | 107 +++++++ .../hadoop/hbase/types/FixedLengthWrapper.java | 104 ++++++ .../org/apache/hadoop/hbase/types/LegacyBytes.java | 102 ++++++ .../hadoop/hbase/types/LegacyBytesFixedLength.java | 67 ++++ .../hadoop/hbase/types/LegacyBytesTerminated.java | 86 +++++ .../apache/hadoop/hbase/types/LegacyDouble.java | 88 +++++ .../org/apache/hadoop/hbase/types/LegacyFloat.java | 88 +++++ .../apache/hadoop/hbase/types/LegacyInteger.java | 88 +++++ .../org/apache/hadoop/hbase/types/LegacyLong.java | 88 +++++ .../apache/hadoop/hbase/types/LegacyString.java | 101 ++++++ .../hbase/types/LegacyStringFixedLength.java | 68 ++++ .../hadoop/hbase/types/LegacyStringTerminated.java | 88 +++++ .../java/org/apache/hadoop/hbase/types/Order.java | 73 +++++ .../java/org/apache/hadoop/hbase/types/Struct.java | 166 ++++++++++ .../apache/hadoop/hbase/types/StructBuilder.java | 54 ++++ .../apache/hadoop/hbase/types/StructIterator.java | 88 +++++ .../hadoop/hbase/types/TerminatedWrapper.java | 153 +++++++++ .../java/org/apache/hadoop/hbase/types/Union2.java | 85 +++++ .../java/org/apache/hadoop/hbase/types/Union3.java | 70 ++++ .../java/org/apache/hadoop/hbase/types/Union4.java | 69 ++++ .../hadoop/hbase/types/TestFixedLengthWrapper.java | 87 +++++ .../org/apache/hadoop/hbase/types/TestStruct.java | 355 +++++++++++++++++++++ .../hadoop/hbase/types/TestTerminatedWrapper.java | 101 ++++++ .../org/apache/hadoop/hbase/types/TestUnion2.java | 155 +++++++++ 24 files changed, 2531 insertions(+) create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/DataType.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/FixedLengthWrapper.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytes.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesFixedLength.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesTerminated.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyDouble.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyFloat.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyInteger.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyLong.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyString.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringFixedLength.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringTerminated.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/Order.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/Struct.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructBuilder.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructIterator.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/TerminatedWrapper.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union2.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union3.java create mode 100644 hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union4.java create mode 100644 hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestFixedLengthWrapper.java create mode 100644 hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestStruct.java create mode 100644 hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestTerminatedWrapper.java create mode 100644 hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestUnion2.java diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/DataType.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/DataType.java new file mode 100644 index 0000000..b9a7a67 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/DataType.java @@ -0,0 +1,107 @@ +/** + * 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.hadoop.hbase.types; + +import java.nio.ByteBuffer; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; + +/** + * HDataType is the base class for all HBase data types. Data + * type implementations are designed to be serialized to and deserialized from + * {@link ByteBuffer}s. Serialized representations can retain the natural sort + * ordering of the source object, when a suitable encoding is supported by the + * underlying implementation. This is a desirable feature for use in rowkeys + * and column qualifiers. + *

+ * Data type instances are designed to be stateless, thread-safe, and reused. + * Implementations should provide static final instances + * corresponding to each variation on configurable parameters. For instance, + * order-preserving types should provide static ASCENDING and DESCENDING + * instances. It is also encouraged for implementations operating on Java + * primitive types to provide primitive implementations of the + * read and write methods. This advice is a + * performance consideration to clients reading and writing values in tight + * loops. + *

+ */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public interface DataType { + + /** + * Indicates whether this instance writes encoded byte[]'s + * which preserve the natural sort order of the unencoded value. + * @return true when natural order is preserved, + * false otherwise. + */ + public boolean isOrderPreserving(); + + /** + * Retrieve the sort {@link Order} honored by this data type, or + * null when natural ordering is not preserved. + */ + public Order getOrder(); + + /** + * Indicates whether this instance supports encoding null + * values. This depends on the implementation details of the encoding + * format. All HDataTypes that support null should + * treat null as comparing less than any non-NULL + * value for default sort ordering purposes. + * @return true when null is supported, + * false otherwise. + */ + public boolean isNullable(); + + /** + * Indicates whether this instance is able to skip over it's encoded value + * in a ByteBuffer. HDataTypes that are not + * skippable can only be used as the right-most field of a {@link Struct}. + * @return + */ + public boolean isSkippable(); + + /** + * Inform consumers how long the encoded byte[] will be. + */ + public int encodedLength(T val); + + /** + * Inform consumers over what type this HDataType operates. + * @return + */ + public Class encodedClass(); + + /** + * Skip the position of buff over the encoded value. + */ + public void skip(ByteRange buff); + + /** + * Read an instance of T from the buffer buff. + */ + public T decode(ByteRange buff); + + /** + * Write instance val into buffer buff. + */ + public void encode(ByteRange buff, T val); +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/FixedLengthWrapper.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/FixedLengthWrapper.java new file mode 100644 index 0000000..29aa745 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/FixedLengthWrapper.java @@ -0,0 +1,104 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; + +/** + * Wraps an existing HDataType implementation as a fixed-length + * version of itself. This has the useful side-effect of turning an existing + * HDataType which is not skippable into a + * skippable variant. + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class FixedLengthWrapper implements DataType { + + protected final DataType wrapped; + protected final int length; + + /** + * Create a fixed-length version of the wrapped. + */ + public FixedLengthWrapper(DataType wrapped, int length) { + this.wrapped = wrapped; + this.length = length; + } + + @Override + public boolean isOrderPreserving() { return wrapped.isOrderPreserving(); } + + @Override + public Order getOrder() { return wrapped.getOrder(); } + + @Override + public boolean isNullable() { return wrapped.isNullable(); } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(T val) { return length; } + + @Override + public Class encodedClass() { return wrapped.encodedClass(); } + + @Override + public void skip(ByteRange buff) { buff.setPosition(buff.getPosition() + length); } + + /** + * Read an instance of T from the buffer buff. + * @throws IllegalArgumentException when buff lacks sufficient + * remaining capacity. In the event this exception is thrown, + * buff#position() is restored to the original value. + */ + @Override + public T decode(ByteRange buff) { + if (buff.getRemaining() < length) + throw new IllegalArgumentException("Not enough buffer remaining."); + // create a copy range limited to length bytes passed position. + ByteRange b = buff.shallowCopy(); + b.setPosition(buff.getPosition()); + b.setLength(b.getPosition() + length); + T ret = wrapped.decode(b); + buff.setPosition(buff.getPosition() + length); + return ret; + } + + /** + * Write instance val into buffer buff. Any space + * remaining after val is written is zero-padded up to + * length. + * @throws IllegalArgumentException when buff lacks sufficient + * remaining capacity. In the event this exception is thrown, + * buff#position() is restored the original value. + */ + @Override + public void encode(ByteRange buff, T val) { + if (buff.getRemaining() < length) + throw new IllegalArgumentException("Not enough buffer remaining."); + ByteRange b = buff.shallowCopy(); + b.setPosition(buff.getPosition()); + b.setLength(b.getPosition() + length); + wrapped.encode(b, val); + while (b.getPosition() != b.getLength()) b.put((byte) 0x00); + buff.setPosition(buff.getPosition() + length); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytes.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytes.java new file mode 100644 index 0000000..b7c9dce --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytes.java @@ -0,0 +1,102 @@ +/** + * 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.hadoop.hbase.types; + +import java.nio.ByteBuffer; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An HDataType for interacting with variable-length values + * encoded using {@link Bytes#putBytes(byte[], int, byte[], int, int)}. + * Intended to make it easier to transition away from direct use of + * {@link Bytes}. + * @see Bytes#putBytes(byte[], int, byte[], int, int) + * @see LegacyBytesTerminated + * @see OrderedBlob + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyBytes implements DataType { + + public static final LegacyBytes ASCENDING = new LegacyBytes(Order.ASCENDING); + public static final LegacyBytes DESCENDING = new LegacyBytes(Order.DESCENDING); + + protected final Order order; + + protected LegacyBytes() { this.order = Order.ASCENDING; } + protected LegacyBytes(Order order) { this.order = order; } + + @Override + public boolean isOrderPreserving() { return true; } + + @Override + public Order getOrder() { return order; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return false; } + + @Override + public void skip(ByteRange buff) { buff.setPosition(buff.getLength()); } + + @Override + public int encodedLength(byte[] val) { return val.length; } + + @Override + public Class encodedClass() { return byte[].class; } + + /** + * Skip buff ahead length bytes. + */ + public void skip(ByteBuffer buff, int length) { + buff.position(buff.position() + length); + } + + @Override + public byte[] decode(ByteRange buff) { + return decode(buff, buff.getRemaining()); + } + + @Override + public void encode(ByteRange buff, byte[] val) { + buff.put(val); + } + + /** + * Read a byte[] from the buffer buff. + */ + public byte[] decode(ByteRange buff, int length) { + byte[] val = new byte[length]; + buff.get(val); + return val; + } + + /** + * Write val into buff, respecting + * offset and length. + */ + public void encode(ByteRange buff, byte[] val, int offset, int length) { + buff.put(val, offset, length); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesFixedLength.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesFixedLength.java new file mode 100644 index 0000000..1853f82 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesFixedLength.java @@ -0,0 +1,67 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An HDataType that encodes fixed-length values encoded using + * {@link Bytes#putBytes(byte[], int, byte[], int, int)}. Intended to make it + * easier to transition away from direct use of {@link Bytes}. + * @see Bytes#putBytes(byte[], int, byte[], int, int) + * @see LegacyBytes + * @see OrderedBlob + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyBytesFixedLength extends FixedLengthWrapper { + + /** + * Create a LegacyBytesFixedLength using the specified + * order and length. + */ + public LegacyBytesFixedLength(Order order, int length) { + super(new LegacyBytes(order), length); + } + + /** + * Create a LegacyBytesFixedLength of the specified + * length>. + */ + public LegacyBytesFixedLength(int length) { + super(new LegacyBytes(), length); + } + + /** + * Read a byte[] from the buffer buff. + */ + public byte[] decode(ByteRange buff, int length) { + return ((LegacyBytes) wrapped).decode(buff, length); + } + + /** + * Write val into buff, respecting + * offset and length. + */ + public void encode(ByteRange buff, byte[] val, int offset, int length) { + ((LegacyBytes) wrapped).encode(buff, val, offset, length); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesTerminated.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesTerminated.java new file mode 100644 index 0000000..3baafcc --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyBytesTerminated.java @@ -0,0 +1,86 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An HDataType that encodes variable-length values encoded using + * {@link Bytes#putBytes(byte[], int, byte[], int, int)}. Includes a + * termination marker following the raw byte[] value. Intended to + * make it easier to transition away from direct use of {@link Bytes}. + * @see Bytes#putBytes(byte[], int, byte[], int, int) + * @see LegacyBytes + * @see OrderedBlob + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyBytesTerminated extends TerminatedWrapper { + + /** + * Create a LegacyBytesTerminated using the specified terminator and + * order. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyBytesTerminated(Order order, byte[] term) { + super(new LegacyBytes(order), term); + } + + /** + * Create a LegacyBytesTerminated using the specified terminator and + * order. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyBytesTerminated(Order order, String term) { + super(new LegacyBytes(order), term); + } + + /** + * Create a LegacyBytesTerminated using the specified terminator. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyBytesTerminated(byte[] term) { + super(new LegacyBytes(), term); + } + + /** + * Create a LegacyBytesTerminated using the specified terminator. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyBytesTerminated(String term) { + super(new LegacyBytes(), term); + } + + /** + * Read a byte[] from the buffer buff. + */ + public byte[] decode(ByteRange buff, int length) { + return ((LegacyBytes) wrapped).decode(buff, length); + } + + /** + * Write val into buff, respecting + * offset and length. + */ + public void encode(ByteRange buff, byte[] val, int offset, int length) { + ((LegacyBytes) wrapped).encode(buff, val, offset, length); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyDouble.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyDouble.java new file mode 100644 index 0000000..a05a9eb --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyDouble.java @@ -0,0 +1,88 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An DataType for interacting with values encoded using + * {@link Bytes#putDouble(byte[], int, double)}. Intended to make it easier to + * transition away from direct use of {@link Bytes}. + * @see Bytes#putDouble(byte[], int, double) + * @see Bytes#toDouble(byte[]) + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyDouble implements DataType { + + @Override + public boolean isOrderPreserving() { return false; } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(Double val) { return Bytes.SIZEOF_DOUBLE; } + + @Override + public Class encodedClass() { return Double.class; } + + @Override + public void skip(ByteRange buff) { + buff.setPosition(buff.getPosition() + Bytes.SIZEOF_DOUBLE); + } + + @Override + public Double decode(ByteRange buff) { + double val = Bytes.toDouble(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + @Override + public void encode(ByteRange buff, Double val) { + Bytes.putDouble(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } + + /** + * Read a double value from the buffer buff. + */ + public double decodeDouble(ByteRange buff) { + double val = Bytes.toDouble(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + /** + * Write instance val into buffer buff. + */ + public void encodeDouble(ByteRange buff, double val) { + Bytes.putDouble(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyFloat.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyFloat.java new file mode 100644 index 0000000..7523336 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyFloat.java @@ -0,0 +1,88 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An DataType for interacting with values encoded using + * {@link Bytes#putFloat(byte[], int, float)}. Intended to make it easier to + * transition away from direct use of {@link Bytes}. + * @see Bytes#putFloat(byte[], int, float) + * @see Bytes#toFloat(byte[]) + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyFloat implements DataType { + + @Override + public boolean isOrderPreserving() { return false; } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(Float val) { return Bytes.SIZEOF_FLOAT; } + + @Override + public Class encodedClass() { return Float.class; } + + @Override + public void skip(ByteRange buff) { + buff.setPosition(buff.getPosition() + Bytes.SIZEOF_FLOAT); + } + + @Override + public Float decode(ByteRange buff) { + float val = Bytes.toFloat(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + @Override + public void encode(ByteRange buff, Float val) { + Bytes.putFloat(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } + + /** + * Read a float value from the buffer buff. + */ + public float decodeFloat(ByteRange buff) { + float val = Bytes.toFloat(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + /** + * Write instance val into buffer buff. + */ + public void encodeFloat(ByteRange buff, float val) { + Bytes.putFloat(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyInteger.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyInteger.java new file mode 100644 index 0000000..40913fb --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyInteger.java @@ -0,0 +1,88 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An DataType for interacting with values encoded using + * {@link Bytes#putInt(byte[], int, int)}. Intended to make it easier to + * transition away from direct use of {@link Bytes}. + * @see Bytes#putInt(byte[], int, int) + * @see Bytes#toInt(byte[]) + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyInteger implements DataType { + + @Override + public boolean isOrderPreserving() { return false; } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(Integer val) { return Bytes.SIZEOF_INT; } + + @Override + public Class encodedClass() { return Integer.class; } + + @Override + public void skip(ByteRange buff) { + buff.setPosition(buff.getPosition() + Bytes.SIZEOF_INT); + } + + @Override + public Integer decode(ByteRange buff) { + int val = Bytes.toInt(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + @Override + public void encode(ByteRange buff, Integer val) { + Bytes.putInt(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } + + /** + * Read an int value from the buffer buff. + */ + public int decodeInt(ByteRange buff) { + int val = Bytes.toInt(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + /** + * Write instance val into buffer buff. + */ + public void encodeInt(ByteRange buff, int val) { + Bytes.putInt(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyLong.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyLong.java new file mode 100644 index 0000000..f29501d --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyLong.java @@ -0,0 +1,88 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An DataType for interacting with values encoded using + * {@link Bytes#putLong(byte[], int, long)}. Intended to make it easier to + * transition away from direct use of {@link Bytes}. + * @see Bytes#putLong(byte[], int, long) + * @see Bytes#toLong(byte[]) + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyLong implements DataType { + + @Override + public boolean isOrderPreserving() { return false; } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(Long val) { return Bytes.SIZEOF_LONG; } + + @Override + public Class encodedClass() { return Long.class; } + + @Override + public void skip(ByteRange buff) { + buff.setPosition(buff.getPosition() + Bytes.SIZEOF_LONG); + } + + @Override + public Long decode(ByteRange buff) { + long val = Bytes.toLong(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + @Override + public void encode(ByteRange buff, Long val) { + Bytes.putLong(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } + + /** + * Read a long value from the buffer buff. + */ + public long decodeLong(ByteRange buff) { + long val = Bytes.toLong(buff.getBytes(), buff.getOffset() + buff.getPosition()); + skip(buff); + return val; + } + + /** + * Write instance val into buffer buff. + */ + public void encodeLong(ByteRange buff, long val) { + Bytes.putLong(buff.getBytes(), buff.getOffset() + buff.getPosition(), val); + skip(buff); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyString.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyString.java new file mode 100644 index 0000000..155facf --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyString.java @@ -0,0 +1,101 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An DataType for interacting with values encoded using + * {@link Bytes#toBytes(String)}. Intended to make it easier to transition + * away from direct use of {@link Bytes}. + * @see Bytes#toBytes(String) + * @see Bytes#toString(byte[]) + * @see LegacyStringTerminated + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyString implements DataType { + + public static final LegacyString ASCENDING = new LegacyString(Order.ASCENDING); + public static final LegacyString DESCENDING = new LegacyString(Order.DESCENDING); + + protected final Order order; + + protected LegacyString() { this.order = Order.ASCENDING; } + protected LegacyString(Order order) { this.order = order; } + + @Override + public boolean isOrderPreserving() { return true; } + + @Override + public Order getOrder() { return order; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return false; } + + @Override + public void skip(ByteRange buff) { buff.setPosition(buff.getLength()); } + + @Override + public int encodedLength(String val) { return Bytes.toBytes(val).length; } + + @Override + public Class encodedClass() { return String.class; } + + /** + * Skip buff ahead length bytes. + */ + public void skip(ByteRange buff, int length) { + buff.setPosition(buff.getPosition() + length); + } + + @Override + public String decode(ByteRange buff) { + return decode(buff, buff.getRemaining()); + } + + @Override + public void encode(ByteRange buff, String val) { + buff.put(Bytes.toBytes(val)); + } + + /** + * Read a String from the buffer buff. + */ + public String decode(ByteRange buff, int length) { + String val = Bytes.toString(buff.getBytes(), buff.getOffset() + buff.getPosition(), length); + skip(buff, length); + return val; + } + + /** + * Write a String into buff at position + * offset. + * @return incremented offset. + */ + public int encode(byte[] buff, int offset, String val) { + byte[] s = Bytes.toBytes(val); + return Bytes.putBytes(buff, offset, s, 0, s.length); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringFixedLength.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringFixedLength.java new file mode 100644 index 0000000..f3a5999 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringFixedLength.java @@ -0,0 +1,68 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An DataType that encodes fixed-length values encoded using + * {@link Bytes#toBytes(String)}. Intended to make it easier to transition + * away from direct use of {@link Bytes}. + * @see Bytes#toBytes(String) + * @see Bytes#toString(byte[], int, int) + * @see LegacyString + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyStringFixedLength extends FixedLengthWrapper { + + /** + * Create a LegacyStringFixedLength using the specified + * order and length. + */ + public LegacyStringFixedLength(Order order, int length) { + super(new LegacyString(order), length); + } + + /** + * Create a LegacyStringFixedLength of the specified + * length>. + */ + public LegacyStringFixedLength(int length) { + super(new LegacyString(), length); + } + + /** + * Read a String from the buffer buff. + */ + public String decode(ByteRange buff, int length) { + return ((LegacyString) wrapped).decode(buff, length); + } + + /** + * Write a String into buff at position + * offset. + * @return incremented offset. + */ + public int encode(byte[] buff, int offset, String val) { + return ((LegacyString) wrapped).encode(buff, offset, val); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringTerminated.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringTerminated.java new file mode 100644 index 0000000..c98365e --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/LegacyStringTerminated.java @@ -0,0 +1,88 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * An HDataType that encodes variable-length values encoded using + * {@link Bytes#toBytes(String)}. Includes a termination marker following the + * raw byte[] value. Intended to make it easier to transition + * away from direct use of {@link Bytes}. + * @see Bytes#toBytes(String) + * @see Bytes#toString(byte[], int, int) + * @see LegacyString + * @see OrderedString + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class LegacyStringTerminated extends TerminatedWrapper { + + /** + * Create a LegacyStringTerminated using the specified terminator and + * order. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyStringTerminated(Order order, byte[] term) { + super(new LegacyString(order), term); + } + + /** + * Create a LegacyStringTerminated using the specified terminator and + * order. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyStringTerminated(Order order, String term) { + super(new LegacyString(order), term); + } + + /** + * Create a LegacyStringTerminated using the specified terminator. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyStringTerminated(byte[] term) { + super(new LegacyString(), term); + } + + /** + * Create a LegacyStringTerminated using the specified terminator. + * @throws IllegalArgumentException if term is null or empty. + */ + public LegacyStringTerminated(String term) { + super(new LegacyString(), term); + } + + /** + * Read a String from the buffer buff. + */ + public String decode(ByteRange buff, int length) { + return ((LegacyString) wrapped).decode(buff, length); + } + + /** + * Write a String into buff at position + * offset. + * @return incremented offset. + */ + public int encode(byte[] buff, int offset, String val) { + return ((LegacyString) wrapped).encode(buff, offset, val); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Order.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Order.java new file mode 100644 index 0000000..e63e56d --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Order.java @@ -0,0 +1,73 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; + +/** + * The sort order of a DataType instance, either ASCENDING or DESCENDING. + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public enum Order { + ASCENDING, DESCENDING; + + private static final byte mask = (byte) 0xff; + + /** + * Returns the adjusted trichotomous value according to the ordering imposed + * by this Order. + */ + public int cmp(int cmp) { + return cmp * (this == ASCENDING ? 1 : -1); + } + + /** + * Apply order to the byte val. + */ + public byte apply(byte val) { + return (byte) (this == ASCENDING ? val : val ^ mask); + } + + /** + * Apply order to the byte array val. + */ + public void apply(byte[] val) { + if (this != DESCENDING) return; + for (int i = 0; i < val.length; i++) { + val[i] ^= mask; + } + } + + /** + * Apply order to the byte array val according to the Order. + */ + public void apply(byte[] val, int offset, int length) { + if (this != DESCENDING) return; + for (int i = 0; i < length; i++) { + val[offset + i] ^= mask; + } + } + + @Override + public String toString() { + return this == ASCENDING ? "ASCENDING" : "DESCENDING"; + } +} + diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Struct.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Struct.java new file mode 100644 index 0000000..5a58d8a --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Struct.java @@ -0,0 +1,166 @@ +/** + * 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.hadoop.hbase.types; + +import java.util.ArrayList; +import java.util.Iterator; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; + +/** + *

+ * Struct is a simple {@link DataType} for implementing the + * "compound rowkey" schema design strategy. + *

+ *

Encoding

+ *

+ * Struct member values are encoded onto the target + * ByteRange in the order in which they are declared. A + * Struct may be used as a member of another Struct. + * Structs are not nullable but their component + * fields may be. + *

+ *

Sort Order

+ *

+ * Struct instances sort according to the composite order of + * their fields, that is, left-to-right and depth-first. This can also be + * thought of as lexicographic comparison of concatenated members. + *

+ *

+ * {@link StructIterator} is provided as a convenience for consuming the + * sequence of values. Users may find it more appropriate to provide their own + * custom {@link DataType} for encoding application objects rather than using + * this Object[] implementation. Examples are provided in test. + *

+ * @see StructIterator + * @see DataType#isNullable() + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class Struct implements DataType { + + @SuppressWarnings("rawtypes") + protected final DataType[] fields; + protected final boolean isOrderPreserving; + protected final boolean isSkippable; + + /** + * Create a new Struct instance defined as the sequence of + * HDataTypes in memberTypes. + *

+ * A Struct is orderPreserving when all of its + * fields are orderPreserving. A Struct is + * skippable when all of its fields are skippable. + *

+ */ + @SuppressWarnings("rawtypes") + public Struct(DataType[] memberTypes) { + this.fields = memberTypes; + // a Struct is not orderPreserving when any of its fields are not. + boolean preservesOrder = true; + // a Struct is not skippable when any of its fields are not. + boolean skippable = true; + for (int i = 0; i < this.fields.length; i++) { + DataType dt = this.fields[i]; + if (!dt.isOrderPreserving()) preservesOrder = false; + if (i < this.fields.length - 2 && !dt.isSkippable()) + throw new IllegalArgumentException("Non-right-most struct fields must be skippable."); + if (!dt.isSkippable()) skippable = false; + } + this.isOrderPreserving = preservesOrder; + this.isSkippable = skippable; + } + + @Override + public boolean isOrderPreserving() { return isOrderPreserving; } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return isSkippable; } + + @SuppressWarnings("unchecked") + @Override + public int encodedLength(Object[] val) { + assert fields.length == val.length; + int sum = 0; + for (int i = 0; i < fields.length; i++) + sum += fields[i].encodedLength(val[i]); + return sum; + } + + @Override + public Class encodedClass() { return Object[].class; } + + /** + * Retrieve an {@link Iterator} over the values encoded in buff. + * The byte[] backing buff is not modified by use of + * the Iterator, however the state of buff is. To + * create multiple Iterators over the same backing + * ByteRange, construct the Iterators over + * shallowCopies of buff. + */ + public StructIterator iterator(ByteRange buff) { + return new StructIterator(buff, fields); + } + + @Override + public void skip(ByteRange buff) { + StructIterator it = iterator(buff); + while (it.hasNext()) + it.skip(); + } + + @Override + public Object[] decode(ByteRange buff) { + ArrayList values = new ArrayList(fields.length); + Iterator it = iterator(buff); + while (it.hasNext()) + values.add(it.next()); + return values.toArray(); + } + + /** + * Read the field at position. buff is left + * unmodified. + */ + public Object read(ByteRange buff, int position) { + assert position >= 0; + ByteRange b = buff.shallowCopy(); + b.setPosition(buff.getPosition()); + StructIterator it = iterator(b); + for (; position > 0; position--) + it.skip(); + return it.next(); + } + + @SuppressWarnings("unchecked") + @Override + public void encode(ByteRange buff, Object[] val) { + assert fields.length == val.length; + for (int i = 0; i < fields.length; i++) { + fields[i].encode(buff, val[i]); + } + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructBuilder.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructBuilder.java new file mode 100644 index 0000000..c17b190 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructBuilder.java @@ -0,0 +1,54 @@ +/** + * 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.hadoop.hbase.types; + +import java.util.ArrayList; +import java.util.List; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; + +/** + * A helper for building {@link Struct} instances. + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class StructBuilder { + + protected final List> fields = new ArrayList>(); + + /** + * Create an empty StructBuilder. + */ + public StructBuilder() {} + + /** + * Append field to the sequence of accumulated fields. + */ + public StructBuilder add(DataType field) { fields.add(field); return this; } + + /** + * Retrieve the {@link Struct} represented by this. + */ + public Struct toStruct() { return new Struct(fields.toArray(new DataType[fields.size()])); } + + /** + * Reset the sequence of accumulated fields. + */ + public StructBuilder reset() { fields.clear(); return this; } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructIterator.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructIterator.java new file mode 100644 index 0000000..a1ff772 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/StructIterator.java @@ -0,0 +1,88 @@ +/** + * 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.hadoop.hbase.types; + +import java.nio.ByteBuffer; +import java.util.Iterator; +import java.util.NoSuchElementException; + +import org.apache.hadoop.hbase.util.ByteRange; + +/** + * An {@link Iterator} over encoded Struct members. + *

+ * This iterates over each serialized Struct field from the + * specified DataTypes[] definition. It allows you to read + * the field or skip over its serialized bytes using {@link #next()} and + * {@link #skip()}, respectively. This is in contrast to the + * Struct method which allow you to + * {@link Struct#decode(ByteRange)} or {@link Struct#skip(ByteBuffer)} over the + * entire Struct at once. + *

+ *

+ * This iterator may also be used to read bytes from any Struct + * for which the specified DataType[] is a prefix. For + * example, if the specified Struct definition has a + * {@link LegacyInteger} and a {@link LegacyStringTerminated} field, you may parse the serialized + * output of a Struct whose fields are {@link LegacyInteger}, + * {@link LegacyStringTerminated}, and {@link LegacyBytes}. The iterator would return a number + * followed by a String. The trailing byte[] would + * be ignored. + *

+ */ +public class StructIterator implements Iterator { + + protected final ByteRange buff; + @SuppressWarnings("rawtypes") + protected final DataType[] types; + protected int idx = 0; + + /** + * Construct StructIterator over the values encoded in + * buff using the specified types definition. + * @param buff The buffer from which to read encoded values. + * @param types The sequence of types to use as the schema for this + * Struct. + */ + public StructIterator(final ByteRange buff, @SuppressWarnings("rawtypes") DataType[] types) { + this.buff = buff; + this.types = types; + } + + @Override + public boolean hasNext() { + return idx < types.length && buff.getRemaining() > 0; + } + + @Override + public void remove() { throw new UnsupportedOperationException(); } + + @Override + public Object next() { + if (!hasNext()) throw new NoSuchElementException(); + return types[idx++].decode(buff); + } + + /** + * Bypass the next encoded value. + */ + public void skip() { + if (!hasNext()) throw new NoSuchElementException(); + types[idx++].skip(buff); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/TerminatedWrapper.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/TerminatedWrapper.java new file mode 100644 index 0000000..d8e91ed --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/TerminatedWrapper.java @@ -0,0 +1,153 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; + +/** + * Wraps an existing DataType implementation as a terminated + * version of itself. This has the useful side-effect of turning an existing + * DataType which is not skippable into a + * skippable variant. + */ +@InterfaceAudience.Public +@InterfaceStability.Evolving +public class TerminatedWrapper implements DataType { + + protected final DataType wrapped; + protected final byte[] term; + + /** + * Create a terminated version of the wrapped. + * @throws IllegalArgumentException when term is null or empty. + */ + public TerminatedWrapper(DataType wrapped, byte[] term) { + if (null == term || term.length == 0) + throw new IllegalArgumentException("terminator must be non-null and non-empty."); + this.wrapped = wrapped; + wrapped.getOrder().apply(term); + this.term = term; + } + + /** + * Create a terminated version of the wrapped. + * term is converted to a byte[] using + * {@link Bytes#toBytes(String)}. + * @throws IllegalArgumentException when term is null or empty. + */ + public TerminatedWrapper(DataType wrapped, String term) { + this(wrapped, Bytes.toBytes(term)); + } + + @Override + public boolean isOrderPreserving() { return wrapped.isOrderPreserving(); } + + @Override + public Order getOrder() { return wrapped.getOrder(); } + + @Override + public boolean isNullable() { return wrapped.isNullable(); } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(T val) { + return wrapped.encodedLength(val) + term.length; + } + + @Override + public Class encodedClass() { return wrapped.encodedClass(); } + + /** + * Return the position at which term begins within + * buff, or -1 if term is not found. + */ + protected int terminatorPosition(ByteRange buff) { + int i, limit = buff.getLength(), offset = buff.getOffset(); + byte[] a = buff.getBytes(); + SKIP: for (i = buff.getPosition(); i < limit; i++) { + if (a[offset + i] != term[0]) continue; + int j; + for (j = 1; j < term.length && i + j < limit; j++) { + if (a[offset + i + j] != term[j]) continue SKIP; + } + if (j == term.length) return i; // success + } + return -1; + } + + /** + * Skip the position of buff over the encoded value. + * @throws IllegalArgumentException when the terminator sequence is not + * found. In the event this exception is thrown, + * buff#position() is restored to the original value. + */ + @Override + public void skip(ByteRange buff) { + if (wrapped.isSkippable()) { + wrapped.skip(buff); + buff.setPosition(buff.getPosition() + term.length); + } else { + int skipTo = terminatorPosition(buff); + if (-1 == skipTo) { + throw new IllegalArgumentException("Terminator sequence not found."); + } + buff.setPosition(skipTo + term.length); + } + } + + @Override + public T decode(ByteRange buff) { + T ret; + if (wrapped.isSkippable()) { + ret = wrapped.decode(buff); + } else { + ByteRange b = buff.shallowCopy(); + b.setPosition(buff.getPosition()); + b.setLength(terminatorPosition(buff)); + ret = wrapped.decode(b); + buff.setPosition(b.getPosition()); + } + buff.setPosition(buff.getPosition() + term.length); + return ret; + } + + /** + * Write instance val into buffer buff. + * @throws IllegalArgumentException when the encoded representation of + * val contains the term sequence. In + * the event this exception is thrown, + * buff#position() is restored the original value. + */ + @Override + public void encode(ByteRange buff, T val) { + int start = buff.getPosition(); + wrapped.encode(buff, val); + ByteRange b = buff.shallowCopy(); + b.setLength(buff.getPosition() - start); + if (-1 != terminatorPosition(b)) { + buff.setPosition(start); + throw new IllegalArgumentException("Encoded value contains terminator sequence."); + } + buff.put(term); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union2.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union2.java new file mode 100644 index 0000000..5e06961 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union2.java @@ -0,0 +1,85 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; + +/** + * The Union family of {@link DataType}s encode one of a fixed + * set of Objects. They provide convenience methods which handle + * type casting on your behalf. + */ +@SuppressWarnings("unchecked") +@InterfaceAudience.Public +@InterfaceStability.Evolving +public abstract class Union2 implements DataType { + + protected final DataType typeA; + protected final DataType typeB; + + /** + * Create an instance of Union2 over the set of specified + * types. + */ + public Union2(DataType typeA, DataType typeB) { + this.typeA = typeA; + this.typeB = typeB; + } + + @Override + public boolean isOrderPreserving() { + return typeA.isOrderPreserving() && typeB.isOrderPreserving(); + } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { + return typeA.isNullable() && typeB.isNullable(); + } + + @Override + public boolean isSkippable() { + return typeA.isSkippable() && typeB.isSkippable(); + } + + @Override + public Class encodedClass() { + throw new UnsupportedOperationException( + "Union types do not expose a definitive encoded class."); + } + + /** + * Read an instance of the first type parameter from buffer + * buff. + */ + public A decodeA(ByteRange buff) { + return (A) decode(buff); + } + + /** + * Read an instance of the second type parameter from buffer + * buff. + */ + public B decodeB(ByteRange buff) { + return (B) decode(buff); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union3.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union3.java new file mode 100644 index 0000000..e34fdad --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union3.java @@ -0,0 +1,70 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; + +/** + * The Union family of {@link DataType}s encode one of a fixed + * collection of Objects. They provide convenience methods which handle type + * casting on your behalf. + * @see Union2 + */ +@SuppressWarnings("unchecked") +@InterfaceAudience.Public +@InterfaceStability.Evolving +public abstract class Union3 extends Union2 { + + protected final DataType typeC; + + /** + * Create an instance of Union3 over the set of specified + * types. + */ + public Union3(DataType typeA, DataType typeB, DataType typeC) { + super(typeA, typeB); + this.typeC = typeC; + } + + @Override + public boolean isOrderPreserving() { + return super.isOrderPreserving() && typeC.isOrderPreserving(); + } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { + return super.isNullable() && typeC.isNullable(); + } + + @Override + public boolean isSkippable() { + return super.isSkippable() && typeC.isSkippable(); + } + + /** + * Read an instance of the third type parameter from buffer b. + */ + public C decodeC(ByteRange buff) { + return (C) decode(buff); + } +} diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union4.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union4.java new file mode 100644 index 0000000..ecf5694 --- /dev/null +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/types/Union4.java @@ -0,0 +1,69 @@ +/** + * 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.hadoop.hbase.types; + +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.hbase.util.ByteRange; + +/** + * The Union family of {@link DataType}s encode one of a fixed + * collection of Objects. They provide convenience methods which handle type + * casting on your behalf. + */ +@SuppressWarnings("unchecked") +@InterfaceAudience.Public +@InterfaceStability.Evolving +public abstract class Union4 extends Union3 { + + protected final DataType typeD; + + /** + * Create an instance of Union4 over the set of specified + * types. + */ + public Union4(DataType typeA, DataType typeB, DataType typeC, DataType typeD) { + super(typeA, typeB, typeC); + this.typeD = typeD; + } + + @Override + public boolean isOrderPreserving() { + return super.isOrderPreserving() && typeD.isOrderPreserving(); + } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { + return super.isNullable() && typeD.isNullable(); + } + + @Override + public boolean isSkippable() { + return super.isSkippable() && typeD.isSkippable(); + } + + /** + * Read an instance of the fourth type parameter from buffer b. + */ + public D decodeD(ByteRange b) { + return (D) decode(b); + } +} diff --git a/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestFixedLengthWrapper.java b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestFixedLengthWrapper.java new file mode 100644 index 0000000..3214b58 --- /dev/null +++ b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestFixedLengthWrapper.java @@ -0,0 +1,87 @@ +/** + * 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.hadoop.hbase.types; + +import static org.junit.Assert.assertArrayEquals; +import static org.junit.Assert.assertEquals; + +import java.util.Arrays; + +import org.apache.hadoop.hbase.SmallTests; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.ByteRangeUtils; +import org.apache.hadoop.hbase.util.Bytes; +import org.junit.Test; +import org.junit.experimental.categories.Category; + +@Category(SmallTests.class) +public class TestFixedLengthWrapper { + + static final byte[][] VALUES = new byte[][] { + Bytes.toBytes(""), Bytes.toBytes("1"), Bytes.toBytes("22"), Bytes.toBytes("333"), + Bytes.toBytes("4444"), Bytes.toBytes("55555"), Bytes.toBytes("666666"), + Bytes.toBytes("7777777"), Bytes.toBytes("88888888"), Bytes.toBytes("999999999"), + }; + + /** + * all values of limit are >= max length of a member of + * VALUES. + */ + static final int[] limits = { 9, 12, 15 }; + + @Test + public void testReadWrite() { + for (int limit : limits) { + ByteRange buff = new ByteRange(limit); + for (Order ord : new Order[] { Order.ASCENDING, Order.DESCENDING }) { + for (byte[] val : VALUES) { + DataType type = new FixedLengthWrapper(new LegacyBytes(ord), limit); + ByteRangeUtils.clear(buff); + type.encode(buff, val); + assertEquals(buff.getLength(), buff.getPosition()); + ByteRangeUtils.flip(buff); + byte[] expected = Arrays.copyOf(val, limit); + byte[] actual = type.decode(buff); + assertEquals(buff.getLength(), buff.getPosition()); + assertArrayEquals(expected, actual); + } + } + } + } + + @Test(expected = IllegalArgumentException.class) + public void testInsufficientRemainingRead() { + ByteRange buff = new ByteRange(0); + DataType type = new FixedLengthWrapper(new LegacyBytes(), 3); + type.decode(buff); + } + + @Test(expected = IllegalArgumentException.class) + public void testInsufficientRemainingWrite() { + ByteRange buff = new ByteRange(0); + DataType type = new FixedLengthWrapper(new LegacyBytes(), 3); + type.encode(buff, Bytes.toBytes("")); + } + + @Test(expected = IndexOutOfBoundsException.class) + public void testOverflowPassthrough() { + ByteRange buff = new ByteRange(3); + DataType type = new FixedLengthWrapper(new LegacyBytes(), 0); + type.encode(buff, Bytes.toBytes("foo")); + } +} diff --git a/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestStruct.java b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestStruct.java new file mode 100644 index 0000000..a3f3ba6 --- /dev/null +++ b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestStruct.java @@ -0,0 +1,355 @@ +package org.apache.hadoop.hbase.types; + +import static org.junit.Assert.assertArrayEquals; +import static org.junit.Assert.assertEquals; + +import java.lang.reflect.Constructor; +import java.util.Arrays; +import java.util.Collection; +import java.util.Comparator; + +import org.apache.hadoop.hbase.SmallTests; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.Bytes; +import org.junit.Test; +import org.junit.experimental.categories.Category; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +/** + * This class both tests and demonstrates how to construct compound rowkeys + * from a POJO. The code under test is {@link Struct}. + * {@link SpecializedPojo1Type1} demonstrates how one might create their own + * custom data type extension for an application POJO. + */ +@RunWith(Parameterized.class) +@Category(SmallTests.class) +public class TestStruct { + + private Struct generic; + @SuppressWarnings("rawtypes") + private DataType specialized; + private Object[][] constructorArgs; + + public TestStruct(Struct generic, @SuppressWarnings("rawtypes") DataType specialized, + Object[][] constructorArgs) { + this.generic = generic; + this.specialized = specialized; + this.constructorArgs = constructorArgs; + } + + @Parameters + public static Collection params() { + Object[][] pojo1Args = { + new Object[] { "foo", 5, 10.001 }, + new Object[] { "foo", 100, 7.0 }, + new Object[] { "foo", 100, 10.001 }, + new Object[] { "bar", 5, 10.001 }, + new Object[] { "bar", 100, 10.001 }, + new Object[] { "baz", 5, 10.001 }, + }; + + Object[][] pojo2Args = { + new Object[] { new byte[0], "it".getBytes(), "was", "the".getBytes() }, + new Object[] { "best".getBytes(), new byte[0], "of", "times,".getBytes() }, + new Object[] { "it".getBytes(), "was".getBytes(), "", "the".getBytes() }, + new Object[] { "worst".getBytes(), "of".getBytes(), "times,", new byte[0] }, + new Object[] { new byte[0], new byte[0], "", new byte[0] }, + }; + + Object[][] params = new Object[][] { + { SpecializedPojo1Type1.GENERIC, new SpecializedPojo1Type1(), pojo1Args }, + { SpecializedPojo2Type1.GENERIC, new SpecializedPojo2Type1(), pojo2Args }, + }; + return Arrays.asList(params); + } + + static final Comparator NULL_SAFE_BYTES_COMPARATOR = + new Comparator() { + @Override + public int compare(byte[] o1, byte[] o2) { + if (o1 == o2) return 0; + if (null == o1) return -1; + if (null == o2) return 1; + return Bytes.compareTo(o1, o2); + } + }; + + /** + * A simple object to serialize. + */ + private static class Pojo1 implements Comparable { + final String stringFieldAsc; + final int intFieldAsc; + final double doubleFieldAsc; + final transient String str; + + public Pojo1(Object... argv) { + stringFieldAsc = (String) argv[0]; + intFieldAsc = (Integer) argv[1]; + doubleFieldAsc = (Double) argv[2]; + str = new StringBuilder() + .append("{ ") + .append(null == stringFieldAsc ? "" : "\"") + .append(stringFieldAsc) + .append(null == stringFieldAsc ? "" : "\"").append(", ") + .append(intFieldAsc).append(", ") + .append(doubleFieldAsc) + .append(" }") + .toString(); + } + + @Override + public String toString() { + return str; + } + + @Override + public int compareTo(Pojo1 o) { + int cmp = stringFieldAsc.compareTo(o.stringFieldAsc); + if (cmp != 0) return cmp; + cmp = Integer.valueOf(intFieldAsc).compareTo(Integer.valueOf(o.intFieldAsc)); + if (cmp != 0) return cmp; + return Double.compare(doubleFieldAsc, o.doubleFieldAsc); + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (null == o) return false; + if (!(o instanceof Pojo1)) return false; + Pojo1 that = (Pojo1) o; + return 0 == this.compareTo(that); + } + } + + /** + * A simple object to serialize. + */ + private static class Pojo2 implements Comparable { + final byte[] byteField1Asc; + final byte[] byteField2Dsc; + final String stringFieldDsc; + final byte[] byteField3Dsc; + final transient String str; + + public Pojo2(Object... vals) { + byte[] empty = new byte[0]; + byteField1Asc = vals.length > 0 ? (byte[]) vals[0] : empty; + byteField2Dsc = vals.length > 1 ? (byte[]) vals[1] : empty; + stringFieldDsc = vals.length > 2 ? (String) vals[2] : ""; + byteField3Dsc = vals.length > 3 ? (byte[]) vals[3] : empty; + str = new StringBuilder() + .append("{ ") + .append(Bytes.toStringBinary(byteField1Asc)).append(", ") + .append(Bytes.toStringBinary(byteField2Dsc)).append(", ") + .append(null == stringFieldDsc ? "" : "\"") + .append(stringFieldDsc) + .append(null == stringFieldDsc ? "" : "\"").append(", ") + .append(Bytes.toStringBinary(byteField3Dsc)) + .append(" }") + .toString(); + } + + @Override + public String toString() { + return str; + } + + @Override + public int compareTo(Pojo2 o) { + int cmp = NULL_SAFE_BYTES_COMPARATOR.compare(byteField1Asc, o.byteField1Asc); + if (cmp != 0) return cmp; + cmp = -NULL_SAFE_BYTES_COMPARATOR.compare(byteField2Dsc, o.byteField2Dsc); + if (cmp != 0) return cmp; + if (stringFieldDsc == o.stringFieldDsc) cmp = 0; + else if (null == stringFieldDsc) cmp = 1; + else if (null == o.stringFieldDsc) cmp = -1; + else cmp = -stringFieldDsc.compareTo(o.stringFieldDsc); + if (cmp != 0) return cmp; + return -NULL_SAFE_BYTES_COMPARATOR.compare(byteField3Dsc, o.byteField3Dsc); + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (null == o) return false; + if (!(o instanceof Pojo2)) return false; + Pojo2 that = (Pojo2) o; + return 0 == this.compareTo(that); + } + } + + /** + * A custom data type implementation specialized for {@link Pojo1}. + */ + private static class SpecializedPojo1Type1 implements DataType { + + private static final LegacyStringTerminated stringField = new LegacyStringTerminated("/"); + private static final LegacyInteger intField = new LegacyInteger(); + private static final LegacyDouble doubleField = new LegacyDouble(); + + /** + * The {@link Struct} equivalent of this type. + */ + public static Struct GENERIC = + new StructBuilder().add(stringField) + .add(intField) + .add(doubleField) + .toStruct(); + + @Override + public boolean isOrderPreserving() { return true; } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(Pojo1 val) { + return + stringField.encodedLength(val.stringFieldAsc) + + intField.encodedLength(val.intFieldAsc) + + doubleField.encodedLength(val.doubleFieldAsc); + } + + @Override + public Class encodedClass() { return Pojo1.class; } + + @Override + public void skip(ByteRange buff) { + stringField.skip(buff); + intField.skip(buff); + doubleField.skip(buff); + } + + @Override + public Pojo1 decode(ByteRange buff) { + return new Pojo1(new Object[] { + stringField.decode(buff), + intField.decodeInt(buff), + doubleField.decodeDouble(buff) + }); + } + + @Override + public void encode(ByteRange buff, Pojo1 val) { + stringField.encode(buff, val.stringFieldAsc); + intField.encodeInt(buff, val.intFieldAsc); + doubleField.encodeDouble(buff, val.doubleFieldAsc); + } + } + + /** + * A custom data type implementation specialized for {@link Pojo2}. + */ + private static class SpecializedPojo2Type1 implements DataType { + + private static LegacyBytesTerminated byteField1 = new LegacyBytesTerminated("/"); + private static LegacyBytesTerminated byteField2 = + new LegacyBytesTerminated(Order.DESCENDING, "/"); + private static LegacyStringTerminated stringField = + new LegacyStringTerminated(Order.DESCENDING, new byte[] { 0x00 }); + private static LegacyBytes byteField3 = LegacyBytes.DESCENDING; + + /** + * The {@link Struct} equivalent of this type. + */ + public static Struct GENERIC = + new StructBuilder().add(byteField1) + .add(byteField2) + .add(stringField) + .add(byteField3) + .toStruct(); + + @Override + public boolean isOrderPreserving() { return true; } + + @Override + public Order getOrder() { return null; } + + @Override + public boolean isNullable() { return false; } + + @Override + public boolean isSkippable() { return true; } + + @Override + public int encodedLength(Pojo2 val) { + return + byteField1.encodedLength(val.byteField1Asc) + + byteField2.encodedLength(val.byteField2Dsc) + + stringField.encodedLength(val.stringFieldDsc) + + byteField3.encodedLength(val.byteField3Dsc); + } + + @Override + public Class encodedClass() { return Pojo2.class; } + + @Override + public void skip(ByteRange buff) { + byteField1.skip(buff); + byteField2.skip(buff); + stringField.skip(buff); + byteField3.skip(buff); + } + + @Override + public Pojo2 decode(ByteRange buff) { + return new Pojo2( + byteField1.decode(buff), + byteField2.decode(buff), + stringField.decode(buff), + byteField3.decode(buff)); + } + + @Override + public void encode(ByteRange buff, Pojo2 val) { + byteField1.encode(buff, val.byteField1Asc); + byteField2.encode(buff, val.byteField2Dsc); + stringField.encode(buff, val.stringFieldDsc); + byteField3.encode(buff, val.byteField3Dsc); + } + } + + @Test + @SuppressWarnings("unchecked") + public void testOrderPreservation() throws Exception { + Object[] vals = new Object[constructorArgs.length]; + byte[][] encodedGeneric = new byte[constructorArgs.length][]; + byte[][] encodedSpecialized = new byte[constructorArgs.length][]; + Constructor ctor = specialized.encodedClass().getConstructor(Object[].class); + for (int i = 0; i < vals.length; i++) { + vals[i] = ctor.newInstance(new Object[] { constructorArgs[i] }); + encodedGeneric[i] = new byte[generic.encodedLength(constructorArgs[i])]; + encodedSpecialized[i] = new byte[specialized.encodedLength(vals[i])]; + } + + // populate our arrays + for (int i = 0; i < vals.length; i++) { + generic.encode(new ByteRange(encodedGeneric[i]), constructorArgs[i]); + specialized.encode(new ByteRange(encodedSpecialized[i]), vals[i]); + assertArrayEquals(encodedGeneric[i], encodedSpecialized[i]); + } + + Arrays.sort(vals); + Arrays.sort(encodedGeneric, NULL_SAFE_BYTES_COMPARATOR); + Arrays.sort(encodedSpecialized, NULL_SAFE_BYTES_COMPARATOR); + + for (int i = 0; i < vals.length; i++) { + assertEquals( + "Struct encoder does not preserve sort order at position " + i, + vals[i], + ctor.newInstance(new Object[] { generic.decode(new ByteRange(encodedGeneric[i])) })); + assertEquals( + "Specialized encoder does not preserve sort order at position " + i, + vals[i], specialized.decode(new ByteRange(encodedSpecialized[i]))); + } + } +} diff --git a/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestTerminatedWrapper.java b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestTerminatedWrapper.java new file mode 100644 index 0000000..dd3c001 --- /dev/null +++ b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestTerminatedWrapper.java @@ -0,0 +1,101 @@ +/** + * 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.hadoop.hbase.types; + +import static org.junit.Assert.assertArrayEquals; +import static org.junit.Assert.assertEquals; + +import org.apache.hadoop.hbase.SmallTests; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.ByteRangeUtils; +import org.apache.hadoop.hbase.util.Bytes; +import org.junit.Test; +import org.junit.experimental.categories.Category; + +@Category(SmallTests.class) +public class TestTerminatedWrapper { + + static final byte[][] VALUES = new byte[][] { + Bytes.toBytes(""), Bytes.toBytes("1"), Bytes.toBytes("22"), Bytes.toBytes("333"), + Bytes.toBytes("4444"), Bytes.toBytes("55555"), Bytes.toBytes("666666"), + Bytes.toBytes("7777777"), Bytes.toBytes("88888888"), Bytes.toBytes("999999999"), + }; + + static final byte[][] TERMINATORS = new byte[][] { new byte[] { -1 }, Bytes.toBytes("foo") }; + + @Test(expected = IllegalArgumentException.class) + public void testEmptyDelimiter() { + new TerminatedWrapper(new LegacyBytes(), ""); + } + + @Test(expected = IllegalArgumentException.class) + public void testNullDelimiter() { + new LegacyBytesTerminated((byte[]) null); + // new TerminatedWrapper(new LegacyBytes(), (byte[]) null); + } + + @Test(expected = IllegalArgumentException.class) + public void testEncodedValueContainsTerm() { + DataType type = new TerminatedWrapper(new LegacyBytes(), "foo"); + ByteRange buff = new ByteRange(16); + type.encode(buff, Bytes.toBytes("hello foobar!")); + } + + @Test + public void testReadWrite() { + ByteRange buff = new ByteRange(12); + for (Order ord : new Order[] { Order.ASCENDING, Order.DESCENDING }) { + for (byte[] term : TERMINATORS) { + for (byte[] val : VALUES) { + DataType type = new TerminatedWrapper(new LegacyBytes(ord), term); + ByteRangeUtils.clear(buff); + type.encode(buff, val); + ByteRangeUtils.flip(buff); + assertArrayEquals(val, type.decode(buff)); + } + } + } + } + + @Test + public void testSkip() { + ByteRange buff = new ByteRange(12); + for (Order ord : new Order[] { Order.ASCENDING, Order.DESCENDING }) { + for (byte[] term : TERMINATORS) { + for (byte[] val : VALUES) { + DataType type = new TerminatedWrapper(new LegacyBytes(ord), term); + ByteRangeUtils.clear(buff); + type.encode(buff, val); + int expected = buff.getPosition(); + ByteRangeUtils.flip(buff); + type.skip(buff); + assertEquals(expected, buff.getPosition()); + } + } + } + } + + @Test(expected = IllegalArgumentException.class) + public void testInvalidSkip() { + ByteRange buff = new ByteRange(3); + buff.put(Bytes.toBytes("foo")); + ByteRangeUtils.flip(buff); + DataType type = new TerminatedWrapper(new LegacyBytes(), new byte[] { 0x00 }); + type.skip(buff); + } +} diff --git a/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestUnion2.java b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestUnion2.java new file mode 100644 index 0000000..cfab774 --- /dev/null +++ b/hbase-common/src/test/java/org/apache/hadoop/hbase/types/TestUnion2.java @@ -0,0 +1,155 @@ +/** + * 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.hadoop.hbase.types; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +import org.apache.hadoop.hbase.SmallTests; +import org.apache.hadoop.hbase.util.ByteRange; +import org.apache.hadoop.hbase.util.ByteRangeUtils; +import org.junit.Test; +import org.junit.experimental.categories.Category; + +@Category(SmallTests.class) +public class TestUnion2 { + + /** + * An example Union + */ + private static class SampleUnion1 extends Union2 { + + private static final byte IS_INTEGER = 0x00; + private static final byte IS_STRING = 0x01; + + public SampleUnion1(Order order) { + super(new LegacyInteger(), LegacyString.DESCENDING); + } + + @Override + public void skip(ByteRange buff) { + switch (buff.get()) { + case IS_INTEGER: + typeA.skip(buff); + break; + case IS_STRING: + typeB.skip(buff); + break; + default: + throw new IllegalArgumentException("Unrecognized encoding format."); + } + } + + @Override + public Object decode(ByteRange buff) { + switch (buff.get()) { + case IS_INTEGER: + return typeA.decode(buff); + case IS_STRING: + return typeB.decode(buff); + default: + throw new IllegalArgumentException("Unrecognized encoding format."); + } + } + + @Override + public int encodedLength(Object val) { + Integer i = null; + String s = null; + try { + i = (Integer) val; + } catch (ClassCastException e) {} + try { + s = (String) val; + } catch (ClassCastException e) {} + + if (null != i) return 1 + typeA.encodedLength(i); + if (null != s) return 1 + typeB.encodedLength(s); + throw new IllegalArgumentException("val is not a valid member of this union."); + } + + @Override + public void encode(ByteRange buff, Object val) { + Integer i = null; + String s = null; + try { + i = (Integer) val; + } catch (ClassCastException e) {} + try { + s = (String) val; + } catch (ClassCastException e) {} + + if (null != i) { + buff.put(IS_INTEGER); + typeA.encode(buff, i); + } else if (null != s) { + buff.put(IS_STRING); + typeB.encode(buff, s); + } + else + throw new IllegalArgumentException("val is not of a supported type."); + } + + } + + @Test + public void testEncodeDecode() { + Integer intVal = Integer.valueOf(10); + String strVal = "hello"; + ByteRange buff = new ByteRange(10); + + for (SampleUnion1 type : new SampleUnion1[] { + new SampleUnion1(Order.ASCENDING), + new SampleUnion1(Order.DESCENDING) + }) { + ByteRangeUtils.clear(buff); + type.encode(buff, intVal); + ByteRangeUtils.flip(buff); + assertTrue(0 == intVal.compareTo(type.decodeA(buff))); + + ByteRangeUtils.clear(buff); + type.encode(buff, strVal); + ByteRangeUtils.flip(buff); + assertTrue(0 == strVal.compareTo(type.decodeB(buff))); + } + } + + @Test + public void testSkip() { + Integer intVal = Integer.valueOf(10); + String strVal = "hello"; + ByteRange buff = new ByteRange(10); + + for (SampleUnion1 type : new SampleUnion1[] { + new SampleUnion1(Order.ASCENDING), + new SampleUnion1(Order.DESCENDING) + }) { + ByteRangeUtils.clear(buff); + type.encode(buff, intVal); + ByteRangeUtils.flip(buff); + type.skip(buff); + assertEquals(buff.getLength(), buff.getPosition()); + + ByteRangeUtils.clear(buff); + type.encode(buff, strVal); + ByteRangeUtils.flip(buff); + type.skip(buff); + assertEquals(buff.getLength(), buff.getPosition()); + } + } +} -- 1.8.3.2