Added Javadoc

pmml-evaluator/src/main/java/org/jpmml/evaluator/ModelEvaluatorBuilder.java

@@ -28,6 +28,7 @@
 import org.dmg.pmml.FieldName;
 import org.dmg.pmml.MiningSchema;
 import org.dmg.pmml.Model;
+import org.dmg.pmml.Output;
 import org.dmg.pmml.PMML;
 import org.dmg.pmml.ResultFeature;
 
@@ -209,6 +210,14 @@ public OutputFilter getOutputFilter(){
 		return configurationBuilder.getOutputFilter();
 	}
 
+	/**
+	 * <p>
+	 * Sets the filter for cleaning the model schema and model evaluation results from redundant output fields.
+	 * </p>
+	 *
+	 * @see OutputFilters#KEEP_ALL
+	 * @see OutputFilters#KEEP_FINAL_RESULTS
+	 */
 	public ModelEvaluatorBuilder setOutputFilter(OutputFilter outputFilter){
 		ConfigurationBuilder configurationBuilder = getConfigurationBuilder();
 
@@ -223,6 +232,13 @@ public SymbolTable<FieldName> getDerivedFieldGuard(){
 		return configurationBuilder.getDerivedFieldGuard();
 	}
 
+	/**
+	 * <p>
+	 * Sets a guard against recursive field declarations.
+	 * </p>
+	 *
+	 * @see FieldNameSet
+	 */
 	public ModelEvaluatorBuilder setDerivedFieldGuard(SymbolTable<FieldName> derivedFieldGuard){
 		ConfigurationBuilder configurationBuilder = getConfigurationBuilder();
 
@@ -237,6 +253,13 @@ public SymbolTable<String> getFunctionGuard(){
 		return configurationBuilder.getFunctionGuard();
 	}
 
+	/**
+	 * <p>
+	 * Sets a guard against recursive function declarations.
+	 * </p>
+	 *
+	 * @see FunctionNameStack
+	 */
 	public ModelEvaluatorBuilder setFunctionGuard(SymbolTable<String> functionGuard){
 		ConfigurationBuilder configurationBuilder = getConfigurationBuilder();
 
@@ -249,6 +272,15 @@ public Set<ResultFeature> getExtraResultFeatures(){
 		return this.extraResultFeatures;
 	}
 
+	/**
+	 * <p>
+	 * Sets <em>extra</em> functional requirements.
+	 * </p>
+	 *
+	 * The final set of functional requirements is obtained by combining
+	 * default functional requirements (as declared by the {@link Output} element of the model)
+	 * with extra functional requirements.
+	 */
 	public ModelEvaluatorBuilder setExtraResultFeatures(Set<ResultFeature> extraResultFeatures){
 		this.extraResultFeatures = extraResultFeatures;
 
@@ -259,6 +291,13 @@ public InputMapper getInputMapper(){
 		return this.inputMapper;
 	}
 
+	/**
+	 * <p>
+	 * Sets a mapper for translating input field names from user namespace to model namespace.
+	 * </p>
+	 *
+	 * @see Evaluator#getInputFields()
+	 */
 	public ModelEvaluatorBuilder setInputMapper(InputMapper inputMapper){
 		this.inputMapper = inputMapper;
 
@@ -269,6 +308,14 @@ public ResultMapper getResultMapper(){
 		return this.resultMapper;
 	}
 
+	/**
+	 * <p>
+	 * Sets a mapper for translating result field names from model namespace to user namespace.
+	 * </p>
+	 *
+	 * @see Evaluator#getTargetFields()
+	 * @see Evaluator#getOutputFields()
+	 */
 	public ModelEvaluatorBuilder setResultMapper(ResultMapper resultMapper){
 		this.resultMapper = resultMapper;