it.unibz.inf.ontop.injection.OntopModelSettings Maven / Gradle / Ivy

Go to download
package it.unibz.inf.ontop.injection;

import java.util.Optional;

/**
 * TODO: explain
 */
public interface OntopModelSettings {


    CardinalityPreservationMode getCardinalityPreservationMode();

    boolean isTestModeEnabled();

    /**
     * If true, most limit optimizations are disabled.
     */
    boolean isLimitOptimizationDisabled();

    /**
     * If false, user information is not extracted.
     */
    boolean isAuthorizationEnabled();

    /**
     * Not for end-users!
     * Please avoid using that class.
     */
    Optional getProperty(String key);

    boolean contains(Object key);

    enum CardinalityPreservationMode {
        /**
         * Cardinality is not important and may not be respected
         * (allows to optimize more)
         */
        LOOSE,
//        /**
//         * Cardinality is preserved in case a cardinality-sensitive
//         * aggregation function is detected.
//         */
//        STRICT_FOR_AGGREGATION,
        /**
         * Cardinality is strictly preserved
         */
        STRICT
    }

    //-------
    // Keys
    //-------

    String CARDINALITY_MODE = "ontop.cardinalityMode";
    String TEST_MODE = "ontop.testMode";
    String DISABLE_LIMIT_OPTIMIZATION = "ontop.disableLimitOptimization";
    String AUTHORIZATION = "ontop.authorization";
}