org.jnosql.artemis.graph.GraphWorkflow Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of artemis-graph Show documentation

Eclipse JNoSQL mapping layer, Artemis, to Graph API

The newest version!

/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.artemis.graph;


import org.apache.tinkerpop.gremlin.structure.Vertex;

import java.util.function.UnaryOperator;

/**
 * This implementation defines the workflow to insert an Entity on {@link Vertex}.
 * The default implementation follows:
 *  {@link GraphEventPersistManager#firePreEntity(Object)}
 *  {@link GraphEventPersistManager#firePreGraphEntity(Object)}
 *  {@link GraphEventPersistManager#firePreGraph(Vertex)}
 *  Database alteration
 *  {@link GraphEventPersistManager#firePostGraph(Vertex)}
 *  {@link GraphEventPersistManager#firePostEntity(Object)}
 *  {@link GraphEventPersistManager#firePostGraphEntity(Object)}
 */
public interface GraphWorkflow {

    /**
     * Executes the workflow to do an interaction on a graph database.
     *
     * @param entity the entity to be saved
     * @param action the alteration to be executed on database
     * @param     the entity type
     * @return after the workflow the the entity response
     */
     T flow(T entity, UnaryOperator action);
}