Enum Class BranchOrderingPolicies

java.lang.Object
java.lang.Enum<BranchOrderingPolicies>
org.neo4j.graphdb.traversal.BranchOrderingPolicies
All Implemented Interfaces:
Serializable, Comparable<BranchOrderingPolicies>, Constable, BranchOrderingPolicy

public enum BranchOrderingPolicies extends Enum<BranchOrderingPolicies> implements BranchOrderingPolicy
A catalog of convenient branch ordering policies.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    This `BranchOrderingPolicy` traverses breadth first, visiting all the leaf nodes of the current node before visiting their parents.
    This `BranchOrderingPolicy` traverses depth first, recursively traversing down the current nodes left subtree, then the right subtree before visiting the current node.
    This `BranchOrderingPolicy` traverses breadth first, visiting first the current node, then each of its children, before continuing to their children and so forth.
    This `BranchOrderingPolicy` traverses depth first, visiting the current node, then recursively traversing depth first the current nodes left subtree, before the right subtree.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from interface org.neo4j.graphdb.traversal.BranchOrderingPolicy

    create
  • Enum Constant Details

    • PREORDER_DEPTH_FIRST

      public static final BranchOrderingPolicies PREORDER_DEPTH_FIRST
      This `BranchOrderingPolicy` traverses depth first, visiting the current node, then recursively traversing depth first the current nodes left subtree, before the right subtree. The pre-order traversal is topologically sorted as parent nodes are processed before any of its child nodes are done.
    • POSTORDER_DEPTH_FIRST

      public static final BranchOrderingPolicies POSTORDER_DEPTH_FIRST
      This `BranchOrderingPolicy` traverses depth first, recursively traversing down the current nodes left subtree, then the right subtree before visiting the current node.
    • PREORDER_BREADTH_FIRST

      public static final BranchOrderingPolicies PREORDER_BREADTH_FIRST
      This `BranchOrderingPolicy` traverses breadth first, visiting first the current node, then each of its children, before continuing to their children and so forth. Providing a level order search.
    • POSTORDER_BREADTH_FIRST

      public static final BranchOrderingPolicies POSTORDER_BREADTH_FIRST
      This `BranchOrderingPolicy` traverses breadth first, visiting all the leaf nodes of the current node before visiting their parents. Effectively searching nodes in a reversed level order search to PREORDER_BREADTH_FIRST
  • Method Details

    • values

      public static BranchOrderingPolicies[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static BranchOrderingPolicies valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null