View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.hadoop.hbase.codec.prefixtree.encode.tokenize;
20  
21  import org.apache.hadoop.hbase.classification.InterfaceAudience;
22  
23  
24  /**
25   * Warning: currently unused, but code is valid.  Pending performance testing on more data sets.
26   *
27   * Where is the key relative to our current position in the tree. For example, the current tree node
28   * is "BEFORE" the key we are seeking
29   */
30  @InterfaceAudience.Private
31  public enum TokenizerRowSearchPosition {
32  
33    AFTER,//the key is after this tree node, so keep searching
34    BEFORE,//in a binary search, this tells us to back up
35    MATCH,//the current node is a full match
36    NO_MATCH,//might as well return a value more informative than null
37  
38  }