All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jpmml.evaluator.TargetField Maven / Gradle / Ivy

Go to download

JPMML class model evaluator

The newest version!
/*
 * Copyright (c) 2016 Villu Ruusmann
 *
 * This file is part of JPMML-Evaluator
 *
 * JPMML-Evaluator 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.
 *
 * JPMML-Evaluator 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 JPMML-Evaluator.  If not, see .
 */
package org.jpmml.evaluator;

import java.util.List;

import org.dmg.pmml.DataField;
import org.dmg.pmml.MiningField;
import org.dmg.pmml.OpType;
import org.dmg.pmml.Target;

public class TargetField extends ResultField {

	private MiningField miningField = null;

	private Target target = null;


	TargetField(){
	}

	public TargetField(DataField dataField, MiningField miningField, Target target){
		super(dataField);

		setMiningField(miningField);
		setTarget(target);
	}

	/**
	 * @return The name, or null (in the form of the constant {@link Evaluator#DEFAULT_TARGET_NAME}) if this is a synthetic target field.
	 *
	 * @see #isSynthetic()
	 */
	@Override
	public String getFieldName(){
		return super.getFieldName();
	}

	@Override
	public OpType getOpType(){
		return FieldUtil.getOpType(getField(), getMiningField(), getTarget());
	}

	/**
	 * 

	 * Returns the range of categories for this categorical or ordinal field.
	 * 

	 *
	 * @return A non-empty list, or null.
	 *
	 * @see #getOpType()
	 *
	 * @see CategoricalResultFeature
	 * @see CategoricalResultFeature#getCategories()
	 */
	public List getCategories(){
		List categories = FieldUtil.getCategories(getField());

		if(categories != null && !categories.isEmpty()){
			return categories;
		}

		return null;
	}

	public boolean isSynthetic(){
		MiningField miningField = getMiningField();

		return (miningField == null);
	}

	/**
	 * @return The backing {@link DataField} element.
	 */
	@Override
	public DataField getField(){
		return (DataField)super.getField();
	}

	/**
	 * @return The backing {@link MiningField} element, or null if this a synthetic target field.
	 *
	 * @see #isSynthetic()
	 */
	public MiningField getMiningField(){
		return this.miningField;
	}

	private void setMiningField(MiningField miningField){
		this.miningField = miningField;
	}

	/**
	 * @return The backing {@link Target} element, or null.
	 */
	public Target getTarget(){
		return this.target;
	}

	private void setTarget(Target target){
		this.target = target;
	}
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy