org.apache.metron.profiler.spark.reader.TelemetryReaders.java Source code

Introduction

Here is the source code for org.apache.metron.profiler.spark.reader.TelemetryReaders.java

Source

/*
 * 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.metron.profiler.spark.reader;

import org.apache.commons.lang3.StringUtils;
import org.apache.spark.sql.Dataset;
import org.apache.spark.sql.SparkSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.invoke.MethodHandles;
import java.util.Properties;
import java.util.function.Supplier;

/**
 * Allows a user to easily define the value of the property
 * {@link org.apache.metron.profiler.spark.BatchProfilerConfig#TELEMETRY_INPUT_READER}.
 */
public enum TelemetryReaders implements TelemetryReader {

    /**
     * A {@link TelemetryReader} that is able to consume text/json formatted data.
     *
     * <p>This serves as a configuration short-cut for users. The user only needs to define the
     * {@link org.apache.metron.profiler.spark.BatchProfilerConfig#TELEMETRY_INPUT_READER} property
     * with this value to consume text/json.
     */
    JSON(() -> new TextEncodedTelemetryReader("text")),

    /**
     * A {@link TelemetryReader} that is able to consume Apache ORC formatted data.
     *
     * <p>This serves as a configuration short-cut for users. The user only needs to define the
     * {@link org.apache.metron.profiler.spark.BatchProfilerConfig#TELEMETRY_INPUT_READER} property
     * with this value to consume Apache ORC formatted data.
     */
    ORC(() -> new ColumnEncodedTelemetryReader("org.apache.spark.sql.execution.datasources.orc")),

    /**
     * A {@link TelemetryReader} that is able to consume Apache Parquet formatted data.
     *
     * <p>This serves as a configuration short-cut for users. The user only needs to define the
     * {@link org.apache.metron.profiler.spark.BatchProfilerConfig#TELEMETRY_INPUT_READER} property
     * with this value to consume Apache Parquet formatted data.
     */
    PARQUET(() -> new ColumnEncodedTelemetryReader("parquet")),

    /**
     * Use a {@link TextEncodedTelemetryReader} by defining the property value as 'TEXT'.
     */
    TEXT(() -> new TextEncodedTelemetryReader()),

    /**
     * Use a {@link ColumnEncodedTelemetryReader} by defining the property value as 'COLUMNAR'.
     */
    COLUMNAR(() -> new ColumnEncodedTelemetryReader());

    static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

    private Supplier<TelemetryReader> supplier;

    private TelemetryReaders(Supplier<TelemetryReader> supplier) {
        this.supplier = supplier;
    }

    /**
     * Returns a {@link TelemetryReader} based on a property value.
     *
     * @param propertyValue The property value.
     * @return A {@link TelemetryReader}
     * @throws IllegalArgumentException If the property value is invalid.
     */
    public static TelemetryReader create(String propertyValue) {
        LOG.debug("Creating telemetry reader: telemetryReader={}", propertyValue);
        TelemetryReader reader = null;
        try {
            String key = StringUtils.upperCase(propertyValue);
            TelemetryReaders strategy = TelemetryReaders.valueOf(key);
            reader = strategy.supplier.get();

        } catch (IllegalArgumentException e) {
            LOG.error("Unexpected telemetry reader: telemetryReader=" + propertyValue, e);
            throw e;
        }

        return reader;
    }

    @Override
    public Dataset<String> read(SparkSession spark, Properties profilerProps, Properties readerProps) {
        return supplier.get().read(spark, profilerProps, readerProps);
    }
}