Neo4j Community

org.neo4j.graphmatching
Class PatternRelationship

java.lang.Object
  extended by org.neo4j.graphmatching.AbstractPatternObject<Relationship>
      extended by org.neo4j.graphmatching.PatternRelationship

Deprecated.

@Deprecated
public class PatternRelationship
extends AbstractPatternObject<Relationship>

Represents a pattern for matching a Relationship.


Method Summary
 Direction getDirectionFrom(PatternNode fromNode)
          Deprecated. Get the direction in which relationships are discovered using this relationship pattern from the specified node.
 PatternNode getFirstNode()
          Deprecated. Get the first pattern node that this pattern relationship relates.
 PatternNode getOtherNode(PatternNode node)
          Deprecated. Get the PatternNode that this pattern relationship relates, that is not the specified node.
 PatternNode getSecondNode()
          Deprecated. Get the second pattern node that this pattern relationship relates.
 RelationshipType getType()
          Deprecated. Get the RelationshipType a relationship must have in order to match this pattern relationship.
 boolean isOptional()
          Deprecated. Does this pattern relationship represent a relationship that has to exist in the subgraph to consider the subgraph a match of the pattern, or is it an optional relationship.
 String toString()
          Deprecated.  
 
Methods inherited from class org.neo4j.graphmatching.AbstractPatternObject
addPropertyConstraint, getAssociation, getLabel, getPropertyConstraints, setAssociation, setLabel
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getOtherNode

public PatternNode getOtherNode(PatternNode node)
Deprecated. 
Get the PatternNode that this pattern relationship relates, that is not the specified node.

Parameters:
node - one of the PatternNodes this pattern relationship relates.
Returns:
the other pattern node.

getFirstNode

public PatternNode getFirstNode()
Deprecated. 
Get the first pattern node that this pattern relationship relates.

Returns:
the first pattern node.

getSecondNode

public PatternNode getSecondNode()
Deprecated. 
Get the second pattern node that this pattern relationship relates.

Returns:
the second pattern node.

isOptional

public boolean isOptional()
Deprecated. 
Does this pattern relationship represent a relationship that has to exist in the subgraph to consider the subgraph a match of the pattern, or is it an optional relationship.

Returns:
true if this pattern relationship represents an optional relationship, false if it represents a required relationship.

getType

public RelationshipType getType()
Deprecated. 
Get the RelationshipType a relationship must have in order to match this pattern relationship. Will return null if a relationship with any RelationshipType will match.

Returns:
the RelationshipType of this relationship pattern.

getDirectionFrom

public Direction getDirectionFrom(PatternNode fromNode)
Deprecated. 
Get the direction in which relationships are discovered using this relationship pattern from the specified node. May be outgoing, incoming, or both.

Parameters:
fromNode - the pattern node to find the direction of this pattern relationship from.
Returns:
the direction to discover relationships matching this pattern in.

toString

public String toString()
Deprecated. 
Overrides:
toString in class Object

Neo4j Community

Copyright © 2002-2014 The Neo4j Graph Database Project. All Rights Reserved.