com.screenscraper.util.internal.services.depthtracker

Class DepthTrackerClient

java.lang.Object

com.screenscraper.util.internal.services.depthtracker.DepthTrackerClient

All Implemented Interfaces:

DepthTracker

public final class DepthTrackerClient
extends java.lang.Object
implements DepthTracker

Client used for tracking the depth of a search and managing threads in them. This tracks number of records as well so in the scrape there is no need to try to manage the number of records extracted, so long as each time you enter a category you pass in the current number of records, and when you exit you pass in the current number of records again.

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DepthTrackerClient.DepthTrackerClientBuilder

Constructor Summary

Constructors

Constructor and Description
DepthTrackerClient(ScrapingSession session, java.lang.String siteName, java.lang.String host, int threadsPerLevel, int reducePerLevel, java.lang.String deploymentPath, java.lang.String username, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this client
void	close(boolean resetAllCategories) Closes this client and resets all categories on the site IFF this is the last thread scraping the site and this scrape wasn't stopped early
void	close(boolean resetAllCategories, boolean fullReset) Closes this client and resets all categories on the site IFF this is the last thread scraping the site and this scrape wasn't stopped early
boolean	enterCategory(java.lang.String categoryName)
boolean	enterCategory(java.lang.String categoryName, boolean isBaseCategory)
boolean	enterCategory(java.lang.String categoryName, int numRecords)
boolean	enterCategory(java.lang.String categoryName, int numRecords, boolean isBaseCategory)
void	exitCategory()
void	exitCategory(int numRecords, RunState endState)
void	exitCategory(RunState endState)
APIConnection	getApiConnection() Returns the connection to the API that this client uses.
Category	getCategory(java.lang.String name) Gets a category by name, assuming the category is a child of whatever we are currently in
java.lang.Long	getCurrentCategoryId() Returns the ID of the category we are currently in
java.util.Date	getCurrentCategoryInitialEntryDate() Returns the initial entry time for the current category, or null if there are no categories (or the first entry date is unknown)
java.util.Date	getCurrentCategoryLastEntryTimeForSuccessfulExit() Returns the last entry time when this category was entered and a thread successfully exited it.
java.util.Date	getCurrentCategoryPreviousEntryDate() Returns the last entry time for the current category (prior to the current entry), or null if there are no categories (or the category had never been entered prior to this entry)
java.util.List<java.lang.String>	getCurrentStack() Returns the currently tracked stack of elements, as a list
java.util.Date	getOldestSuccessfulEntryExitEncountered()
long	getSiteId() Returns the id of the site that the client is dealing with.
long	getThreadId() Returns the id of the thread that the client is running under.
boolean	runInCategory(java.lang.String categoryName, java.lang.Runnable runOnEntry) Enters the category (if possible) and runs the runnable

Methods inherited from class java.lang.Object

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

Constructor Detail

DepthTrackerClient

DepthTrackerClient(@NotNull
                   ScrapingSession session,
                   @Nullable
                   java.lang.String siteName,
                   @Nullable
                   java.lang.String host,
                   int threadsPerLevel,
                   int reducePerLevel,
                   java.lang.String deploymentPath,
                   @Nullable
                   java.lang.String username,
                   @Nullable
                   java.lang.String password)

Method Detail

getCurrentStack

@NotNull
public java.util.List<java.lang.String> getCurrentStack()

Description copied from interface: DepthTracker

Returns the currently tracked stack of elements, as a list

Specified by:

getCurrentStack in interface DepthTracker

Returns:

The currently tracked stack of elements, as a list

getCurrentCategoryId

public java.lang.Long getCurrentCategoryId()

Description copied from interface: DepthTracker

Returns the ID of the category we are currently in

Specified by:

getCurrentCategoryId in interface DepthTracker

Returns:

The id of the category we are currently in

runInCategory

public boolean runInCategory(java.lang.String categoryName,
                             @Nullable
                             java.lang.Runnable runOnEntry)

Description copied from interface: DepthTracker

Enters the category (if possible) and runs the runnable

Specified by:

runInCategory in interface DepthTracker

Parameters:

categoryName - The name of the category to enter

runOnEntry - Something to run if entry was successful

Returns:

True if the category was successfully entered, the runnable was executed, and the category was exited

getCurrentCategoryLastEntryTimeForSuccessfulExit

@Nullable
public java.util.Date getCurrentCategoryLastEntryTimeForSuccessfulExit()

Description copied from interface: DepthTracker

Returns the last entry time when this category was entered and a thread successfully exited it.

Specified by:

getCurrentCategoryLastEntryTimeForSuccessfulExit in interface DepthTracker

Returns:

The last entry time when this category was entered and a thread successfully exited it.

getCurrentCategoryInitialEntryDate

public java.util.Date getCurrentCategoryInitialEntryDate()

Description copied from interface: DepthTracker

Returns the initial entry time for the current category, or null if there are no categories (or the first entry date is unknown)

Specified by:

getCurrentCategoryInitialEntryDate in interface DepthTracker

Returns:

The initial entry time for the current category, or null if there are no categories (or the first entry date is unknown)

getCurrentCategoryPreviousEntryDate

@Nullable
public java.util.Date getCurrentCategoryPreviousEntryDate()

Description copied from interface: DepthTracker

Returns the last entry time for the current category (prior to the current entry), or null if there are no categories (or the category had never been entered prior to this entry)

Specified by:

getCurrentCategoryPreviousEntryDate in interface DepthTracker

Returns:

The last entry time for the current category (prior to the current entry), or null if there are no categories (or the category had never been entered prior to this entry)

enterCategory

public boolean enterCategory(java.lang.String categoryName)

Specified by:

enterCategory in interface DepthTracker

enterCategory

public boolean enterCategory(java.lang.String categoryName,
                             int numRecords)

Specified by:

enterCategory in interface DepthTracker

enterCategory

public boolean enterCategory(java.lang.String categoryName,
                             boolean isBaseCategory)

Specified by:

enterCategory in interface DepthTracker

enterCategory

public boolean enterCategory(java.lang.String categoryName,
                             int numRecords,
                             boolean isBaseCategory)

Specified by:

enterCategory in interface DepthTracker

exitCategory

public void exitCategory()

Specified by:

exitCategory in interface DepthTracker

exitCategory

public void exitCategory(@NotNull
                         RunState endState)

Specified by:

exitCategory in interface DepthTracker

exitCategory

public void exitCategory(int numRecords,
                         @NotNull
                         RunState endState)

Specified by:

exitCategory in interface DepthTracker

getOldestSuccessfulEntryExitEncountered

@Nullable
public java.util.Date getOldestSuccessfulEntryExitEncountered()

Specified by:

getOldestSuccessfulEntryExitEncountered in interface DepthTracker

close

public void close()

Description copied from interface: DepthTracker

Closes this client

Specified by:

close in interface DepthTracker

close

public void close(boolean resetAllCategories)

Description copied from interface: DepthTracker

Closes this client and resets all categories on the site IFF this is the last thread scraping the site and this scrape wasn't stopped early

Specified by:

close in interface DepthTracker

Parameters:

resetAllCategories - True to reset this this is the last thread scraping the site and this scrape wasn't stopped early. If true is given but there is another thread OR this session was stopped early, it will still not reset the site

close

public void close(boolean resetAllCategories,
                  boolean fullReset)

Description copied from interface: DepthTracker

Closes this client and resets all categories on the site IFF this is the last thread scraping the site and this scrape wasn't stopped early

Specified by:

close in interface DepthTracker

Parameters:

resetAllCategories - True to reset this this is the last thread scraping the site and this scrape wasn't stopped early. If true is given but there is another thread OR this session was stopped early, it will still not reset the site

fullReset - True to reset all fields, false to reset only the status of the categories and site but leave the entry/exit dates

getCategory

@Nullable
public Category getCategory(java.lang.String name)

Description copied from interface: DepthTracker

Gets a category by name, assuming the category is a child of whatever we are currently in

Specified by:

getCategory in interface DepthTracker

Parameters:

name - The name of the category

Returns:

The category, or null if no such category was found

getApiConnection

@NotNull
public APIConnection getApiConnection()

Description copied from interface: DepthTracker

Returns the connection to the API that this client uses. This should only be used in rare cases, as the client will not be informed of anything you do manually with the connection

Specified by:

getApiConnection in interface DepthTracker

Returns:

The api connection used by the client

getSiteId

public long getSiteId()

Description copied from interface: DepthTracker

Returns the id of the site that the client is dealing with.

Specified by:

getSiteId in interface DepthTracker

Returns:

The id of the site the client is for

getThreadId

public long getThreadId()

Description copied from interface: DepthTracker

Returns the id of the thread that the client is running under.

Specified by:

getThreadId in interface DepthTracker

Returns:

The id of the thread that the client is running under