PatternRelationship.java

package org.neo4j.util.matching;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.neo4j.api.core.Direction;
import org.neo4j.api.core.RelationshipType;

public class PatternRelationship
{
	private RelationshipType type;
	private PatternNode firstNode;
	private PatternNode secondNode;
	private boolean optional;
	private boolean isMarked = false;
    private boolean anyType = false;
    private Set<String> propertiesExist = new HashSet<String>();
    private Map<String,Object[]> propertiesEqual = 
        new HashMap<String,Object[]>();
    
    PatternRelationship( PatternNode firstNode,
        PatternNode secondNode )
    {
        this( firstNode, secondNode, false );
    }

    PatternRelationship( RelationshipType type, PatternNode firstNode,
		PatternNode secondNode )
	{
		this( type, firstNode, secondNode, false );
	}
	
    PatternRelationship( PatternNode firstNode, 
        PatternNode secondNode, boolean optional )
    {
        this.anyType = true;
        this.firstNode = firstNode;
        this.secondNode = secondNode;
        this.optional = optional;
    }
    
	PatternRelationship( RelationshipType type, PatternNode firstNode, 
		PatternNode secondNode, boolean optional )
	{
		this.type = type;
		this.firstNode = firstNode;
		this.secondNode = secondNode;
		this.optional = optional;
	}
	
    boolean anyRelType()
    {
        return anyType;
    }
    
	public PatternNode getOtherNode( PatternNode node )
	{
		if ( node == firstNode )
		{
			return secondNode;
		}
		if ( node == secondNode )
		{
			return firstNode;
		}
		throw new RuntimeException( "Node[" + node + 
			"] not in this relationship" );
	}
	
	public PatternNode getFirstNode()
	{
		return firstNode;
	}
	
	public PatternNode getSecondNode()
	{
		return secondNode;
	}
	
	public boolean isOptional()
	{
		return optional;
	}
	
	void mark()
	{
		isMarked = true;
	}
	
	void unMark()
	{
		isMarked = false;
	}
	
	boolean isMarked()
	{
		return isMarked;
	}
	
	public RelationshipType getType()
	{
		return type;
	}
	
	public void disconnect()
	{
		getFirstNode().removeRelationship( this, optional );
		getSecondNode().removeRelationship( this, optional );
		firstNode = null;
		secondNode = null;
	}
	
	public Direction getDirectionFrom( PatternNode fromNode )
    {
	    if ( fromNode.equals( firstNode ) )
	    {
	    	return Direction.OUTGOING;
	    }
	    if ( fromNode.equals( secondNode ) )
	    {
	    	return Direction.INCOMING;
	    }
	    throw new RuntimeException( fromNode + " not in " + this );
    }	
	
	@Override
	public String toString()
	{
		return type + ":" + optional;
	}

    public void addPropertyExistConstraint( String propertyName )
    {
        this.propertiesExist.add( propertyName );
    }
    
    public void addPropertyEqualConstraint( String propertyName,
        Object... atLeastOneOfTheseValues )
    {
        assert atLeastOneOfTheseValues != null &&
            atLeastOneOfTheseValues.length > 0;
        this.propertiesEqual.put( propertyName, atLeastOneOfTheseValues );
    }
    
    Set<String> getPropertiesExist()
    {
        return this.propertiesExist;
    }
    
    Set<String> getPropertiesEqual()
    {
        return this.propertiesEqual.keySet();
    }
    
    Object[] getPropertyValue( String propertyName )
    {
        return this.propertiesEqual.get( propertyName );
    }
}