001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.mapreduce;
019
020import java.io.IOException;
021import java.util.List;
022
023import org.apache.yetus.audience.InterfaceAudience;
024import org.apache.hadoop.conf.Configurable;
025import org.apache.hadoop.hbase.Tag;
026
027/**
028 * Interface to convert visibility expressions into Tags for storing along with Cells in HFiles.
029 */
030@InterfaceAudience.Public
031public interface VisibilityExpressionResolver extends Configurable {
032
033  /**
034   * Giving a chance for the initialization.
035   */
036  void init();
037
038  /**
039   * Convert visibility expression into tags to be serialized.
040   * @param visExpression the label expression
041   * @return The list of tags corresponds to the visibility expression. These tags will be stored
042   *         along with the Cells.
043   */
044  List<Tag> createVisibilityExpTags(String visExpression) throws IOException;
045}