org.neo4j.cypher.internal.runtime.PropertyTokensResolver Maven / Gradle / Ivy

Go to download
/*
 * 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.cypher.internal.runtime;

import static org.apache.commons.lang3.ArrayUtils.contains;

import org.neo4j.token.api.TokenConstants;

/**
 * Resolves tokens for a set of property names.
 */
public interface PropertyTokensResolver {
    /**
     * Resolve any unresolved property tokens.
     *
     * NOTE! Needs to be called for every row, because tokens might be created during a query.
     */
    void populate(DbAccess db);

    /** Returns property names */
    String[] names();

    /** Returns resolved tokens in the same order as names(). Call populate() before accessing this method. */
    int[] tokens();

    /**
     * Returns a new token resolver.
     */
    static PropertyTokensResolver property(String[] names, int[] tokens) {
        assert names.length == tokens.length;

        if (contains(tokens, TokenConstants.NO_TOKEN)) {
            return new IncompletePropertyTokenResolverProperty(names, tokens);
        } else {
            return new CompletePropertyTokenResolverProperty(names, tokens);
        }
    }
}

class CompletePropertyTokenResolverProperty implements PropertyTokensResolver {
    private final String[] names;
    private final int[] tokens;

    CompletePropertyTokenResolverProperty(String[] names, int[] tokens) {
        assert !contains(tokens, TokenConstants.NO_TOKEN);
        this.names = names;
        this.tokens = tokens;
    }

    @Override
    public void populate(DbAccess db) {}

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

    @Override
    public int[] tokens() {
        return tokens;
    }
}

class IncompletePropertyTokenResolverProperty implements PropertyTokensResolver {
    private final String[] names;
    private final int[] tokens;
    private boolean isComplete;

    IncompletePropertyTokenResolverProperty(String[] names, int[] tokens) {
        this.names = names;
        this.tokens = tokens;
    }

    @Override
    public void populate(DbAccess db) {
        if (isComplete) {
            return;
        }

        boolean newIsComplete = true;
        final var size = names.length;
        for (int i = 0; i < size; ++i) {
            final var token = tokens[i];

            if (token == TokenConstants.NO_TOKEN) {
                final int newToken = db.propertyKey(names[i]);
                tokens[i] = newToken;
                newIsComplete = newIsComplete && newToken != TokenConstants.NO_TOKEN;
            }
        }
        isComplete = newIsComplete;
    }

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

    @Override
    public int[] tokens() {
        return tokens;
    }
}