org.vertexium.FetchHints 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;

import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableSet;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

public class FetchHints {
    private final boolean includeAllProperties;
    private final ImmutableSet propertyNamesToInclude;
    private final boolean includeAllPropertyMetadata;
    private final ImmutableSet metadataKeysToInclude;
    private final boolean includeHidden;
    private final boolean includeAllEdgeRefs;
    private final boolean includeOutEdgeRefs;
    private final boolean includeInEdgeRefs;
    private final ImmutableSet edgeLabelsOfEdgeRefsToInclude;
    private final boolean includeEdgeLabelsAndCounts;
    private final boolean includeExtendedDataTableNames;
    private final boolean ignoreAdditionalVisibilities;
    private final boolean includePreviousMetadata;

    public static final FetchHints NONE = new FetchHintsBuilder()
        .build();

    public static final FetchHints PROPERTIES_AND_METADATA = new FetchHintsBuilder()
        .setIncludeAllProperties(true)
        .setIncludeAllPropertyMetadata(true)
        .build();

    public static final FetchHints ALL = new FetchHintsBuilder()
        .setIncludeAllProperties(true)
        .setIncludeAllPropertyMetadata(true)
        .setIncludeAllEdgeRefs(true)
        .setIncludeExtendedDataTableNames(true)
        .build();

    public static final FetchHints ALL_INCLUDING_HIDDEN = new FetchHintsBuilder()
        .setIncludeAllProperties(true)
        .setIncludeAllPropertyMetadata(true)
        .setIncludeAllEdgeRefs(true)
        .setIncludeExtendedDataTableNames(true)
        .setIncludeHidden(true)
        .build();

    public static final FetchHints EDGE_REFS = new FetchHintsBuilder()
        .setIncludeAllEdgeRefs(true)
        .build();

    public static final FetchHints EDGE_LABELS = new FetchHintsBuilder()
        .setIncludeEdgeLabelsAndCounts(true)
        .build();

    FetchHints(
        boolean includeAllProperties,
        ImmutableSet propertyNamesToInclude,
        boolean includeAllPropertyMetadata,
        ImmutableSet metadataKeysToInclude,
        boolean includeHidden,
        boolean includeAllEdgeRefs,
        boolean includeOutEdgeRefs,
        boolean includeInEdgeRefs,
        ImmutableSet edgeLabelsOfEdgeRefsToInclude,
        boolean includeEdgeLabelsAndCounts,
        boolean includeExtendedDataTableNames,
        boolean ignoreAdditionalVisibilities,
        boolean includePreviousMetadata
    ) {
        this.includeAllProperties = includeAllProperties;
        this.propertyNamesToInclude = includeAllProperties ? null : propertyNamesToInclude;
        this.includeAllPropertyMetadata = includeAllPropertyMetadata;
        this.metadataKeysToInclude = includeAllPropertyMetadata ? null : metadataKeysToInclude;
        this.includeHidden = includeHidden;
        this.includeAllEdgeRefs = includeAllEdgeRefs;
        this.includeOutEdgeRefs = includeOutEdgeRefs;
        this.includeInEdgeRefs = includeInEdgeRefs;
        this.edgeLabelsOfEdgeRefsToInclude = includeAllEdgeRefs ? null : edgeLabelsOfEdgeRefsToInclude;
        this.includeEdgeLabelsAndCounts = includeEdgeLabelsAndCounts;
        this.includeExtendedDataTableNames = includeExtendedDataTableNames;
        this.ignoreAdditionalVisibilities = ignoreAdditionalVisibilities;
        this.includePreviousMetadata = includePreviousMetadata;
    }

    public boolean isIncludeAllProperties() {
        return includeAllProperties;
    }

    public ImmutableSet getPropertyNamesToInclude() {
        return propertyNamesToInclude;
    }

    public boolean isIncludeAllPropertyMetadata() {
        return includeAllPropertyMetadata;
    }

    public ImmutableSet getMetadataKeysToInclude() {
        return metadataKeysToInclude;
    }

