org.terracotta.context.query.Query Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of statistics Show documentation

A statistics framework used inside Ehcache and the Terracotta products

There is a newer version: 2.1.3

/*
 * All content copyright Terracotta, Inc., unless otherwise indicated.
 *
 * 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 org.terracotta.context.query;

import org.terracotta.context.TreeNode;

import java.util.Set;

/**
 * A {@code Query} instance transforms an input node set into an output node set.
 * 
 * Useful implementations will normally perform a sequence of graph traversal
 * and node filtering operations to generate the query result.
 */
public interface Query {

  /**
   * Transforms the {@code input} node set in to an output node set.
   *
   * @param input query input node set
   * @return the output node set
   */
  Set execute(Set input);
}