ai.grakn.engine.task.postprocessing.IndexStorage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grakn-engine Show documentation

There is a newer version: 1.4.3

/*
 * Grakn - A Distributed Semantic Database
 * Copyright (C) 2016-2018 Grakn Labs Limited
 *
 * Grakn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Grakn is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Grakn. If not, see .
 */

package ai.grakn.engine.task.postprocessing;

import ai.grakn.Keyspace;
import ai.grakn.concept.ConceptId;

import javax.annotation.Nullable;
import java.util.Set;

/**
 * 
 *     Stores a list of indices and vertex ids representing those indices which need to be post processed
 * 
 *
 * @author lolski
 */

public interface IndexStorage {
    /**
     * Add an index to the list of indices which needs to be post processed
     */
    void addIndex(Keyspace keyspace, String index, Set conceptIds);

    /**
     * Gets and removes the next index to post process
     */
    @Nullable
    String popIndex(Keyspace keyspace);

    /**
     * Gets and removes all the ids which we need to post process
     */
    Set popIds(Keyspace keyspace, String index);
}