    public boolean isIncludeHidden() {
        return includeHidden;
    }

    public boolean isIncludeAllEdgeRefs() {
        return includeAllEdgeRefs;
    }

    public boolean isIncludeOutEdgeRefs() {
        return includeOutEdgeRefs;
    }

    public boolean isIncludeInEdgeRefs() {
        return includeInEdgeRefs;
    }

    public ImmutableSet getEdgeLabelsOfEdgeRefsToInclude() {
        return edgeLabelsOfEdgeRefsToInclude;
    }

    public boolean isIncludeEdgeLabelsAndCounts() {
        return includeEdgeLabelsAndCounts;
    }

    public boolean isIncludeExtendedDataTableNames() {
        return includeExtendedDataTableNames;
    }

    public boolean isIgnoreAdditionalVisibilities() {
        return ignoreAdditionalVisibilities;
    }

    public boolean isIncludePreviousMetadata() {
        return includePreviousMetadata;
    }

    public boolean isIncludePropertyMetadata() {
        return isIncludeAllPropertyMetadata() || (getMetadataKeysToInclude() != null && getMetadataKeysToInclude().size() > 0);
    }

    public boolean isIncludeProperties() {
        return isIncludeAllProperties() || (getPropertyNamesToInclude() != null && getPropertyNamesToInclude().size() > 0);
    }

    public boolean isIncludePropertyAndMetadata(String propertyName) {
        return isIncludeProperty(propertyName) && isIncludeAllPropertyMetadata();
    }

    public boolean isIncludeProperty(String propertyName) {
        if (isIncludeAllProperties()) {
            return true;
        }
        if (getPropertyNamesToInclude() != null && getPropertyNamesToInclude().contains(propertyName)) {
            return true;
        }
        return false;
    }

    public boolean isIncludeMetadata(String metadataKey) {
        if (isIncludeAllPropertyMetadata()) {
            return true;
        }
        if (getMetadataKeysToInclude() != null && getMetadataKeysToInclude().contains(metadataKey)) {
            return true;
        }
        return false;
    }

    public boolean isIncludeEdgeRefLabel(String label) {
        if (isIncludeAllEdgeRefs()) {
            return true;
        }
        if (getEdgeLabelsOfEdgeRefsToInclude() != null) {
            if (getEdgeLabelsOfEdgeRefsToInclude().contains(label)) {
                return true;
            } else {
                return false;
            }
        }
        if (isIncludeOutEdgeRefs() || isIncludeInEdgeRefs()) {
            return true;
        }
        return false;
    }

    public boolean isIncludeEdgeRefs() {
        return isIncludeAllEdgeRefs() || isIncludeInEdgeRefs() || isIncludeOutEdgeRefs()
            || (getEdgeLabelsOfEdgeRefsToInclude() != null && getEdgeLabelsOfEdgeRefsToInclude().size() > 0);
    }

    public boolean hasEdgeLabelsOfEdgeRefsToInclude() {
        return getEdgeLabelsOfEdgeRefsToInclude() != null && getEdgeLabelsOfEdgeRefsToInclude().size() > 0;
    }

    public void validateHasEdgeFetchHints(Direction direction, String... labels) {
        if (!isIncludeEdgeRefs()) {
            throw new VertexiumMissingFetchHintException(this, "edgeRefs");
        }
        switch (direction) {
            case OUT:
                if (!isIncludeOutEdgeRefs() && !hasEdgeLabelsOfEdgeRefsToInclude()) {
                    throw new VertexiumMissingFetchHintException(this, "outEdgeRefs or edgeLabels");
                }
                break;
            case IN:
                if (!isIncludeInEdgeRefs() && !hasEdgeLabelsOfEdgeRefsToInclude()) {
                    throw new VertexiumMissingFetchHintException(this, "inEdgeRefs or edgeLabels");
                }
                break;
        }

        if (labels != null
            && labels.length != 0
            && !isIncludeAllEdgeRefs()
            && !isIncludeInEdgeRefs()
            && !isIncludeOutEdgeRefs()
            && (getEdgeLabelsOfEdgeRefsToInclude() != null && getEdgeLabelsOfEdgeRefsToInclude().size() > 0)) {
            for (String label : labels) {
                if (!getEdgeLabelsOfEdgeRefsToInclude().contains(label)) {
                    throw new VertexiumMissingFetchHintException(this, "edgeLabel:" + label);
                }
            }
        }
    }

