IElephantIndicator.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.indicator;
 
import java.util.List;
import java.util.stream.Stream;
import org.turro.matching.GenericSiblings;
 
public interface IElephantIndicator {
  
  public void initIndicator();
  public void prepareIndicator();
  public void generateSiblings();
  
  public String getRoot();
  public List<IndicatorVariable> getVariables();
  public List<IndicatorVariable> getAllVariables();
  public IndicatorVariable getVariable(String name);
  
  public boolean itsMine(String root);
  public boolean itsMine(IndicatorVariable variable);
  
  public List<IndicatorVariable> getAllRankingVariables(String root);
  public List<IndicatorVariable> getAllMatchingVariables(String root);
  
  public double getValue(IndicatorVariable variable, Object entity);
  public double getValue(IndicatorVariable variable, Object entity, String relatedPath);
  
  //Read indicators
  public IndicatorResult readIndicator(String storeClass, String indicator);
  
  // Preprocess
  public void preprocess(IndicatorVariable variable, IPreprocessor preprocessor, String entityRoot, String relatedRoot);
  
  // Postprocess
  public void postprocess(IndicatorVariable variable, IPreprocessor preprocessor, String entityRoot, String relatedRoot);
  
  // Streams
  public Stream<String> getEntityPaths(String entityRoot);
  public Stream<GenericSiblings> getSiblingPaths(String entityPath);
  
}