com.screenscraper.util.images

Interface DecodedImage

public interface DecodedImage

Object that handles decoding the text in an image, and reporting the image as bad. A decoder object should handle the conversion when it is created, such that upon return from it's constructor the file used can be deleted from the file system User: Mike Date: 11/18/11 Time: 9:59 AM

Method Summary

Modifier and Type	Method and Description
java.lang.String	getError() Gets any error message, or returns null or a blank string if there was no error
ImageErrorCode	getErrorCode() Returns an error code that can be used to determine the cause of the error.
java.lang.Object	getResult() Gets the result from decoding the image.
void	reportAsBad() Handles an incorrectly resolved image.
boolean	wasError() Returns true if there was an error, false otherwise.

Method Detail

getResult

@Nullable
java.lang.Object getResult()

Gets the result from decoding the image. Most likely this will be a String, but each implementation could return a specific object type.

Returns:

The text extracted from the image, or null if there was an error

reportAsBad

void reportAsBad()

Handles an incorrectly resolved image. Some types of decoders won't have anything here

getError

@Nullable
java.lang.String getError()

Gets any error message, or returns null or a blank string if there was no error

Returns:

The error message returned

wasError

boolean wasError()

Returns true if there was an error, false otherwise. Also returns false if the image has not been resolved yet

Returns:

True if there was an error, false otherwise

getErrorCode

ImageErrorCode getErrorCode()

Returns an error code that can be used to determine the cause of the error. These codes are general to any type of DecodedImage, but the return string from getError should have more details.

Returns:

The ImageErrorCode that corresponds to the error. Useful for using interchangeable types of image decoders.