scray.querying.caching.Cache.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scray-querying Show documentation

query engine core source code

There is a newer version: 1.1.2

// See the LICENCE.txt file distributed with this work for additional
// information regarding copyright ownership.
//
// 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 scray.querying.caching

import scray.querying.queries.DomainQuery
import scray.querying.source.LazyDataFuture

trait Cache[V] {

  /**
   * retrieve data from the cache
   */
  def retrieve(query: DomainQuery): Option[V]

  /**
   * do maintnance on this cache, e.g. remove old rows
   */
  def maintnance: Unit

  /**
   * closes the cache and frees up it's resources
   */
  def close: Unit

  /**
   * report relevant cache information
   */
  def report: MonitoringInfos
}