SpecCompiler.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 gobblin.runtime.api;

import java.net.URI;
import java.util.Map;

import gobblin.instrumented.Instrumentable;

/***
 * Take in a logical {@link Spec} and compile corresponding materialized {@link Spec}s
 * and the mapping to {@link SpecExecutorInstance} that they can be run on.
 */
public interface SpecCompiler extends SpecCatalogListener, Instrumentable {
  /***
   * Take in a logical {@link Spec} and compile corresponding materialized {@link Spec}s
   * and the mapping to {@link SpecExecutorInstance} that they can be run on.
   * @param spec {@link Spec} to compile.
   * @return Map of materialized physical {@link Spec} and {@link SpecExecutorInstance}.
   */
  Map<Spec, SpecExecutorInstanceProducer> compileFlow(Spec spec);

  /***
   * Map of {@link Spec} URI and {@link TopologySpec} the {@link SpecCompiler}
   * is aware about.
   * @return Map of {@link Spec} URI and {@link TopologySpec}
   */
  Map<URI, TopologySpec> getTopologySpecMap();
}