Interface CorrelationBuilder


public interface CorrelationBuilder
A builder for correlating a basis with an entity class.
Since:
1.2.0
Author:
Christian Beikov
  • Method Details

    • getService

      <T> T getService​(Class<T> serviceClass)
      Returns the service or null if none is available.
      Type Parameters:
      T - The service type
      Parameters:
      serviceClass - The type of the service
      Returns:
      The service or null
    • getCorrelationFromProvider

      FromProvider getCorrelationFromProvider()
      Returns the correlation from provider.
      Returns:
      The correlation from provider
      Since:
      1.3.0
    • getCorrelationAlias

      String getCorrelationAlias()
      Generates a meaningful alias that can be used for the correlation.
      Returns:
      The generated alias
    • correlate

      JoinOnBuilder<CorrelationQueryBuilder> correlate​(Class<?> entityClass)
      Correlates a basis with the given entity class.
      Parameters:
      entityClass - The entity class which should be correlated
      Returns:
      The restriction builder for the correlation predicate
    • correlate

      JoinOnBuilder<CorrelationQueryBuilder> correlate​(javax.persistence.metamodel.EntityType<?> entityType)
      Correlates a basis with the given entity type.
      Parameters:
      entityType - The entity type which should be correlated
      Returns:
      The restriction builder for the correlation predicate
      Since:
      1.3.0
    • correlate

      JoinOnBuilder<CorrelationQueryBuilder> correlate​(String correlationPath)
      Correlates a path expression.
      Parameters:
      correlationPath - The path to correlate
      Returns:
      The restriction builder for the correlation predicate
      Since:
      1.5.0