exec/java-exec/src/main/java/org/apache/drill/exec/store/dfs/FormatLocationTransformer.java

/*
 * 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.drill.exec.store.dfs;

import java.util.function.Function;

/**
 * Provides the ability to transform format location before creating
 * {@link FileSelection} if required.
 * <p>
 * For example, a specified location can have some metadata info,
 * so location transformer implementation may extract this metadata info,
 * and create {@link FileSelection} with the actual location.
 */
public interface FormatLocationTransformer {

  /**
   * Checks whether specified location can be transformed.
   *
   * @param location location to check
   * @return {@code true} if specified location can be transformed,
   * {@code false} otherwise
   */
  boolean canTransform(String location);

  /**
   * Transforms specified location and returns {@link FileSelection} instance with updated location.
   *
   * @param location         location to transform
   * @param selectionFactory file selection factory
   * @return {@link FileSelection} instance with updated location
   */
  FileSelection transform(String location, Function<String, FileSelection> selectionFactory);
}