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  package org.apache.hadoop.hbase.mapreduce;
19  
20  import java.io.IOException;
21  import java.util.List;
22  
23  import org.apache.hadoop.hbase.classification.InterfaceAudience;
24  import org.apache.hadoop.hbase.classification.InterfaceStability;
25  import org.apache.hadoop.conf.Configurable;
26  import org.apache.hadoop.hbase.Tag;
27  
28  /**
29   * Interface to convert visibility expressions into Tags for storing along with Cells in HFiles.
30   */
31  @InterfaceAudience.Public
32  @InterfaceStability.Evolving
33  public interface VisibilityExpressionResolver extends Configurable {
34  
35    /**
36     * Giving a chance for the initialization.
37     */
38    void init();
39  
40    /**
41     * Convert visibility expression into tags to be serialized.
42     * @param visExpression the label expression
43     * @return The list of tags corresponds to the visibility expression. These tags will be stored
44     *         along with the Cells.
45     */
46    List<Tag> createVisibilityExpTags(String visExpression) throws IOException;
47  }