Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Neo4j Community
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.neo4j.graphmatching
Class PatternMatch

    java.lang.Object
      org.neo4j.graphmatching.PatternMatch

    public class PatternMatch

extends Object

Represents one match found by the `PatternMatcher`. The match is itself a graph which looks like the pattern fed to the `PatternMatcher`

Method Summary
`Iterable<PatternElement>` | `getElements()` Get the matched elements in this match.
`Node` | `getNodeFor(PatternNode node)`
`Relationship` | `getRelationshipFor(PatternRelationship rel)`
`static PatternMatch` | `merge(Iterable<PatternMatch> matches)` Used to merge two matches.
`static PatternMatch` | `merge(PatternMatch... matches)` Used to merge matches.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getNodeFor

    public Node getNodeFor(PatternNode node)

  Parameters:
    `node` - the `PatternNode` to get the `Node` for.
  Returns:
    the actual `Node` for this particular match, represented by `node` in the pattern

### getRelationshipFor

    public Relationship getRelationshipFor(PatternRelationship rel)

  Parameters:
    `rel` - the `PatternRelationship` to get the `Relationship` for.
  Returns:
    the actual `Relationship` for this particular match, represented by `rel` in the pattern

### getElements

    public Iterable<PatternElement> getElements()

  Get the matched elements in this match.

  Returns:
    an iterable over the matched elements in this match instance.

### merge

    public static PatternMatch merge(Iterable<PatternMatch> matches)

  Used to merge two matches. An example is to merge in an "optional" subgraph match into a match.

  Parameters:
    `matches` - the matches to merge together.
  Returns:
    the merged matches as one match.

### merge

    public static PatternMatch merge(PatternMatch... matches)

  Used to merge matches. An example is to merge in an "optional" subgraph match into a match.

  Parameters:
    `matches` - the matches to merge together.
  Returns:
    the merged matches as one match.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Neo4j Community
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2011 The Neo4j Graph Database Project. All Rights Reserved.