org.vertexium.search.SearchIndex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertexium-core Show documentation
There is a newer version: 4.10.0
package org.vertexium.search;

import org.vertexium.*;
import org.vertexium.mutation.AdditionalExtendedDataVisibilityAddMutation;
import org.vertexium.mutation.AdditionalExtendedDataVisibilityDeleteMutation;
import org.vertexium.mutation.ExistingElementMutation;
import org.vertexium.mutation.ExtendedDataMutation;
import org.vertexium.query.*;

import java.util.Collection;
import java.util.Set;

public interface SearchIndex {
    void addElement(
        Graph graph,
        Element element,
        Set additionalVisibilities,
        Set additionalVisibilitiesToDelete,
        Authorizations authorizations
    );

     void updateElement(Graph graph, ExistingElementMutation mutation, Authorizations authorizations);

    void deleteElement(Graph graph, ElementId elementId, Authorizations authorizations);

    default void deleteElements(Graph graph, Iterable elementIds, Authorizations authorizations) {
        for (ElementId elementId : elementIds) {
            deleteElement(graph, elementId, authorizations);
        }
    }

    void markElementHidden(Graph graph, Element element, Visibility visibility, Authorizations authorizations);

    void markElementVisible(
        Graph graph,
        ElementLocation elementLocation,
        Visibility visibility,
        Authorizations authorizations
    );

    void markPropertyHidden(
        Graph graph,
        ElementLocation elementLocation,
        Property property,
        Visibility visibility,
        Authorizations authorizations
    );

    void markPropertyVisible(
        Graph graph,
        ElementLocation elementLocation,
        Property property,
        Visibility visibility,
        Authorizations authorizations
    );

    /**
     * Default delete property simply calls deleteProperty in a loop. It is up to the SearchIndex implementation to decide
     * if a collective method can be made more efficient
     */
    default void deleteProperties(
        Graph graph,
        Element element,
        Collection propertyList,
        Authorizations authorizations
    ) {
        propertyList.forEach(p -> deleteProperty(graph, element, p, authorizations));
    }

    void deleteProperty(
        Graph graph,
        Element element,
        PropertyDescriptor property,
        Authorizations authorizations
    );

    void addElements(Graph graph, Iterable elements, Authorizations authorizations);

    GraphQuery queryGraph(Graph graph, String queryString, Authorizations authorizations);

    MultiVertexQuery queryGraph(Graph graph, String[] vertexIds, String queryString, Authorizations authorizations);

    VertexQuery queryVertex(Graph graph, Vertex vertex, String queryString, Authorizations authorizations);

    Query queryExtendedData(Graph graph, Element element, String tableName, String queryString, Authorizations authorizations);

    SimilarToGraphQuery querySimilarTo(Graph graph, String[] fields, String text, Authorizations authorizations);

    void flush(Graph graph);

    void shutdown();

    void clearCache();

    boolean isFieldBoostSupported();

    void truncate(Graph graph);

    void drop(Graph graph);

    SearchIndexSecurityGranularity getSearchIndexSecurityGranularity();

    boolean isQuerySimilarToTextSupported();

    boolean isFieldLevelSecuritySupported();

     void alterElementVisibility(
        Graph graph,
        ExistingElementMutation elementMutation,
        Visibility oldVisibility,
        Visibility newVisibility,
        Authorizations authorizations
    );

    void addElementExtendedData(
        Graph graph,
        ElementLocation elementLocation,
        Iterable extendedDatas,
        Iterable additionalExtendedDataVisibilities,
        Iterable additionalExtendedDataVisibilityDeletes,
        Authorizations authorizations
    );

    void addExtendedData(
        Graph graph,
        ElementLocation elementLocation,
        Iterable extendedDatas,
        Authorizations authorizations
    );

    void deleteExtendedData(Graph graph, ExtendedDataRowId extendedDataRowId, Authorizations authorizations);

    void deleteExtendedData(
        Graph graph,
        ElementLocation elementLocation,
        String tableName,
        String row,
        String columnName,
        String key,
        Visibility visibility,
        Authorizations authorizations
    );
}