Package com.sap.olingo.jpa.metadata.core.edm.mapper.api

Interface JPAPath

All Superinterfaces:
Comparable<JPAPath>
public interface JPAPath extends Comparable<JPAPath>
A path within an JPA entity to an attribute.
Author:
Oliver Grande

  • Field Details

  • Method Details

    • getAlias

      String getAlias()
      External unique identifier for a path. Two path are seen as equal if they have the same alias
      Returns:

    • getDBFieldName

      String getDBFieldName()
      Returns:
      the name of the data base table/view column of the leaf of a path

    • getLeaf

      JPAAttribute getLeaf()
      Returns:
      the last element of a path

    • getPath

      List<JPAElement> getPath()
      Returns:
      all elements of a path

    • ignore

      boolean ignore()
      Returns:
      true if the leaf of the path shall be ignored

    • isPartOfGroups

      boolean isPartOfGroups​(List<String> groups)
      Returns true in case the leaf of the path is part of one of the provided groups or none of the path elements is annotated with EdmVisibleFor. The leaf is seen as a member of a group in case its EdmVisibleFor annotation contains the group or the groups is mentioned at any other element of the path.
      Note: Based on this inheritance of EdmVisibleFor a path is seen as inconsistent if multiple elements are annotated and the difference of the set of groups is not empty.
      Returns: