Class JoinPath

java.lang.Object
io.micronaut.data.model.query.JoinPath
public class JoinPath extends Object
A join path represents a path, association and join type for performing a join with a query.
Since:
1.0.0
Author:
graemerocher

  • Constructor Details

    • JoinPath

      public JoinPath(String path, Association[] associationPath, Join.Type joinType, @Nullable String alias)
      Default constructor.
      Parameters:
      path - The path
      associationPath - The association
      joinType - The join type
      alias - The alias

  • Method Details

    • withAlias

      public JoinPath withAlias(@Nullable String alias)
      Create a new join path with an alias.
      Parameters:
      alias - The alias
      Returns:
      a new join path
      Since:
      4.9.0

    • getAlias

      public Optional<String> getAlias()
      The alias for the join path.
      Returns:
      The optional alias

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getAssociation

      public Association getAssociation()
      Returns:
      The association

    • getLeadingAssociations

      public List<Association> getLeadingAssociations()
      Returns:
      The association leading to this association

    • getAssociationPath

      public Association[] getAssociationPath()
      Returns:
      The association path.

    • getPath

      public String getPath()
      Returns:
      The association path

    • getJoinType

      public Join.Type getJoinType()
      Returns:
      The join type

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • of

      public static JoinPath of(Association... associationPath)
      Create a join path from the association path.
      Parameters:
      associationPath - The association path
      Returns:
      The join path

    • of

      public static JoinPath of(String alias, Association... associationPath)
      Create a join path from the association path.
      Parameters:
      alias - The alias to use
      associationPath - The association path
      Returns:
      The join path