uk.gov.gchq.gaffer.data.element.function.PropertiesTransformer Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2021 Crown Copyright
 *
 * 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 uk.gov.gchq.gaffer.data.element.function;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import uk.gov.gchq.gaffer.commonutil.ToStringBuilder;
import uk.gov.gchq.gaffer.data.element.Properties;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;
import uk.gov.gchq.koryphe.impl.function.Identity;
import uk.gov.gchq.koryphe.tuple.function.TupleAdaptedFunction;
import uk.gov.gchq.koryphe.tuple.function.TupleAdaptedFunctionComposite;

import java.io.Serializable;
import java.util.function.Function;

/**
 * A {@code PropertiesTransformer} is a {@link Function} which applies a series of
 * transformations to an {@link Properties} object.
 */
@Since("1.21.0")
@Summary("A Function which applies a series of transformations to a Properties object")
public class PropertiesTransformer extends TupleAdaptedFunctionComposite implements Serializable {
    private final PropertiesTuple propertiesTuple = new PropertiesTuple();

    public Properties apply(final Properties properties) {
        propertiesTuple.setProperties(properties);
        apply(propertiesTuple);
        return properties;
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }

        if (null == obj || getClass() != obj.getClass()) {
            return false;
        }

        final PropertiesTransformer that = (PropertiesTransformer) obj;

        return new EqualsBuilder()
                .appendSuper(super.equals(obj))
                .append(propertiesTuple, that.propertiesTuple)
                .isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder(47, 13)
                .appendSuper(super.hashCode())
                .append(propertiesTuple)
                .toHashCode();
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this)
                .append("propertiesTuple", propertiesTuple)
                .toString();
    }

    public static class Builder {
        private final PropertiesTransformer transformer;

        public Builder() {
            this(new PropertiesTransformer());
        }

        private Builder(final PropertiesTransformer transformer) {
            this.transformer = transformer;
        }

        public PropertiesTransformer.SelectedBuilder select(final String... selection) {
            final TupleAdaptedFunction current = new TupleAdaptedFunction<>();
            current.setSelection(selection);
            return new PropertiesTransformer.SelectedBuilder(transformer, current);
        }

        public PropertiesTransformer.ExecutedBuilder execute(final Function function) {
            final TupleAdaptedFunction current = new TupleAdaptedFunction<>();
            current.setSelection(new String[0]);
            current.setFunction(function);
            return new PropertiesTransformer.ExecutedBuilder(transformer, current);
        }

        public PropertiesTransformer build() {
            return transformer;
        }
    }

    public static final class SelectedBuilder {
        private final PropertiesTransformer transformer;
        private final TupleAdaptedFunction current;

        private SelectedBuilder(final PropertiesTransformer transformer, final TupleAdaptedFunction current) {
            this.transformer = transformer;
            this.current = current;
        }

        public PropertiesTransformer.ExecutedBuilder execute(final Function function) {
            current.setFunction(function);
            return new PropertiesTransformer.ExecutedBuilder(transformer, current);
        }

        public PropertiesTransformer.Builder project(final String... projection) {
            current.setFunction(new Identity());
            current.setProjection(projection);
            transformer.getComponents().add(current);
            return new PropertiesTransformer.Builder(transformer);
        }
    }

    public static final class ExecutedBuilder {
        private final PropertiesTransformer transformer;
        private final TupleAdaptedFunction current;

        private ExecutedBuilder(final PropertiesTransformer transformer, final TupleAdaptedFunction current) {
            this.transformer = transformer;
            this.current = current;
        }

        public PropertiesTransformer.SelectedBuilder select(final String... selection) {
            current.setProjection(current.getSelection().clone());
            transformer.getComponents().add(current);
            final TupleAdaptedFunction newCurrent = new TupleAdaptedFunction<>();
            newCurrent.setSelection(selection);
            return new PropertiesTransformer.SelectedBuilder(transformer, newCurrent);
        }

        public PropertiesTransformer.Builder project(final String... projection) {
            current.setProjection(projection);
            transformer.getComponents().add(current);
            return new PropertiesTransformer.Builder(transformer);
        }

        public PropertiesTransformer build() {
            current.setProjection(current.getSelection().clone());
            return transformer;
        }
    }
}