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

Go to download
/*
 * Copyright (c) 2013 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 org.dmg.pmml.Entity;

/**
 * 
 * A marker interface for results that are associated with a "winning" {@link Entity}.
 * 
 *
 * 
 * If a result implements both {@link HasEntityId} and {@link HasEntityRegistry}, which is typically the case,
 * then the provided {@link HasEntityRegistry#getEntityRegistry() entity registry} is suitable for {@link Entity} resolution purposes.
 * 
 *
 * @see org.dmg.pmml.ResultFeature#CLUSTER_ID
 * @see org.dmg.pmml.ResultFeature#ENTITY_ID
 */
public interface HasEntityId extends ResultFeature {

	/**
	 * 
	 * Gets the {@link Entity#getId() Entity identifier}.
	 * 
	 */
	String getEntityId();
}