org.jpmml.manager.Consumer Maven / Gradle / Ivy
/*
* Copyright (c) 2012 University of Tartu
*/
package org.jpmml.manager;
import java.io.*;
import java.util.*;
import org.dmg.pmml.*;
public interface Consumer extends Serializable {
/**
* Returns a short description of the underlying {@link Model}
*/
String getSummary();
/**
* Gets the definition of a field from the {@link DataDictionary}.
*
* @see PMMLManager#getDataField(FieldName)
*/
DataField getDataField(FieldName name);
/**
* Gets the independent (ie. input) fields of a {@link Model} from its {@link MiningSchema}.
*
* @see ModelManager#getActiveFields()
*/
List getActiveFields();
/**
* Gets the grouping fields of a {@link Model} from its {@link MiningSchema}.
*
* A model should have no more than 1 grouping field.
*
* @see ModelManager#getGroupFields()
*/
List getGroupFields();
/**
* Convenience method for retrieving the sole predicted field.
*
* @return The sole predicted field, or null if it does not exist
*
* @throws InvalidFeatureException If the number of predicted fields is not exactly one
*
* @see ModelManager#getTargetField()
*/
FieldName getTargetField();
/**
* Gets the dependent (ie. output) field(s) of a {@link Model} from its {@link MiningSchema}.
*
* @see ModelManager#getPredictedFields()
*/
List getPredictedFields();
/**
* Gets the definition of a field from the {@link MiningSchema}.
*
* @see #getActiveFields()
* @see #getPredictedFields()
*
* @see ModelManager#getMiningField(FieldName)
*/
MiningField getMiningField(FieldName name);
/**
* Gets the output fields of a {@link Model} from its {@link Output}.
*
* @see ModelManager#getOutputFields()
*/
List getOutputFields();
/**
* Gets the definition of a field from the {@link Output}
*
* @see #getOutputFields()
*/
OutputField getOutputField(FieldName name);
}