com.screenscraper.util

Class FileCacher

java.lang.Object

com.screenscraper.util.FileCacher

public class FileCacher
extends java.lang.Object

Class used for caching a set of files, and optionally zipping them.

User: Mike Date: 11/11/11 Time: 9:02 AM

Constructor Summary

Constructors

Constructor and Description
FileCacher(ScrapingSession session, java.lang.String cacheDirectory) Creates the scrape cache with the given utility, and sets the default log saving behavior.

Method Summary

Modifier and Type	Method and Description
java.io.File	cacheBytes(java.lang.String name, byte[] bytes) Caches a byte array as a file using a given path for the output in the zip
java.io.File	cacheFile(java.lang.String name, java.io.File file) Caches a file using a given path for the output in the zip
java.io.File	cacheText(java.lang.String name, java.lang.String content) Caches a string with a given name
java.io.File	cacheText(java.lang.String name, java.lang.String content, java.lang.String encoding) Caches a string with a given name
java.io.File	endCache() Ends the cache, either zipping or renaming the containing directory.
java.io.File	getCacheDirectory() Returns the cache directory being used to store files
java.lang.String	getDescription() Returns the descriptive text to use in the cache file name
boolean	getShouldSaveCountInFileName() Returns whether or not the number of the cached page will be saved in the name of the file
boolean	getShouldSaveLogs() Gets the current log saving policy.
boolean	getZipOnEnd() Returns whether or not the cache should be compressed when everything is written to it
void	setDescription(java.lang.String description) Sets the descriptive text to use in the cache file name
void	setShouldSaveCountInFileName(boolean shouldSaveCountInFileName) Sets whether or not to include the current cached page number in the file name.
void	setShouldSaveLogs(boolean shouldSaveLogs) Sets the log saving behavior.
void	setZipOnEnd(boolean zipOnEnd) Sets whether or not the cache should be compressed when everything is written to it
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileCacher

public FileCacher(@Nullable
                  ScrapingSession session,
                  @Nullable
                  java.lang.String cacheDirectory)

Creates the scrape cache with the given utility, and sets the default log saving behavior.

Parameters:

session - The session associated with the cache

cacheDirectory - The directory where cached files will be saved

Method Detail

setShouldSaveLogs

public void setShouldSaveLogs(boolean shouldSaveLogs)

Sets the log saving behavior. Any logs previously added to this cache will be retained, but not future files will be if set to false. The reverse is also true. Note that changing this doesn't mean the same log file that was added before won't be updated with more logging information.

Parameters:

shouldSaveLogs - True if logs should be included in the cache, false otherwise

getShouldSaveLogs

public boolean getShouldSaveLogs()

Gets the current log saving policy.

Returns:

True if new log files will be included in the cached record, false otherwise

setZipOnEnd

public void setZipOnEnd(boolean zipOnEnd)

Sets whether or not the cache should be compressed when everything is written to it

Parameters:

zipOnEnd - True if zipping should occur, false to leave it in a directory structure

getZipOnEnd

public boolean getZipOnEnd()

Returns whether or not the cache should be compressed when everything is written to it

Returns:

True if zipping should occur, false to leave it in a directory structure

setDescription

public void setDescription(java.lang.String description)

Sets the descriptive text to use in the cache file name

Parameters:

description - The text to use in the cache file name

getDescription

public java.lang.String getDescription()

Returns the descriptive text to use in the cache file name

Returns:

The text to use in the cache file name

setShouldSaveCountInFileName

public void setShouldSaveCountInFileName(boolean shouldSaveCountInFileName)

Sets whether or not to include the current cached page number in the file name. This is useful when caching each scrapeable file so that you can see the order they were scraped and don't have to create a unique name for each one. It is useful to turn off when caching things and outputting the name of the cached file.

Parameters:

shouldSaveCountInFileName - True if the file number should be saved at the beginning of the file name

getShouldSaveCountInFileName

public boolean getShouldSaveCountInFileName()

Returns whether or not the number of the cached page will be saved in the name of the file

Returns:

Returns true if the file count number will be saved as part of the cached file name

cacheText

@Nullable
public java.io.File cacheText(java.lang.String name,
                                         java.lang.String content)

Caches a string with a given name

Parameters:

name - The name for the file (alterations such as timestamps will occur)

content - The content for the cached file

Returns:

Returns a file representing the cached file. This is the file saved in the temp cache directory. Modifying it or deleting it will modify/remove it from the eventual cache file.

Throws:

java.lang.IllegalArgumentException - Name or extension is null

cacheText

@Nullable
public java.io.File cacheText(@Nullable
                                         java.lang.String name,
                                         @Nullable
                                         java.lang.String content,
                                         @Nullable
                                         java.lang.String encoding)

Caches a string with a given name

Parameters:

name - The name for the file (alterations such as timestamps will occur)

content - The content for the cached file

encoding - The character encoding to use when writing this file to the cache

Returns:

Returns a file representing the cached file. This is the file saved in the temp cache directory. Modifying it or deleting it will modify/remove it from the eventual cache file.

Throws:

java.lang.IllegalArgumentException - Name or extension is null

cacheFile

@Nullable
public java.io.File cacheFile(@Nullable
                                         java.lang.String name,
                                         @Nullable
                                         java.io.File file)

Caches a file using a given path for the output in the zip

Parameters:

name - The name to use for the file in the cache, including the extension

file - The file to cache

Returns:

Returns a file representing the cached file. This is the file saved in the temp cache directory. Modifying it or deleting it will modify/remove it from the eventual cache file.

cacheBytes

@Nullable
public java.io.File cacheBytes(@Nullable
                                          java.lang.String name,
                                          @Nullable
                                          byte[] bytes)

Caches a byte array as a file using a given path for the output in the zip

Parameters:

name - The name to use for the file in the cache, including the extension

bytes - The bytes to cache

Returns:

Returns a file representing the cached file. This is the file saved in the temp cache directory. Modifying it or deleting it will modify/remove it from the eventual cache file.

Since:

7.0.9a

endCache

@Nullable
public java.io.File endCache()
                                 throws java.io.IOException

Ends the cache, either zipping or renaming the containing directory.

Returns:

The zip file or parent directory

Throws:

java.io.IOException - Error writing the zip file or renaming the directory

getCacheDirectory

public final java.io.File getCacheDirectory()

Returns the cache directory being used to store files

Returns:

The cache directory being temporarily used to store cached files

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object