jetbrains.exodus.query.metadata.EntityMetaData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xodus-query Show documentation

Xodus is pure Java transactional schema-less embedded database

There is a newer version: 2.0.1

/**
 * Copyright 2010 - 2018 JetBrains s.r.o.
 *
 * 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 jetbrains.exodus.query.metadata;

import jetbrains.exodus.entitystore.Entity;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Collection;
import java.util.Map;
import java.util.Set;

public interface EntityMetaData {

    ModelMetaData getModelMetaData();

    @NotNull
    String getType();

    @Nullable
    String getSuperType();

    Collection getInterfaceTypes();

    Iterable getThisAndSuperTypes();

    boolean hasSubTypes();

    boolean isAbstract();

    Collection getSubTypes();

    Collection getAllSubTypes();

    AssociationEndMetaData getAssociationEndMetaData(@NotNull String name);

    @NotNull
    Collection getAssociationEndsMetaData();

    @NotNull
    Iterable getPropertiesMetaData();

    PropertyMetaData getPropertyMetaData(String name);

    /**
     * Own indexes only
     *
     * @return set of own indices
     */
    @NotNull
    Set getOwnIndexes();

    /**
     * Indexes, including inheritors
     *
     * @return set of all indices
     */
    @NotNull
    Set getIndexes();

    /**
     * Indexes for given field, including inheritors
     *
     * @return set of indices for given field
     */
    @NotNull
    Set getIndexes(String field);

    @NotNull
    Set getRequiredProperties();

    @NotNull
    Set getRequiredIfProperties(Entity e);

    @Nullable
    Runnable getInitializer();

    boolean getRemoveOrphan();

    boolean hasAggregationChildEnds();

    Set getAggregationChildEnds();

    @NotNull
    Map> getIncomingAssociations(ModelMetaData mmd);

}