com.mtnfog.idyl.e3.sdk.model.EntityExtractionResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of idyl-e3-java-sdk Show documentation

Java SDK for Mountain Fog's Idyl E3.

The newest version!

/* Copyright 2017 Mountain Fog, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

package com.mtnfog.idyl.e3.sdk.model;

import java.util.Set;

import com.mtnfog.entity.Entity;

/**
 * Represents a response from an Idyl E3 entity extraction
 * request. Instances of this class are created by
 * deserializing the JSON response from Idyl E3's
 * entity extraction.
 * @author Mountain Fog, Inc.
 *
 */
public class EntityExtractionResponse {

	private Set entities;
	private long extractionTime;
	
	/**
	 * Gets the set of extracted entities.
	 * @return A set of {@link Entity entities}.
	 */
	public Set getEntities() {
		return entities;
	}
	
	/**
	 * Sets the set of extracted entities.
	 * @param entities The set of extracted {@link Entity entities}.
	 */
	public void setEntities(Set entities) {
		this.entities = entities;
	}

	/**
	 * Gets the extraction time taken.
	 * @return The extraction time in milliseconds.
	 */
	public long getExtractionTime() {
		return extractionTime;
	}

	/**
	 * Sets the extraction time.
	 * @param extractionTime The extraction time in milliseconds.
	 */
	public void setExtractionTime(long extractionTime) {
		this.extractionTime = extractionTime;
	}
	
}