lens-server-api/src/main/java/org/apache/lens/server/api/query/cost/QueryCost.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.lens.server.api.query.cost;

import org.apache.lens.api.query.QueryCostType;

/**
 * QueryCost Interface.
 * @param <T>
 */
public interface QueryCost<T extends QueryCost> extends Comparable<T> {

  T add(final T queryCost);

  QueryCostType getQueryCostType();

  void setQueryCostType(QueryCostType queryCostType);

  long getEstimatedExecTimeMillis() throws UnsupportedOperationException;

  double getEstimatedResourceUsage() throws UnsupportedOperationException;

  @Override
  default int compareTo(QueryCost queryCost) {
    return (new Double(this.getEstimatedResourceUsage()))
      .compareTo(queryCost.getEstimatedResourceUsage());
  }

}