Module io.ebean.core
Package io.ebeaninternal.server.el

Interface ElPropertyDeploy

All Superinterfaces:
SpiQueryManyJoin
All Known Subinterfaces:
ElPropertyValue
All Known Implementing Classes:
BeanFkeyProperty, BeanProperty, BeanPropertyAssoc, BeanPropertyAssocMany, BeanPropertyAssocOne, BeanPropertyIdClass, BeanPropertyJsonBasic, BeanPropertyJsonMapper, BeanPropertyOrderColumn, BeanPropertySimpleCollection, ElPropertyChain
public interface ElPropertyDeploy extends SpiQueryManyJoin
Used to parse expressions in queries (where, orderBy etc).

Maps an expression to deployment information such as the DB column and elPrefix/elPlaceHolder is used determine joins and set place holders for table alias'.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ROOT_ELPREFIX
    This is the elPrefix for all root level properties.

  • Method Summary

    Modifier and Type
    Method
    Description
    BeanProperty
    beanProperty()
    Return the underlying bean property.
    boolean
    containsFormulaWithJoin()
    Return true if the property is a formula with a join clause.
    boolean
    containsMany()
    Return true if there is a property on the path that is a many property.
    boolean
    containsManySince(String sinceProperty)
    Return true if there is a property is on the path after sinceProperty that is a 'many' property.
    String
    dbColumn()
    Return the deployment db column for this property.
    String
    elName()
    The ElPrefix plus name.
    String
    elPlaceholder(boolean encrypted)
    Return the place holder in the form of ${elPrefix}dbColumn.
    String
    elPrefix()
    Return the prefix path of the property.
    default String
    fetchOrderBy()
    Order by clause defined via mapping on the ToMany property.
    int
    fetchPreference()
    Return the fetch preference.
    boolean
    isAggregation()
    Return true if this is an aggregation property.
    String
    name()
    Return the name of the property.
    default String
    path()
    The full path of the many property to include in the query via join.

    Methods inherited from interface io.ebeaninternal.api.SpiQueryManyJoin

    idNullOr

  • Field Details

    • ROOT_ELPREFIX

      static final String ROOT_ELPREFIX
      This is the elPrefix for all root level properties.
      See Also:

  • Method Details

    • containsFormulaWithJoin

      boolean containsFormulaWithJoin()
      Return true if the property is a formula with a join clause.

    • containsMany

      boolean containsMany()
      Return true if there is a property on the path that is a many property.

    • containsManySince

      boolean containsManySince(String sinceProperty)
      Return true if there is a property is on the path after sinceProperty that is a 'many' property.

    • elPrefix

      String elPrefix()
      Return the prefix path of the property.

      This is use to determine joins required to support this property.

    • elPlaceholder

      String elPlaceholder(boolean encrypted)
      Return the place holder in the form of ${elPrefix}dbColumn.

      The ${elPrefix} is replaced by the appropriate table alias.

    • name

      String name()
      Return the name of the property.

    • elName

      String elName()
      The ElPrefix plus name.

    • dbColumn

      String dbColumn()
      Return the deployment db column for this property.

    • beanProperty

      BeanProperty beanProperty()
      Return the underlying bean property.

    • isAggregation

      boolean isAggregation()
      Return true if this is an aggregation property.

    • fetchPreference

      int fetchPreference()
      Return the fetch preference. This can be used to control which ToMany relationship is left as a 'join' and which get converted to query join.

    • path

      default String path()
      Description copied from interface: SpiQueryManyJoin
      The full path of the many property to include in the query via join.
      Specified by:
      path in interface SpiQueryManyJoin

    • fetchOrderBy

      default String fetchOrderBy()
      Description copied from interface: SpiQueryManyJoin
      Order by clause defined via mapping on the ToMany property.
      Specified by:
      fetchOrderBy in interface SpiQueryManyJoin