io.cdap.plugin.batch.sink.BatchWritableSink Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-plugins Show documentation
There is a newer version: 2.12.3
/*
 * Copyright © 2015-2019 Cask Data, Inc.
 *
 * Licensed 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 io.cdap.plugin.batch.sink;

import com.google.common.base.Preconditions;
import com.google.common.collect.Maps;
import io.cdap.cdap.api.data.batch.Output;
import io.cdap.cdap.api.dataset.DatasetManagementException;
import io.cdap.cdap.api.dataset.DatasetProperties;
import io.cdap.cdap.etl.api.PipelineConfigurer;
import io.cdap.cdap.etl.api.batch.BatchSink;
import io.cdap.cdap.etl.api.batch.BatchSinkContext;
import io.cdap.plugin.common.BatchReadableWritableConfig;
import io.cdap.plugin.common.Properties;

import java.util.Map;

/**
 * An abstract Sink for CDAP Datasets that are batch writable, which means they can be used as output of a
 * mapreduce job. Extending subclasses must provide implementation for {@link BatchWritableSink} which should return the
 * properties used by the sink.
 *
 * @param  the type of input object to the sink
 * @param  the type of key the sink outputs
 * @param  the type of value the sink outputs
 */
public abstract class BatchWritableSink extends BatchSink {
  private final BatchReadableWritableConfig batchReadableWritableConfig;

  protected BatchWritableSink(BatchReadableWritableConfig batchReadableWritableConfig) {
    this.batchReadableWritableConfig = batchReadableWritableConfig;
  }

  @Override
  public void configurePipeline(PipelineConfigurer pipelineConfigurer) {
    // null check for tests, as macro fields map and properties are null in test cases
    if (!batchReadableWritableConfig.containsMacro(Properties.BatchReadableWritable.NAME)) {
      String datasetName = getProperties().get(Properties.BatchReadableWritable.NAME);
      Preconditions.checkArgument(datasetName != null && !datasetName.isEmpty(), "Dataset name must be given.");
      String datasetType = getProperties().get(Properties.BatchReadableWritable.TYPE);
      Preconditions.checkArgument(datasetType != null && !datasetType.isEmpty(), "Dataset type must be given.");

      Map properties = Maps.newHashMap(getProperties());
      properties.remove(Properties.BatchReadableWritable.NAME);
      properties.remove(Properties.BatchReadableWritable.TYPE);

      if (!shouldSkipCreateAtConfigure()) {
        pipelineConfigurer.createDataset(datasetName, datasetType,
                                         DatasetProperties.builder().addAll(properties).build());
      }
    }
  }

  protected boolean shouldSkipCreateAtConfigure() {
    return false;
  }

  /**
   * An abstract method which the subclass should override to provide their dataset types
   */
  protected abstract Map getProperties();

  @Override
  public void prepareRun(BatchSinkContext context) throws DatasetManagementException {
    Map properties = getProperties();
    if (!context.datasetExists(properties.get(Properties.BatchReadableWritable.NAME))) {
      context.createDataset(properties.get(Properties.BatchReadableWritable.NAME),
                            properties.get(Properties.BatchReadableWritable.TYPE),
                            DatasetProperties.builder().addAll(properties).build());
    }
    context.addOutput(Output.ofDataset(properties.get(Properties.BatchReadableWritable.NAME)));
  }
}