com.screenscraper.util.images

Class TesseractDecoder

java.lang.Object

com.screenscraper.util.images.ImageDecoder

com.screenscraper.util.images.TesseractDecoder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class TesseractDecoder
extends ImageDecoder

No Description User: Mike Date: 12/14/11 Time: 1:46 PM

Field Summary

Fields inherited from class com.screenscraper.util.images.ImageDecoder

session

Constructor Summary

Constructors

Constructor and Description
TesseractDecoder(ScrapingSession session, java.lang.String customImageMagickCommands, java.lang.String customTesseractCommands) Converts an image to text using tesseract and imagemagick

Method Summary

Modifier and Type	Method and Description
void	close() Closes any resources associated with the decoder.
DecodedImage	decodeFile(java.io.File file) Converts the image given to a DecodedImage that will handle it.
double	getBalance() Returns the current balance of the account (if it can be accessed via the API).

Methods inherited from class com.screenscraper.util.images.ImageDecoder

decodeFile, decodeURL, setAutoCloseAfterScrapeEnds

Methods inherited from class java.lang.Object

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

Constructor Detail

TesseractDecoder

public TesseractDecoder(@NotNull
                        ScrapingSession session,
                        @Nullable
                        java.lang.String customImageMagickCommands,
                        @Nullable
                        java.lang.String customTesseractCommands)

Converts an image to text using tesseract and imagemagick

Parameters:

session - The scraping session

customImageMagickCommands - A string of custom commands to send to imageMagick for preparing the image

customTesseractCommands - A string of custom commands to send to Tesseract for preparing the image

Method Detail

decodeFile

@NotNull
public DecodedImage decodeFile(@NotNull
                                         java.io.File file)

Description copied from class: ImageDecoder

Converts the image given to a DecodedImage that will handle it. Does not delete the file.

Specified by:

decodeFile in class ImageDecoder

Parameters:

file - The image file

Returns:

A DecodedImage used to decode the image

close

public void close()

Description copied from class: ImageDecoder

Closes any resources associated with the decoder. This may include logging out. This method should ALWAYS be called when done with the decoder. Some types of decoders may not need this. Note that once this is called, you should no longer use this decoder, including reporting any images it decoded as bad.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class ImageDecoder

getBalance

public double getBalance()

Description copied from class: ImageDecoder

Returns the current balance of the account (if it can be accessed via the API). Each type of decoder may have it's own interpretation of balance. For example, some may be the amount of images that can still be resolved, others may be a dollar amount

Specified by:

getBalance in class ImageDecoder

Returns:

The current remaining balance in the account, if applicable.