Package org.apache.tinkerpop.gremlin.process.traversal.step

Interface SideEffectCapable<S,E>

All Superinterfaces:
Generating<S,E>
All Known Implementing Classes:
AggregateStep, GroupCountSideEffectStep, GroupSideEffectStep, ProfileSideEffectStep, SubgraphStep, TreeSideEffectStep
public interface SideEffectCapable<S,E> extends Generating<S,E>
A SideEffectCapable step stores a side-effect data structure accessible by a side-effect key. All SideEffectCapable steps are Generating in that they may require a post-processing function once the side-effect data has been aggregated.
Author:
Marko A. Rodriguez (http://markorodriguez.com)

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getSideEffectKey()
    The side-effect key of the step.

    Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Generating

    generateFinalResult

  • Method Details

    • getSideEffectKey

      String getSideEffectKey()
      The side-effect key of the step.
      Returns:
      the side-effect key