com.screenscraper.util.images

Class ImageDecoder

java.lang.Object

com.screenscraper.util.images.ImageDecoder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DeathByCaptchaDecoder, DecaptcherDecoder, ManualDecoder, TesseractDecoder, TwoCaptchaDecoder

public abstract class ImageDecoder
extends java.lang.Object
implements java.io.Closeable

Class that receives credentials and optional parameters for decoding, and then creates instances on-demand of other classes to handle the decode, using the specified parameters given
User: Mike Date: 11/18/11 Time: 11:06 AM

Field Summary

Fields

Modifier and Type	Field and Description
protected ScrapingSession	session The Scraping Session, used for logging and getting any needed info, such as the current proxy, and scraping state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageDecoder(ScrapingSession session) Creates an ImageDecoder to be used during the session (or a portion of it)

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes any resources associated with the decoder.
abstract DecodedImage	decodeFile(java.io.File file) Converts the image given to a DecodedImage that will handle it.
DecodedImage	decodeFile(java.lang.String file) Converts the image given to a DecodedImage that will handle it.
DecodedImage	decodeURL(java.lang.String url) Converts the image at the given URL to a DecodedImage that will handle it.
abstract double	getBalance() Returns the current balance of the account (if it can be accessed via the API).
void	setAutoCloseAfterScrapeEnds() Tells the data manager to close when the scrape ends.

Methods inherited from class java.lang.Object

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

Field Detail

session

protected ScrapingSession session

The Scraping Session, used for logging and getting any needed info, such as the current proxy, and scraping state

Constructor Detail

ImageDecoder

protected ImageDecoder(ScrapingSession session)

Creates an ImageDecoder to be used during the session (or a portion of it)

Parameters:

session - The scraping session

Method Detail

decodeFile

@NotNull
public DecodedImage decodeFile(@Nullable
                                         java.lang.String file)
                                  throws java.io.IOException

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

Parameters:

file - The image file

Returns:

A DecodedImage used to decode the image

Throws:

java.io.IOException - If there is an error reading the file

decodeFile

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

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

Parameters:

file - The image file

Returns:

A DecodedImage used to decode the image

decodeURL

@NotNull
public DecodedImage decodeURL(@NotNull
                                        java.lang.String url)

Converts the image at the given URL to a DecodedImage that will handle it. Temporarily saves the file in the screen-scraper root folder, but deletes it once it has been decoded. By default, this will use the scraping session's HttpClient to request the URL.

Parameters:

url - The url to the image

Returns:

A DecodedImage used to decode the image

getBalance

public abstract double getBalance()

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

Returns:

The current remaining balance in the account, if applicable.

close

public abstract void close()

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

setAutoCloseAfterScrapeEnds

public void setAutoCloseAfterScrapeEnds()

Tells the data manager to close when the scrape ends. Calling this method will close the data manager automatically when the scrape ends. If the session was stopped, it will clear the data that is set to be written, otherwise it will call flush before closing.

Since:

7.0.2a