uk.gov.gchq.gaffer.data.graph.entity.EntityMap Maven / Gradle / Ivy

Go to download
/*
 * 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.data.graph.entity;

import com.google.common.collect.HashMultimap;
import com.google.common.collect.SetMultimap;

import uk.gov.gchq.gaffer.data.element.Entity;

import java.util.Collections;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * An {@code EntityMap} is used to store the contents of a graph in memory in a
 * format which can easily be interrogated.
 */
public class EntityMap {

    /**
     * Backing object used to store the EntityMap representation.
     */
    private final SetMultimap backingMap = HashMultimap.create();

    /**
     * Add an entity to this EntityMap instance.
     *
     * @param vertex the vertex associated with the entity
     * @param entity the entity object
     *
     * @return {@code true} if the entity was successfully added, otherwise
     * {@code false}
     */
    public boolean putEntity(final Object vertex, final Entity entity) {
        return backingMap.put(vertex, entity);
    }

    /**
     * Add a {@link Set} of entities to this EntityMap instance.
     *
     * @param vertex the vertex associated with the entity
     * @param entities the set of entities
     *
     * @return {@code true} if the entity was successfully added, otherwise
     * {@code false}
     */
    public boolean putEntities(final Object vertex, final Set entities) {
        return backingMap.putAll(vertex, entities);
    }

    /**
     * Get the entries in the EntityMap which match the provided vertex.
     *
     * @param vertex the vertex
     *
     * @return the {@link Set} of edge objects relating to the specified vertex
     */
    public Set get(final Object vertex) {
        return backingMap.get(vertex);
    }

    /**
     * Get all vertices referenced in this EntityMap.
     *
     * @return a {@link Set} containing all of the vertices
     */
    public Set