DepthTracker

All Known Implementing Classes:

DepthTrackerClient, TestDepthTrackerClient
```
public interface DepthTracker
```
Class Description

Version:

1.0

Method Summary

All Methods Instance Methods Abstract Methods
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

- Method Detail
  - getCurrentStack
```
@NotNull
java.util.List<java.lang.String> getCurrentStack()
```
    Returns the currently tracked stack of elements, as a list
    
    Returns:
    
    The currently tracked stack of elements, as a list
  - getCurrentCategoryId
```
@Nullable
java.lang.Long getCurrentCategoryId()
```
    Returns the ID of the category we are currently in
    
    Returns:
    
    The id of the category we are currently in
  - runInCategory
```
boolean runInCategory(java.lang.String categoryName,
                      java.lang.Runnable runOnEntry)
```
    Enters the category (if possible) and runs the runnable
    
    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
java.util.Date getCurrentCategoryLastEntryTimeForSuccessfulExit()
```
    Returns the last entry time when this category was entered and a thread successfully exited it.
    
    Returns:
    
    The last entry time when this category was entered and a thread successfully exited it.
  - getCurrentCategoryInitialEntryDate
```
@Nullable
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)
    
    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
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)
    
    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
```
boolean enterCategory(java.lang.String categoryName)
```
  - enterCategory
```
boolean enterCategory(java.lang.String categoryName,
                      int numRecords)
```
  - enterCategory
```
boolean enterCategory(java.lang.String categoryName,
                      boolean isBaseCategory)
```
  - enterCategory
```
boolean enterCategory(java.lang.String categoryName,
                      int numRecords,
                      boolean isBaseCategory)
```
  - exitCategory
```
void exitCategory()
```
  - exitCategory
```
void exitCategory(RunState endState)
```
  - exitCategory
```
void exitCategory(int numRecords,
                  RunState endState)
```
  - getOldestSuccessfulEntryExitEncountered
```
@Nullable
java.util.Date getOldestSuccessfulEntryExitEncountered()
```
  - close
```
void close()
```
    Closes this client
  - close
```
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
    
    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
```
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
    
    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
Category getCategory(java.lang.String name)
```
    Gets a category by name, assuming the category is a child of whatever we are currently in
    
    Parameters:
    
    name - The name of the category
    
    Returns:
    
    The category, or null if no such category was found
  - getApiConnection
```
@Nullable
APIConnection getApiConnection()
```
    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
    
    Returns:
    
    The api connection used by the client
  - getSiteId
```
long getSiteId()
```
    Returns the id of the site that the client is dealing with.
    
    Returns:
    
    The id of the site the client is for
  - getThreadId
```
long getThreadId()
```
    Returns the id of the thread that the client is running under.
    
    Returns:
    
    The id of the thread that the client is running under

Interface DepthTracker

Method Summary

Method Detail

getCurrentStack

getCurrentCategoryId

runInCategory

getCurrentCategoryLastEntryTimeForSuccessfulExit

getCurrentCategoryInitialEntryDate

getCurrentCategoryPreviousEntryDate

enterCategory

enterCategory

enterCategory

enterCategory

exitCategory

exitCategory

exitCategory

getOldestSuccessfulEntryExitEncountered

close

close

close

getCategory

getApiConnection

getSiteId

getThreadId