uk.gov.gchq.gaffer.function.processor.Processor.java Source code

Introduction

Here is the source code for uk.gov.gchq.gaffer.function.processor.Processor.java

Source

/*
 * Copyright 2016 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.function.processor;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;
import uk.gov.gchq.gaffer.function.context.FunctionContext;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

/**
 * A <code>Processor</code> executes {@link uk.gov.gchq.gaffer.function.Function}s against {@link uk.gov.gchq.gaffer.function.Tuple}s. It
 * uses {@link uk.gov.gchq.gaffer.function.context.FunctionContext}s to bind functions to data in tuples.
 *
 * @param <R> The type of reference used by tuples.
 * @param <C> The type of {@link FunctionContext} to use.
 */
public abstract class Processor<R, C extends FunctionContext<?>> implements Cloneable {
    protected List<C> functions;

    /**
     * Default constructor - used for serialisation.
     */
    public Processor() {
    }

    /**
     * Create a <code>Processor</code> that executes the given {@link uk.gov.gchq.gaffer.function.context.FunctionContext}s.
     *
     * @param functions {@link uk.gov.gchq.gaffer.function.context.FunctionContext}s to execute.
     */
    public Processor(final Collection<C> functions) {
        addFunctions(functions);
    }

    /**
     * Add a {@link uk.gov.gchq.gaffer.function.context.FunctionContext} to be executed by this <code>Processor</code>.
     *
     * @param functionContext {@link uk.gov.gchq.gaffer.function.context.FunctionContext} to be executed.
     */
    public void addFunction(final C functionContext) {
        if (functions == null) {
            functions = new LinkedList<>();
        }
        functions.add(functionContext);
    }

    /**
     * Add a collection of {@link uk.gov.gchq.gaffer.function.context.FunctionContext}s to be executed by this
     * <code>Processor</code>.
     *
     * @param functionContext {@link uk.gov.gchq.gaffer.function.context.FunctionContext}s to be executed.
     */
    public void addFunctions(final Collection<C> functionContext) {
        if (functions == null) {
            functions = new LinkedList<>();
        }
        functions.addAll(functionContext);
    }

    /**
     * @return {@link uk.gov.gchq.gaffer.function.context.FunctionContext}s to be executed by this <code>Processor</code>.
     */
    public List<C> getFunctions() {
        return functions;
    }

    /**
     * @return Deep copy of this <code>Processor</code>.
     */
    @SuppressWarnings("CloneDoesntDeclareCloneNotSupportedException")
    public abstract Processor<R, C> clone();

    /**
     * @param functions {@link uk.gov.gchq.gaffer.function.context.FunctionContext}s to be executed by this <code>Processor</code>.
     */
    void setFunctions(final List<C> functions) {
        this.functions = functions;
    }

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

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

        final Processor<?, ?> processor = (Processor<?, ?>) o;

        return new EqualsBuilder().append(functions, processor.functions).isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder(17, 37).append(functions).toHashCode();
    }

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