    @Override
    public String toString() {
        return "FetchHints{" +
            "includeAllProperties=" + includeAllProperties +
            ", propertyNamesToInclude=" + setToString(propertyNamesToInclude) +
            ", includeAllPropertyMetadata=" + includeAllPropertyMetadata +
            ", metadataKeysToInclude=" + setToString(metadataKeysToInclude) +
            ", includeHidden=" + includeHidden +
            ", includeAllEdgeRefs=" + includeAllEdgeRefs +
            ", edgeLabelsOfEdgeRefsToInclude=" + setToString(edgeLabelsOfEdgeRefsToInclude) +
            ", includeEdgeLabelsAndCounts=" + includeEdgeLabelsAndCounts +
            ", includeExtendedDataTableNames=" + includeExtendedDataTableNames +
            ", ignoreAdditionalVisibilities=" + ignoreAdditionalVisibilities +
            ", includePreviousMetadata=" + includePreviousMetadata +
            '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        FetchHints that = (FetchHints) o;
        return includeAllProperties == that.includeAllProperties
            && includeAllPropertyMetadata == that.includeAllPropertyMetadata
            && includeHidden == that.includeHidden
            && includeAllEdgeRefs == that.includeAllEdgeRefs
            && includeOutEdgeRefs == that.includeOutEdgeRefs
            && includeInEdgeRefs == that.includeInEdgeRefs
            && includeEdgeLabelsAndCounts == that.includeEdgeLabelsAndCounts
            && includeExtendedDataTableNames == that.includeExtendedDataTableNames
            && ignoreAdditionalVisibilities == that.ignoreAdditionalVisibilities
            && includePreviousMetadata == that.includePreviousMetadata
            && Objects.equals(propertyNamesToInclude, that.propertyNamesToInclude)
            && Objects.equals(metadataKeysToInclude, that.metadataKeysToInclude)
            && Objects.equals(edgeLabelsOfEdgeRefsToInclude, that.edgeLabelsOfEdgeRefsToInclude);
    }

    @Override
    public int hashCode() {
        return Objects.hash(
            includeAllProperties,
            propertyNamesToInclude,
            includeAllPropertyMetadata,
            metadataKeysToInclude,
            includeHidden,
            includeAllEdgeRefs,
            includeOutEdgeRefs,
            includeInEdgeRefs,
            edgeLabelsOfEdgeRefsToInclude,
            includeEdgeLabelsAndCounts,
            includeExtendedDataTableNames,
            ignoreAdditionalVisibilities,
            includePreviousMetadata
        );
    }

    private String setToString(ImmutableSet set) {
        return set == null ? "" : Joiner.on(",").join(set);
    }

    public static FetchHintsBuilder builder() {
        return new FetchHintsBuilder();
    }

    public static FetchHintsBuilder builder(FetchHints fetchHints) {
        return new FetchHintsBuilder(fetchHints);
    }

    public void assertPropertyIncluded(String name) {
        if (isIncludeProperty(name)) {
            return;
        }
        throw new VertexiumMissingFetchHintException(this, "property:" + name);
    }

    public void assertMetadataIncluded(String key) {
        if (isIncludeMetadata(key)) {
            return;
        }
        throw new VertexiumMissingFetchHintException(this, "metadata:" + key);
    }

