org.neo4j.common.TokenNameLookup Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-common Show documentation

Non-domain infrastructure code that is common to many Neo4j components.

There is a newer version: 2025.03.0

/*
 * 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.common;

import java.util.function.IntFunction;

/**
 * Lookup of names from token ids. Tokens are mostly referred to by ids throughout several abstractions.
 * Sometimes token names are required, this is a way to lookup names in those cases.
 */
public interface TokenNameLookup {
    /**
     * @param labelId id of label to get name for.
     * @return name of label token with given id.
     */
    String labelGetName(int labelId);

    /**
     * @param relationshipTypeId id of relationship type to get name for.
     * @return name of relationship type token with given id.
     */
    String relationshipTypeGetName(int relationshipTypeId);

    /**
     * @param propertyKeyId id of property key to get name for.
     * @return name of property key token with given id.
     */
    String propertyKeyGetName(int propertyKeyId);

    default String[] entityTokensGetNames(EntityType type, int[] entityTokenIds) {
        IntFunction mapper =
                switch (type) {
                    case NODE -> this::labelGetName;
                    case RELATIONSHIP -> this::relationshipTypeGetName;
                };
        String[] tokenNames = new String[entityTokenIds.length];
        for (int i = 0; i < entityTokenIds.length; i++) {
            tokenNames[i] = mapper.apply(entityTokenIds[i]);
        }
        return tokenNames;
    }
}