Package com.blazebit.persistence.view.metamodel

Interface ViewMetamodel

public interface ViewMetamodel
Provides access to the metamodel of the entity views.
Since:
1.0.0
Author:
Christian Beikov

  • Method Summary

    Modifier and Type Method Description
    <X> FlatViewType<X> flatView​(Class<X> clazz)
    Returns the metamodel embeddable entity view type representing the embeddable entity view specified by the given class or null.
    <X> FlatViewType<X> flatViewOrError​(Class<X> clazz)
    Returns the metamodel embeddable entity view type representing the embeddable entity view specified by the given class or throws an exception.
    Set<FlatViewType<?>> getFlatViews()
    Returns the metamodel embeddableentity views.
    Set<ManagedViewType<?>> getManagedViews()
    Returns the metamodel managed entity views.
    Set<ViewType<?>> getViews()
    Returns the metamodel entity views.
    <X> ManagedViewType<X> managedView​(Class<X> clazz)
    Returns the metamodel managed entity view type representing the managed entity view specified by the given class or null.
    <X> ManagedViewType<X> managedViewOrError​(Class<X> clazz)
    Returns the metamodel managed entity view type representing the managed entity view specified by the given class or throws an exception.
    <X> ViewType<X> view​(Class<X> clazz)
    Returns the metamodel entity view type representing the entity view specified by the given class or null.
    <X> ViewType<X> viewOrError​(Class<X> clazz)
    Returns the metamodel entity view type representing the entity view specified by the given class or throws an exception.

  • Method Details

    • view

      <X> ViewType<X> view​(Class<X> clazz)
      Returns the metamodel entity view type representing the entity view specified by the given class or null.
      Type Parameters:
      X - The type of the given entity view class
      Parameters:
      clazz - The entity view class for which the view type should be returned
      Returns:
      The metamodel entity view type or null

    • viewOrError

      <X> ViewType<X> viewOrError​(Class<X> clazz)
      Returns the metamodel entity view type representing the entity view specified by the given class or throws an exception.
      Type Parameters:
      X - The type of the given entity view class
      Parameters:
      clazz - The entity view class for which the view type should be returned
      Returns:
      The metamodel entity view type
      Throws:
      IllegalArgumentException - if the class is not a view type
      Since:
      1.5.0

    • getViews

      Set<ViewType<?>> getViews()
      Returns the metamodel entity views.
      Returns:
      The metamodel entity views

    • managedView

      <X> ManagedViewType<X> managedView​(Class<X> clazz)
      Returns the metamodel managed entity view type representing the managed entity view specified by the given class or null.
      Type Parameters:
      X - The type of the given entity view class
      Parameters:
      clazz - The entity view class for which the view type should be returned
      Returns:
      The metamodel entity view type or null

    • managedViewOrError

      <X> ManagedViewType<X> managedViewOrError​(Class<X> clazz)
      Returns the metamodel managed entity view type representing the managed entity view specified by the given class or throws an exception.
      Type Parameters:
      X - The type of the given entity view class
      Parameters:
      clazz - The entity view class for which the view type should be returned
      Returns:
      The metamodel entity view type
      Throws:
      IllegalArgumentException - if the class is not a view type
      Since:
      1.5.0

    • getManagedViews

      Set<ManagedViewType<?>> getManagedViews()
      Returns the metamodel managed entity views.
      Returns:
      The metamodel managed entity views

    • flatView

      <X> FlatViewType<X> flatView​(Class<X> clazz)
      Returns the metamodel embeddable entity view type representing the embeddable entity view specified by the given class or null.
      Type Parameters:
      X - The type of the given entity view class
      Parameters:
      clazz - The entity view class for which the view type should be returned
      Returns:
      The metamodel entity view type or null

    • flatViewOrError

      <X> FlatViewType<X> flatViewOrError​(Class<X> clazz)
      Returns the metamodel embeddable entity view type representing the embeddable entity view specified by the given class or throws an exception.
      Type Parameters:
      X - The type of the given entity view class
      Parameters:
      clazz - The entity view class for which the view type should be returned
      Returns:
      The metamodel entity view type
      Throws:
      IllegalArgumentException - if the class is not a view type
      Since:
      1.5.0

    • getFlatViews

      Set<FlatViewType<?>> getFlatViews()
      Returns the metamodel embeddableentity views.
      Returns:
      The metamodel embeddableentity views