    /**
     * Tests that these fetch hints have at least the requested fetch hints
     *
     * @return true if this has all or more fetch hints then those passed in.
     */
    public boolean hasFetchHints(FetchHints fetchHints) {
        if (fetchHints.ignoreAdditionalVisibilities != this.ignoreAdditionalVisibilities) {
            return false;
        }
        if (fetchHints.includeHidden != this.includeHidden) {
            return false;
        }

        if (fetchHints.includeEdgeLabelsAndCounts && !this.includeEdgeLabelsAndCounts) {
            return false;
        }

        if (fetchHints.includeAllEdgeRefs && !this.includeAllEdgeRefs) {
            return false;
        }

        if (fetchHints.includeOutEdgeRefs && !(this.includeOutEdgeRefs || this.includeAllEdgeRefs)) {
            return false;
        }

        if (fetchHints.includeInEdgeRefs && !(this.includeInEdgeRefs || this.includeAllEdgeRefs)) {
            return false;
        }

        if (fetchHints.includeExtendedDataTableNames && !this.includeExtendedDataTableNames) {
            return false;
        }

        if (fetchHints.includeAllPropertyMetadata && !this.includeAllPropertyMetadata) {
            return false;
        }

        if (fetchHints.includeAllProperties && !this.includeAllProperties) {
            return false;
        }

        if (fetchHints.edgeLabelsOfEdgeRefsToInclude != null
            && fetchHints.edgeLabelsOfEdgeRefsToInclude.size() > 0
            && !isEdgeLabelsOfEdgeRefsIncluded(fetchHints.edgeLabelsOfEdgeRefsToInclude)) {
            return false;
        }

        if (fetchHints.propertyNamesToInclude != null
            && fetchHints.propertyNamesToInclude.size() > 0
            && !isPropertyNamesIncluded(fetchHints.propertyNamesToInclude)) {
            return false;
        }

        if (fetchHints.metadataKeysToInclude != null
            && fetchHints.metadataKeysToInclude.size() > 0
            && !isMetadataKeysIncluded(fetchHints.metadataKeysToInclude)) {
            return false;
        }

        return true;
    }

    private boolean isMetadataKeysIncluded(ImmutableSet metadataKeysToInclude) {
        if (includeAllPropertyMetadata) {
            return true;
        }
        if (this.metadataKeysToInclude == null) {
            return false;
        }
        for (String metadataKey : metadataKeysToInclude) {
            if (!this.metadataKeysToInclude.contains(metadataKey)) {
                return false;
            }
        }
        return true;
    }

    private boolean isPropertyNamesIncluded(ImmutableSet propertyNamesToInclude) {
        if (includeAllProperties) {
            return true;
        }
        if (this.propertyNamesToInclude == null) {
            return false;
        }
        for (String propertyName : propertyNamesToInclude) {
            if (!this.propertyNamesToInclude.contains(propertyName)) {
                return false;
            }
        }
        return true;
    }

    private boolean isEdgeLabelsOfEdgeRefsIncluded(ImmutableSet edgeLabelsOfEdgeRefsToInclude) {
        if (includeAllEdgeRefs) {
            return true;
        }
        if (this.edgeLabelsOfEdgeRefsToInclude == null) {
            return false;
        }
        for (String edgeLabel : edgeLabelsOfEdgeRefsToInclude) {
            if (!this.edgeLabelsOfEdgeRefsToInclude.contains(edgeLabel)) {
                return false;
            }
        }
        return true;
    }

    public static FetchHints union(FetchHints... fetchHints) {
        return union(Arrays.asList(fetchHints));
    }

