com.amazon.ionhiveserde.configuration.SerDeProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ion-hive3-serde Show documentation
An Apache Hive SerDe (short for serializer/deserializer) for the Ion file format.
There is a newer version: 1.2.0
/*
 * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * or in the "license" file accompanying this file. This file 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 com.amazon.ionhiveserde.configuration;

import com.amazon.ion.IonStruct;
import com.amazon.ion.IonType;
import com.amazon.ionhiveserde.IonHiveSerDe;
import com.amazon.ionhiveserde.configuration.source.JavaPropertiesAdapter;
import com.amazon.ionhiveserde.configuration.source.RawConfiguration;
import com.amazon.ionpathextraction.PathExtractor;
import java.util.List;
import java.util.Properties;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hive.serde2.typeinfo.TypeInfo;

/**
 * Encapsulates all SerDe properties.
 */
public class SerDeProperties extends BaseProperties {

    private final EncodingConfig encodingConfig;
    private final FailOnOverflowConfig failOnOverflowConfig;
    private final PathExtractionConfig pathExtractionConfig;
    private final SerializeAsConfig serializeAsConfig;
    private final SerializeNullConfig serializeNullConfig;
    private final TimestampOffsetConfig timestampOffsetConfig;

    /**
     * Constructor.
     *
     * @param properties {@link Properties} passed to {@link IonHiveSerDe#initialize(Configuration, Properties)}.
     * @param columnNames table column names in the same order as types
     * @param columnTypes table column types in the same order as names
     */
    public SerDeProperties(final Properties properties,
                    final List columnNames,
                    final List columnTypes) {
        this(new JavaPropertiesAdapter(properties), columnNames, columnTypes);
    }

    private SerDeProperties(final RawConfiguration configuration,
                            final List columnNames,
                            final List columnTypes) {
        super(configuration);

        encodingConfig = new EncodingConfig(configuration);
        failOnOverflowConfig = new FailOnOverflowConfig(configuration, columnNames);
        pathExtractionConfig = new PathExtractionConfig(configuration, columnNames);
        serializeAsConfig = new SerializeAsConfig(configuration, columnTypes);
        serializeNullConfig = new SerializeNullConfig(configuration);
        timestampOffsetConfig = new TimestampOffsetConfig(configuration);
    }

    /**
     * @see EncodingConfig#getEncoding()
     * @return configured {@link IonEncoding}.
     */
    public IonEncoding getEncoding() {
        return encodingConfig.getEncoding();
    }


    /**
     * @see TimestampOffsetConfig#getTimestampOffsetInMinutes()
     * @return configured offset in minutes.
     */
    public int getTimestampOffsetInMinutes() {
        return timestampOffsetConfig.getTimestampOffsetInMinutes();
    }

    /**
     * @see SerializeNullConfig#getSerializeNull()
     * @return configured {@link SerializeNullStrategy}.
     */
    public SerializeNullStrategy getSerializeNull() {
        return serializeNullConfig.getSerializeNull();
    }


    /**
     * @see FailOnOverflowConfig#failOnOverflowFor(String)
     * @param columnName table column name.
     * @return true if it must fail on overflow, false otherwise.
     */
    public boolean failOnOverflowFor(final String columnName) {
        return failOnOverflowConfig.failOnOverflowFor(columnName);
    }

    /**
     * @see SerializeAsConfig#serializationIonTypeFor(int)
     * @param index table column index.
     * @return IonType to use when serializing values of the respective column.
     */
    public IonType serializationIonTypeFor(final int index) {
        return serializeAsConfig.serializationIonTypeFor(index);
    }

    /**
     * @see PathExtractionConfig#pathExtractor()
     * @return configured {@link PathExtractor}
     */
    public PathExtractor pathExtractor() {
        return pathExtractionConfig.pathExtractor();
    }

    /**
     * @return Boolean that indicates if the path extractor is configured case sensitive
     */
    public Boolean pathExtractorCaseSensitivity() {
        return pathExtractionConfig.getCaseSensitivity();
    }
}