uk.gov.gchq.gaffer.spark.operation.graphframe.GetGraphFrameOfElements Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spark-library 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.spark.operation.graphframe;

import com.fasterxml.jackson.core.type.TypeReference;
import org.graphframes.GraphFrame;

import uk.gov.gchq.gaffer.commonutil.Required;
import uk.gov.gchq.gaffer.data.element.id.DirectedType;
import uk.gov.gchq.gaffer.data.elementdefinition.view.View;
import uk.gov.gchq.gaffer.operation.Operation;
import uk.gov.gchq.gaffer.operation.graph.GraphFilters;
import uk.gov.gchq.gaffer.operation.io.Output;
import uk.gov.gchq.gaffer.spark.operation.dataframe.converter.property.Converter;
import uk.gov.gchq.gaffer.spark.serialisation.TypeReferenceSparkImpl;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;
import uk.gov.gchq.koryphe.ValidationResult;

import java.util.List;
import java.util.Map;

/**
 * An {@code Operation} that returns an Apache Spark {@code GraphFrame} (i.e. an
 * abstraction over a {@link org.apache.spark.sql.Dataset} of {@link
 * org.apache.spark.sql.Row}s) consisting of the {@code Elements}s converted to
 * rows.
 * 
 * This GraphFrame object can be used as the basis for a number of graph
 * processing queries.
 *
 * @see uk.gov.gchq.gaffer.spark.operation.dataframe.GetDataFrameOfElements
 */
@Since("1.3.0")
@Summary("Gets a GraphFrame of elements")
public class GetGraphFrameOfElements implements
        Output,
        GraphFilters {

    private List converters;
    private Map options;
    @Required
    private View view;
    private DirectedType directedType;

    public GetGraphFrameOfElements() {
    }

    @Override
    public TypeReference getOutputTypeReference() {
        return new TypeReferenceSparkImpl.GraphFrame();
    }

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

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

    public List getConverters() {
        return converters;
    }

    public void setConverters(final List converters) {
        this.converters = converters;
    }

    @Override
    public View getView() {
        return view;
    }

    @Override
    public void setView(final View view) {
        this.view = view;
    }

    @Override
    public DirectedType getDirectedType() {
        return directedType;
    }

    @Override
    public void setDirectedType(final DirectedType directedType) {
        this.directedType = directedType;
    }

    @Override
    public ValidationResult validate() {
        final ValidationResult result = Output.super.validate();

        if (result.isValid() && !view.hasEdges() && !view.hasEntities()) {
            result.addError("Cannot create a GraphFrame unless the View contains edges or entities.");
        }

        return result;
    }

    @Override
    public GetGraphFrameOfElements shallowClone() {
        return new GetGraphFrameOfElements.Builder()
                .converters(converters)
                .options(options)
                .directedType(directedType)
                .view(view)
                .build();
    }

    public static class Builder extends Operation.BaseBuilder
            implements Output.Builder,
            GraphFilters.Builder {
        public Builder() {
            super(new GetGraphFrameOfElements());
        }

        public Builder converters(final List converters) {
            _getOp().setConverters(converters);
            return _self();
        }
    }
}