    public static FetchHints union(Iterable fetchHints) {
        boolean includeAllProperties = false;
        Set propertyNamesToInclude = null;
        boolean includeAllPropertyMetadata = false;
        Set metadataKeysToInclude = null;
        Boolean includeHidden = null;
        boolean includeAllEdgeRefs = false;
        boolean includeOutEdgeRefs = false;
        boolean includeInEdgeRefs = false;
        boolean includeEdgeLabelsAndCounts = false;
        boolean includeExtendedDataTableNames = false;
        Boolean ignoreAdditionalVisibilities = null;
        Boolean includePreviousMetadata = null;
        Set edgeLabelsOfEdgeRefsToInclude = null;

        for (FetchHints fetchHint : fetchHints) {
            if (fetchHint.isIncludeAllProperties()) {
                includeAllProperties = true;
            }
            if (fetchHint.isIncludeAllPropertyMetadata()) {
                includeAllPropertyMetadata = true;
            }
            if (fetchHint.isIncludeAllEdgeRefs()) {
                includeAllEdgeRefs = true;
            }
            if (fetchHint.isIncludeOutEdgeRefs()) {
                includeOutEdgeRefs = true;
            }
            if (fetchHint.isIncludeInEdgeRefs()) {
                includeInEdgeRefs = true;
            }
            if (fetchHint.isIncludeEdgeLabelsAndCounts()) {
                includeEdgeLabelsAndCounts = true;
            }
            if (fetchHint.isIncludeExtendedDataTableNames()) {
                includeExtendedDataTableNames = true;
            }

            if (includeHidden != null && includeHidden != fetchHint.isIncludeHidden()) {
                throw new VertexiumException("Incompatible fetch hints to combine (includeHidden).");
            }
            includeHidden = fetchHint.isIncludeHidden();

            if (ignoreAdditionalVisibilities != null && ignoreAdditionalVisibilities != fetchHint.isIgnoreAdditionalVisibilities()) {
                throw new VertexiumException("Incompatible fetch hints to combine (ignoreAdditionalVisibilities).");
            }
            ignoreAdditionalVisibilities = fetchHint.isIgnoreAdditionalVisibilities();

            if (includePreviousMetadata != null && includePreviousMetadata != fetchHint.isIncludePreviousMetadata()) {
                throw new VertexiumException("Incompatible fetch hints to combine (includePreviousMetadata).");
            }
            includePreviousMetadata = fetchHint.isIncludePreviousMetadata();

            if (fetchHint.getPropertyNamesToInclude() != null) {
                if (propertyNamesToInclude == null) {
                    propertyNamesToInclude = new HashSet<>(fetchHint.getPropertyNamesToInclude());
                } else {
                    propertyNamesToInclude.addAll(fetchHint.getPropertyNamesToInclude());
                }
            }

            if (fetchHint.getMetadataKeysToInclude() != null) {
                if (metadataKeysToInclude == null) {
                    metadataKeysToInclude = new HashSet<>(fetchHint.getMetadataKeysToInclude());
                } else {
                    metadataKeysToInclude.addAll(fetchHint.getMetadataKeysToInclude());
                }
            }

            if (fetchHint.getEdgeLabelsOfEdgeRefsToInclude() != null) {
                if (edgeLabelsOfEdgeRefsToInclude == null) {
                    edgeLabelsOfEdgeRefsToInclude = new HashSet<>(fetchHint.getEdgeLabelsOfEdgeRefsToInclude());
                } else {
                    edgeLabelsOfEdgeRefsToInclude.addAll(fetchHint.getEdgeLabelsOfEdgeRefsToInclude());
                }
            }
        }

        return new FetchHints(
            includeAllProperties,
            propertyNamesToInclude == null ? null : ImmutableSet.copyOf(propertyNamesToInclude),
            includeAllPropertyMetadata,
            metadataKeysToInclude == null ? null : ImmutableSet.copyOf(metadataKeysToInclude),
            includeHidden == null ? false : includeHidden,
            includeAllEdgeRefs,
            includeOutEdgeRefs,
            includeInEdgeRefs,
            edgeLabelsOfEdgeRefsToInclude == null ? null : ImmutableSet.copyOf(edgeLabelsOfEdgeRefsToInclude),
            includeEdgeLabelsAndCounts,
            includeExtendedDataTableNames,
            ignoreAdditionalVisibilities == null ? false : ignoreAdditionalVisibilities,
            includePreviousMetadata == null ? false : includePreviousMetadata
        );
    }
}