org.apache.hudi.org.apache.hadoop.hbase.filter.ColumnPrefixFilter Maven / Gradle / Ivy
/*
*
* 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.filter;
import java.io.IOException;
import java.util.ArrayList;
import org.apache.hadoop.hbase.ByteBufferExtendedCell;
import org.apache.hadoop.hbase.Cell;
import org.apache.hadoop.hbase.PrivateCellUtil;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.exceptions.DeserializationException;
import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;
import org.apache.hadoop.hbase.util.ByteBufferUtils;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;
import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;
import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;
/**
* This filter is used for selecting only those keys with columns that matches
* a particular prefix. For example, if prefix is 'an', it will pass keys with
* columns like 'and', 'anti' but not keys with columns like 'ball', 'act'.
*/
@InterfaceAudience.Public
public class ColumnPrefixFilter extends FilterBase {
protected byte [] prefix = null;
public ColumnPrefixFilter(final byte [] prefix) {
this.prefix = prefix;
}
public byte[] getPrefix() {
return prefix;
}
@Override
public boolean filterRowKey(Cell cell) throws IOException {
// Impl in FilterBase might do unnecessary copy for Off heap backed Cells.
return false;
}
@Deprecated
@Override
public ReturnCode filterKeyValue(final Cell c) {
return filterCell(c);
}
@Override
public ReturnCode filterCell(final Cell cell) {
if (this.prefix == null) {
return ReturnCode.INCLUDE;
} else {
return filterColumn(cell);
}
}
public ReturnCode filterColumn(Cell cell) {
int qualifierLength = cell.getQualifierLength();
if (qualifierLength < prefix.length) {
int cmp = compareQualifierPart(cell, qualifierLength, this.prefix);
if (cmp <= 0) {
return ReturnCode.SEEK_NEXT_USING_HINT;
} else {
return ReturnCode.NEXT_ROW;
}
} else {
int cmp = compareQualifierPart(cell, this.prefix.length, this.prefix);
if (cmp < 0) {
return ReturnCode.SEEK_NEXT_USING_HINT;
} else if (cmp > 0) {
return ReturnCode.NEXT_ROW;
} else {
return ReturnCode.INCLUDE;
}
}
}
private static int compareQualifierPart(Cell cell, int length, byte[] prefix) {
if (cell instanceof ByteBufferExtendedCell) {
return ByteBufferUtils.compareTo(((ByteBufferExtendedCell) cell).getQualifierByteBuffer(),
((ByteBufferExtendedCell) cell).getQualifierPosition(), length, prefix, 0, length);
}
return Bytes.compareTo(cell.getQualifierArray(), cell.getQualifierOffset(), length, prefix, 0,
length);
}
public static Filter createFilterFromArguments(ArrayList filterArguments) {
Preconditions.checkArgument(filterArguments.size() == 1,
"Expected 1 but got: %s", filterArguments.size());
byte [] columnPrefix = ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));
return new ColumnPrefixFilter(columnPrefix);
}
/**
* @return The filter serialized using pb
*/
@Override
public byte [] toByteArray() {
FilterProtos.ColumnPrefixFilter.Builder builder =
FilterProtos.ColumnPrefixFilter.newBuilder();
if (this.prefix != null) builder.setPrefix(UnsafeByteOperations.unsafeWrap(this.prefix));
return builder.build().toByteArray();
}
/**
* @param pbBytes A pb serialized {@link ColumnPrefixFilter} instance
* @return An instance of {@link ColumnPrefixFilter} made from bytes
* @throws org.apache.hadoop.hbase.exceptions.DeserializationException
* @see #toByteArray
*/
public static ColumnPrefixFilter parseFrom(final byte [] pbBytes)
throws DeserializationException {
FilterProtos.ColumnPrefixFilter proto;
try {
proto = FilterProtos.ColumnPrefixFilter.parseFrom(pbBytes);
} catch (InvalidProtocolBufferException e) {
throw new DeserializationException(e);
}
return new ColumnPrefixFilter(proto.getPrefix().toByteArray());
}
/**
* @param o the other filter to compare with
* @return true if and only if the fields of the filter that are serialized
* are equal to the corresponding fields in other. Used for testing.
*/
@Override
boolean areSerializedFieldsEqual(Filter o) {
if (o == this) return true;
if (!(o instanceof ColumnPrefixFilter)) return false;
ColumnPrefixFilter other = (ColumnPrefixFilter)o;
return Bytes.equals(this.getPrefix(), other.getPrefix());
}
@Override
public Cell getNextCellHint(Cell cell) {
return PrivateCellUtil.createFirstOnRowCol(cell, prefix, 0, prefix.length);
}
@Override
public String toString() {
return this.getClass().getSimpleName() + " " + Bytes.toStringBinary(this.prefix);
}
@Override
public boolean equals(Object obj) {
return obj instanceof Filter && areSerializedFieldsEqual((Filter) obj);
}
@Override
public int hashCode() {
return Bytes.hashCode(this.getPrefix());
}
}