uk.gov.gchq.gaffer.operation.impl.generate.GenerateElements Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of operation Show documentation
There is a newer version: 2.3.1
/*
 * Copyright 2016-2020 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.operation.impl.generate;

import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.core.type.TypeReference;

import uk.gov.gchq.gaffer.commonutil.Required;
import uk.gov.gchq.gaffer.data.element.Element;
import uk.gov.gchq.gaffer.operation.Operation;
import uk.gov.gchq.gaffer.operation.io.InputOutput;
import uk.gov.gchq.gaffer.operation.io.MultiInput;
import uk.gov.gchq.gaffer.operation.serialisation.TypeReferenceImpl;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;

import java.util.Map;
import java.util.function.Function;

/**
 * An {@code GenerateElements} operation generates an {@link Iterable} of
 * {@link uk.gov.gchq.gaffer.data.element.Element}s from an {@link Iterable} of objects.
 *
 * @param  the type of objects in the input iterable.
 * @see uk.gov.gchq.gaffer.operation.impl.generate.GenerateElements.Builder
 */
@JsonPropertyOrder(value = {"class", "input", "elementGenerator"}, alphabetic = true)
@Since("1.0.0")
@Summary("Generates elements from objects using provided generators")
public class GenerateElements implements
        InputOutput, Iterable>,
        MultiInput {
    @Required
    private Function, Iterable> elementGenerator;
    private Iterable input;
    private Map options;

    public GenerateElements() {
    }

    /**
     * Constructs a {@code GenerateElements} operation with a {@link uk.gov.gchq.gaffer.data.generator.ElementGenerator} to
     * convert objects into {@link uk.gov.gchq.gaffer.data.element.Element}s. This constructor takes in no input objects and could
     * by used in a operation chain where the objects are provided by the previous operation.
     *
     * @param elementGenerator an {@link uk.gov.gchq.gaffer.data.generator.ElementGenerator} to convert objects into
     *                         {@link uk.gov.gchq.gaffer.data.element.Element}s
     */
    public GenerateElements(final Function, Iterable> elementGenerator) {
        this.elementGenerator = elementGenerator;
    }

    /**
     * @return an {@link uk.gov.gchq.gaffer.data.generator.ElementGenerator} to convert objects into
     * {@link uk.gov.gchq.gaffer.data.element.Element}s
     */
    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
    public Function, Iterable> getElementGenerator() {
        return elementGenerator;
    }

    /**
     * Only used for json serialisation
     *
     * @param elementGenerator an {@link uk.gov.gchq.gaffer.data.generator.ElementGenerator} to convert objects into
     *                         {@link uk.gov.gchq.gaffer.data.element.Element}s
     */
    void setElementGenerator(final Function, Iterable> elementGenerator) {
        this.elementGenerator = elementGenerator;
    }

    @Override
    public Iterable getInput() {
        return input;
    }

    @Override
    public void setInput(final Iterable input) {
        this.input = input;
    }

    @Override
    public TypeReference> getOutputTypeReference() {
        return new TypeReferenceImpl.IterableElement();
    }

    @Override
    public GenerateElements shallowClone() {
        return new GenerateElements.Builder()
                .generator(elementGenerator)
                .input(input)
                .options(options)
                .build();
    }

    @Override
    public Map getOptions() {
        return options;
    }

    @Override
    public void setOptions(final Map options) {
        this.options = options;
    }

    public static class Builder extends Operation.BaseBuilder, Builder>
            implements InputOutput.Builder, Iterable, Iterable, Builder>,
            MultiInput.Builder, OBJ, Builder> {
        public Builder() {
            super(new GenerateElements<>());
        }

        /**
         * @param generator the {@link uk.gov.gchq.gaffer.data.generator.ElementGenerator} to set on the operation
         * @return this Builder
         */
        public Builder generator(final Function, Iterable> generator) {
            _getOp().setElementGenerator(generator);
            return _self();
        }
    }
}