openjpa-kernel/src/main/java/org/apache/openjpa/instrumentation/QueryCacheInstrument.java

/*
 * 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
 *
 * 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 org.apache.openjpa.instrumentation;

import java.util.Date;
import java.util.Set;

/**
 * Interface for providing instrumented data cache metrics and operations.
 */
public interface QueryCacheInstrument {

    /**
     * Returns number of total exec requests since start.
     */
    long getTotalExecutionCount();

    /**
     * Returns number of total exec requests since start for
     * the specified string-ified query key.
     */
    long getTotalExecutionCount(String queryKey);

    /**
     * Returns number of total execution requests since last reset
     */
    long getExecutionCount();

    /**
     * Returns number of total execution requests since last reset for
     * the specified string-ified query key.
     */
    long getExecutionCount(String queryKey);

    /**
     * Returns number of total read requests that have been found in cache since
     * last reset.
     */
    long getHitCount();

    /**
     * Returns number of total read requests that have been found in cache since
     * last reset for the specified string-ified query key.
     */
    long getHitCount(String queryKey);

    /**
     * Returns number of total read requests that has been found since start.
     */
    long getTotalHitCount();

    /**
     * Returns number of total read requests that has been found since start for
     * the specified string-ified query key.
     */
    long getTotalHitCount(String queryKey);

    /**
     * Resets cache statistics
     */
    void reset();

    /**
     * Returns date since cache statistics collection were last reset.
     */
    Date sinceDate();

    /**
     * Returns date cache statistics collection started.
     */
    Date startDate();

    /**
     * Returns all the string-ified keys for query results in the cache.
     */
    Set<String> queryKeys();

    /**
     * Returns number of total evictions since last reset
     */
    long getEvictionCount();

    /**
     * Returns number of total eviction requests since start.
     */
    long getTotalEvictionCount();

    /**
     * Returns the number of total entries in the cache.
     * @return entries
     */
    long count();

}