org.neo4j.kernel.impl.util.PathWrappingPathValue Maven / Gradle / Ivy

Go to download

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

Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.

There is a newer version: 5.25.1

Show newest version

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://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.kernel.impl.util;

import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Path;
import org.neo4j.graphdb.Relationship;
import org.neo4j.values.virtual.NodeValue;
import org.neo4j.values.virtual.PathValue;
import org.neo4j.values.virtual.RelationshipValue;

import static org.neo4j.memory.HeapEstimator.shallowSizeOfInstance;

public class PathWrappingPathValue extends PathValue
{
    static final long SHALLOW_SIZE = shallowSizeOfInstance( PathWrappingPathValue.class );

    private final Path path;

    PathWrappingPathValue( Path path )
    {
        this.path = path;
    }

    @Override
    public NodeValue startNode()
    {
        return (NodeValue) ValueUtils.wrapNodeEntity( path.startNode() );
    }

    @Override
    public NodeValue endNode()
    {
        return (NodeValue) ValueUtils.wrapNodeEntity( path.endNode() );
    }

    @Override
    public RelationshipValue lastRelationship()
    {
        return (RelationshipValue) ValueUtils.wrapRelationshipEntity( path.lastRelationship() );
    }

    @Override
    public NodeValue[] nodes()
    {
        int length = path.length() + 1;
        NodeValue[] values = new NodeValue[length];
        int i = 0;
        for ( Node node : path.nodes() )
        {
            values[i++] = (NodeValue) ValueUtils.wrapNodeEntity( node );
        }
        return values;
    }

    @Override
    public RelationshipValue[] relationships()
    {
        int length = path.length();
        RelationshipValue[] values = new RelationshipValue[length];
        int i = 0;
        for ( Relationship relationship : path.relationships() )
        {
            values[i++] = (RelationshipValue) ValueUtils.wrapRelationshipEntity( relationship );
        }
        return values;
    }

    public Path path()
    {
        return path;
    }

    @Override
    public long estimatedHeapUsage()
    {
        int length = path.length();

        // There are many different implementations of Path, so here we are left guessing.
        // We calculate some size for each node and relationship, but that will not include any potentially cached properties, labels, etc.
        return SHALLOW_SIZE
               + length * RelationshipEntityWrappingValue.SHALLOW_SIZE
               + (length + 1) * NodeEntityWrappingNodeValue.SHALLOW_SIZE;
    }
}