org.mule.modules.watsonvisualrecognition.model

Class ClassifyImageRequest

java.lang.Object

org.mule.modules.watsonvisualrecognition.model.ClassifyImageRequest

public class ClassifyImageRequest
extends Object

Class that contains the image and the classifier to be use for the classify an image operation.

Author:

Admios

Constructor Summary

Constructors

Constructor and Description
ClassifyImageRequest()

Method Summary

Modifier and Type	Method and Description
List<String>	getClassifierIds() An array of classifier IDs to classify the images against.
InputStream	getImage() The image input stream (.jpg, or .png) or compressed (.zip) file of images to classify.
File	getImageAsFile() The image file (.jpg, or .png) or compressed (.zip) file of images to classify.
Double	getThreshold() A floating point value that specifies the minimum score a class must have to be displayed in the response.
String	getUrl() The URL of an image (.jpg, or .png).
void	setClassifierIds(List<String> classifierIds)
void	setImage(InputStream image)
void	setThreshold(Double threshold)
void	setUrl(String url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassifyImageRequest

public ClassifyImageRequest()

Method Detail

getClassifierIds

public List<String> getClassifierIds()

An array of classifier IDs to classify the images against.

Returns:

the classifierIds

getThreshold

public Double getThreshold()

A floating point value that specifies the minimum score a class must have to be displayed in the response.

Returns:

the threshold

getUrl

public String getUrl()

The URL of an image (.jpg, or .png). Redirects are followed, so you can use shortened URLs.

Returns:

the url

getImage

public InputStream getImage()

The image input stream (.jpg, or .png) or compressed (.zip) file of images to classify. The max number of images in a .zip file is limited to 20, and limited to 5 MB. If the URL is set the image will be ignored.

Returns:

the image

getImageAsFile

public File getImageAsFile()
                    throws IOException

The image file (.jpg, or .png) or compressed (.zip) file of images to classify. The max number of images in a .zip file is limited to 20, and limited to 5 MB. If the URL is set the image will be ignored.

Returns:

the image file if the image input string was set

Throws:

IOException - When the connector can't process the image input stream.

setClassifierIds

public void setClassifierIds(List<String> classifierIds)

Parameters:

classifierIds - the classifierIds to set

setThreshold

public void setThreshold(Double threshold)

Parameters:

threshold - the threshold to set

setUrl

public void setUrl(String url)

Parameters:

url - the url to set

setImage

public void setImage(InputStream image)

Parameters:

image - the image to set