/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
 *
 *   https://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.
 *
 *   SPDX-License-Identifier: Apache-2.0
 */

package org.apache.jena.tdb2.params;

import org.apache.jena.dboe.base.block.FileMode;

/** Store parameters that can be adjusted after a store has been created,
 *  and given different values when the JVM attaches to a store area.
 *  (They are still fixed for any given database once created in a JVM.)
 */

public interface StoreParamsDynamic {

    /** Convenience label - no effect except as a descriptive label */
    public String getLabel();

    /** Store-wide file access mode */
    public FileMode getFileMode();
    public boolean isSetFileMode();

    /** Block read cache (note: direct mode only - mapped files do not have a block cache) */
    public Integer getBlockReadCacheSize();
    public boolean isSetBlockReadCacheSize();

    /** Block write cache (note: direct mode only - mapped files do not have a block cache) */
    public Integer getBlockWriteCacheSize();
    public boolean isSetBlockWriteCacheSize();

    // == NodeTable - Triples and Quads
    /** Node cache for Node{@literal ->}NodeId. */
    public Integer getNode2NodeIdCacheSize();
    public boolean isSetNode2NodeIdCacheSize();

    /** Node cache for NodeId{@literal ->}Node. Important for SPARQL results. */
    public Integer getNodeId2NodeCacheSize();
    public boolean isSetNodeId2NodeCacheSize();

    /** Node cache for recording known misses */
    public Integer getNodeMissCacheSize();
    public boolean isSetNodeMissCacheSize();

    // == NodeTable - Prefix table.
    /** Node cache for Node{@literal ->}NodeId. */
    public Integer getPrefixNode2NodeIdCacheSize();
    public boolean isSetPrefixNode2NodeIdCacheSize();

    /** Node cache for NodeId{@literal ->}Node. */
    public Integer getPrefixNodeId2NodeCacheSize();
    public boolean isSetPrefixNodeId2NodeCacheSize();

    /** Node cache for recording known misses */
    public Integer getPrefixNodeMissCacheSize();
    public boolean isSetPrefixNodeMissCacheSize();

    /**
     * Initial capacity factor for node caches:
     * <ul>
     * <li>if &gt;= 0.0: initial capacity is set to the (maximum) size of the cache multiplied by the factor</li>
     * <li>if &lt; 0.0:  no initial capacity is set on the cache, i.e. its internal default is used</li>
     * </ul>
     */
    public Double getNodeCacheInitialCapacityFactor();
    public boolean isSetNodeCacheInitialCapacityFactor();
}
