org.neo4j.batchimport.api.ReadBehaviour Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-import-api Show documentation
Neo4j Import API
There is a newer version: 5.25.1
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.batchimport.api;

import static java.lang.String.format;

import org.neo4j.token.TokenHolders;

public interface ReadBehaviour {
    ReadBehaviour INCLUSIVE_STRICT = new ReadBehaviour.Adapter() {
        @Override
        public void error(String format, Object... parameters) {
            throw new RuntimeException(format(format, parameters));
        }

        @Override
        public void error(Throwable e, String format, Object... parameters) {
            if (e instanceof RuntimeException) {
                throw (RuntimeException) e;
            }
            throw new RuntimeException(format(format, parameters), e);
        }
    };

    boolean shouldIncludeNode(long nodeId, String[] labels);

    default long translateNodeId(long nodeId) {
        return nodeId;
    }

    boolean shouldIncludeRelationship(long startNodeId, long endNodeId, long relationshipId, String relationshipType);

    default long translateRelationshipId(long relationshipId) {
        return relationshipId;
    }

    default long translateRelationshipStartNodeId(long relationshipId, long startNodeId, long endNodeId) {
        return startNodeId;
    }

    default long translateRelationshipEndNodeId(long relationshipId, long startNodeId, long endNodeId) {
        return endNodeId;
    }

    String[] filterLabels(String[] labels);

    PropertyInclusion shouldIncludeNodeProperty(String propertyKey, String[] labels, boolean completeMatch);

    PropertyInclusion shouldIncludeRelationshipProperty(String propertyKey, String relationshipType);

    // statistics

    void unused();

    void removed();

    void error(String format, Object... parameters);

    void error(Throwable e, String format, Object... parameters);

    TokenHolders decorateTokenHolders(TokenHolders actual);

    enum PropertyInclusion {
        /**
         * Indicates that the property and it's values should both be included once read
         */
        INCLUDE,
        /**
         * Indicates that neither the property nor it's values should be included
         */
        EXCLUDE,
        /**
         * Indicates that the only property key should be included once read
         */
        KEY_ONLY
    }

    class Adapter implements ReadBehaviour {
        @Override
        public boolean shouldIncludeNode(long nodeId, String[] labels) {
            return true;
        }

        @Override
        public boolean shouldIncludeRelationship(
                long startNodeId, long endNodeId, long relationshipId, String relationshipType) {
            return true;
        }

        @Override
        public String[] filterLabels(String[] labels) {
            return labels;
        }

        @Override
        public PropertyInclusion shouldIncludeNodeProperty(String propertyKey, String[] labels, boolean completeMatch) {
            return PropertyInclusion.INCLUDE;
        }

        @Override
        public PropertyInclusion shouldIncludeRelationshipProperty(String propertyKey, String relationshipType) {
            return PropertyInclusion.INCLUDE;
        }

        @Override
        public void unused() {}

        @Override
        public void removed() {}

        @Override
        public void error(String format, Object... parameters) {}

        @Override
        public void error(Throwable e, String format, Object... parameters) {}

        @Override
        public TokenHolders decorateTokenHolders(TokenHolders actual) {
            return actual;
        }
    }
}