uk.gov.gchq.gaffer.operation.impl.Count 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 2017-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;

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

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;

/**
 * A {@code Count} operation counts how many items there are in the provided {@link Iterable}.
 *
 * @see Count.Builder
 */
@JsonPropertyOrder(value = {"class", "input"}, alphabetic = true)
@Since("1.0.0")
@Summary("Counts the number of items")
public class Count implements
        InputOutput, Long>,
        MultiInput {
    private Iterable input;
    private Map options;

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

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

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

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

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

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

    public static final class Builder
            extends Operation.BaseBuilder, Builder>
            implements InputOutput.Builder, Iterable, Long, Builder>,
            MultiInput.Builder, T, Builder> {
        public Builder() {
            super(new Count<>());
        }
    }
}