ExpansionSourceImpl.java

package org.neo4j.kernel.impl.traversal;

import java.util.Collections;
import java.util.Iterator;

import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Path;
import org.neo4j.graphdb.Relationship;
import org.neo4j.graphdb.RelationshipExpander;
import org.neo4j.graphdb.traversal.ExpansionSource;
import org.neo4j.graphdb.traversal.Position;
import org.neo4j.kernel.impl.traversal.TraverserImpl.TraverserIterator;

class ExpansionSourceImpl implements ExpansionSource, Position
{
    private final ExpansionSource parent;
    private final Node source;
    private Iterator<Relationship> relationships;
    private final Relationship howIGotHere;
    private final int depth;
    final TraverserIterator traverser;
    private Path path;

    /*
     * For expansion sources for all nodes except the start node
     */
    ExpansionSourceImpl( TraverserIterator traverser, ExpansionSource parent, int depth,
            Node source, RelationshipExpander expander, Relationship toHere )
    {
        this.traverser = traverser;
        this.parent = parent;
        this.source = source;
        this.howIGotHere = toHere;
        this.depth = depth;
        expandRelationships( true );
    }
    
    /*
     * For the start node expansion source
     */
    ExpansionSourceImpl( TraverserIterator  traverser, Node source,
            RelationshipExpander expander )
    {
        this.traverser = traverser;
        this.parent = null;
        this.source = source;
        this.howIGotHere = null;
        this.depth = 0;
    }

    protected void expandRelationships( boolean doChecks )
    {
        boolean okToExpand = !doChecks || traverser.shouldExpandBeyond( this );
        relationships = okToExpand ?
                traverser.description.expander.expand( source ).iterator() :
                Collections.<Relationship>emptyList().iterator();
    }
    
    protected boolean hasExpandedRelationships()
    {
        return relationships != null;
    }

    public ExpansionSource next()
    {
        while ( relationships.hasNext() )
        {
            Relationship relationship = relationships.next();
            if ( relationship.equals( howIGotHere ) )
            {
                continue;
            }
            Node node = relationship.getOtherNode( source );
            ExpansionSource next = new ExpansionSourceImpl( traverser, this, depth + 1, node,
                    traverser.description.expander, relationship );
            if ( traverser.okToProceed( next ) )
            {
                return next;
            }
        }
        return null;
    }

    public Position position()
    {
        return this;
    }

    public int depth()
    {
        return depth;
    }

    public Relationship relationship()
    {
        return howIGotHere;
    }

    public Node node()
    {
        return source;
    }
    
    public ExpansionSource parent()
    {
        return this.parent;
    }

    public boolean atStartNode()
    {
        return this.depth == 0;
    }

    public Relationship lastRelationship()
    {
        return this.howIGotHere;
    }

    public Path path()
    {
        if ( this.path == null )
        {
            this.path = new TraversalPath( this );
        }
        return this.path;
    }
}