com.screenscraper.scraper

Class ScrapingSessionState

java.lang.Object

com.screenscraper.scraper.ScrapingSessionState

public class ScrapingSessionState
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
ScrapingSessionState()

Method Summary

Modifier and Type	Method and Description
void	clearVariables() Clears all session variables.
void	dropCachedDataSetTables() Scans for any DataSet objects, and, if they've been cached, drops their corresponding tables.
java.lang.String	getAllSessionVariablesAsURLEncodedString() Gets all session variables as a URL-encoded string.
<T> T	getInternalVariable(java.lang.String key) Gets the value of an internal use variable (not cleared by session.clearVariables())
java.util.Map<java.lang.String,java.lang.Object>	getInternalVariables() Gets the HashMap holding all of the variables.
int	getNumVariables() Gets the number of variables held by the object.
java.util.Iterator	getSessionVariableKeysIterator() Gets an Iterator over which session variables can be seen.
java.util.Iterator	getSessionVariableKeysIteratorSorted() Gets an Iterator over which sorted session variables can be accessed.
java.lang.String	getString(java.lang.String variable) Gets the value of a session variable as a String.
java.lang.Object	getVariable(java.lang.String variable) Gets the value of a session variable.
java.lang.String	getVariableName(int sequence) Gets the key of a variable by sequence.
java.util.Map<java.lang.String,java.lang.Object>	getVariables() Gets the HashMap holding all of the variables.
void	loadVariables(java.lang.String fileToReadFrom) Reads in and loads the session variables that were previously saved to a file.
java.lang.String	resolveVariables(java.lang.String value) Given a String attempts to resolve any variables.
void	saveVariables(java.lang.String fileToSaveTo) Writes out the current session variables to a file.
void	setInternalVariable(java.lang.String key, java.lang.Object value) Sets the value of an internal variable.
void	setString(java.lang.String variable, java.lang.String value) Sets the value of a session variable as a String.
void	setVariable(java.lang.String variable, java.lang.Object value) Sets the value of a session variable.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

ScrapingSessionState

public ScrapingSessionState()

Method Detail

getVariable

@Nullable
public java.lang.Object getVariable(@NotNull
                                               java.lang.String variable)

Gets the value of a session variable.

Parameters:

variable - The name of the variable.

Returns:

The value.

getInternalVariable

@InternalOnly
 @Nullable
public <T> T getInternalVariable(@NotNull
                                                            java.lang.String key)

Gets the value of an internal use variable (not cleared by session.clearVariables())

Parameters:

key - The name of the variable

Returns:

The value of the variable, or null if there is no value

setVariable

public void setVariable(@NotNull
                        java.lang.String variable,
                        @Nullable
                        java.lang.Object value)

Sets the value of a session variable.

Parameters:

variable - The variable.

value - The value of the variable.

setInternalVariable

@InternalOnly
public void setInternalVariable(@NotNull
                                               java.lang.String key,
                                               @Nullable
                                               java.lang.Object value)

Sets the value of an internal variable.

Parameters:

key - The variable.

value - The value of the variable, or null to clear it.

clearVariables

public void clearVariables()

Clears all session variables.

getString

public java.lang.String getString(java.lang.String variable)

Gets the value of a session variable as a String.

Parameters:

variable - The name of the variable.

Returns:

The value.

setString

public void setString(java.lang.String variable,
                      java.lang.String value)

Sets the value of a session variable as a String.

Parameters:

variable - The variable.

value - The value of the variable.

getVariableName

@Nullable
public java.lang.String getVariableName(int sequence)

Gets the key of a variable by sequence.

Parameters:

sequence - The sequence.

Returns:

The name of the variable.

getVariables

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getVariables()

Gets the HashMap holding all of the variables.

Returns:

The HashMap.

getInternalVariables

@NotNull
 @InternalOnly
public java.util.Map<java.lang.String,java.lang.Object> getInternalVariables()

Gets the HashMap holding all of the variables.

Returns:

The HashMap.

getNumVariables

public int getNumVariables()

Gets the number of variables held by the object.

Returns:

The number.

getSessionVariableKeysIterator

@NotNull
public java.util.Iterator getSessionVariableKeysIterator()

Gets an Iterator over which session variables can be seen.

Returns:

An Iterator.

getSessionVariableKeysIteratorSorted

@NotNull
public java.util.Iterator getSessionVariableKeysIteratorSorted()

Gets an Iterator over which sorted session variables can be accessed.

Returns:

An Iterator.

getAllSessionVariablesAsURLEncodedString

@NotNull
public java.lang.String getAllSessionVariablesAsURLEncodedString()

Gets all session variables as a URL-encoded string.

Returns:

The URL-encoded string.

saveVariables

public void saveVariables(@NotNull
                          java.lang.String fileToSaveTo)
                   throws java.io.IOException

Writes out the current session variables to a file.

Parameters:

fileToSaveTo - The file to save the variables to.

Throws:

java.io.IOException - On error writing to the file

loadVariables

public void loadVariables(@NotNull
                          java.lang.String fileToReadFrom)
                   throws java.io.IOException

Reads in and loads the session variables that were previously saved to a file.

Parameters:

fileToReadFrom - The file to read the variables from.

Throws:

java.io.IOException - On error reading the file

resolveVariables

@Nullable
public java.lang.String resolveVariables(@Nullable
                                                    java.lang.String value)

Given a String attempts to resolve any variables.

Parameters:

value - The String containing the variables.

Returns:

The value with the variables resolved.

dropCachedDataSetTables

public void dropCachedDataSetTables()

Scans for any DataSet objects, and, if they've been cached, drops their corresponding tables.