com.blazebit.persistence.view.metamodel.ViewMetamodel Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 - 2019 Blazebit.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.blazebit.persistence.view.metamodel;

import java.util.Set;

/**
 * Provides access to the metamodel of the entity views.
 *
 * @author Christian Beikov
 * @since 1.0.0
 */
public interface ViewMetamodel {

    /**
     * Returns the metamodel entity view type representing the entity view specified by the given class or null.
     *
     * @param    The type of the given entity view class
     * @param clazz The entity view class for which the view type should be returned
     * @return The metamodel entity view type or null
     */
    public  ViewType view(Class clazz);

    /**
     * Returns the metamodel entity views.
     *
     * @return The metamodel entity views
     */
    public Set> getViews();

    /**
     * Returns the metamodel managed entity view type representing the managed entity view specified by the given class or null.
     *
     * @param    The type of the given entity view class
     * @param clazz The entity view class for which the view type should be returned
     * @return The metamodel entity view type or null
     */
    public  ManagedViewType managedView(Class clazz);

    /**
     * Returns the metamodel managed entity views.
     *
     * @return The metamodel managed entity views
     */
    public Set> getManagedViews();

    /**
     * Returns the metamodel embeddable entity view type representing the embeddable entity view specified by the given class or null.
     *
     * @param    The type of the given entity view class
     * @param clazz The entity view class for which the view type should be returned
     * @return The metamodel entity view type or null
     */
    public  FlatViewType flatView(Class clazz);

    /**
     * Returns the metamodel embeddableentity views.
     *
     * @return The metamodel embeddableentity views
     */
    public Set> getFlatViews();
}