com.screenscraper

Class GlobalSearchResult

java.lang.Object

com.screenscraper.GlobalSearchResult

public class GlobalSearchResult
extends java.lang.Object

Represents a global search results.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FOUND_IN_AUTHENTICATION_PASSWORD
static java.lang.String	FOUND_IN_AUTHENTICATION_USERNAME
static java.lang.String	FOUND_IN_CONTENT
static java.lang.String	FOUND_IN_HTTP_HEADER_KEY
static java.lang.String	FOUND_IN_HTTP_HEADER_VALUE
static java.lang.String	FOUND_IN_HTTP_PARAMETER_KEY
static java.lang.String	FOUND_IN_HTTP_PARAMETER_VALUE
static java.lang.String	FOUND_IN_IDENTIFIER
static java.lang.String	FOUND_IN_KEY_STORE_FILE_PATH
static java.lang.String	FOUND_IN_KEY_STORE_PASSWORD
static java.lang.String	FOUND_IN_LAST_REQUEST
static java.lang.String	FOUND_IN_LAST_RESPONSE
static java.lang.String	FOUND_IN_LOG
static java.lang.String	FOUND_IN_NAME
static java.lang.String	FOUND_IN_NOTE
static java.lang.String	FOUND_IN_NOTES
static java.lang.String	FOUND_IN_NT_PROXY_DOMAIN
static java.lang.String	FOUND_IN_NT_PROXY_HOST
static java.lang.String	FOUND_IN_NT_PROXY_PASSWORD
static java.lang.String	FOUND_IN_NT_PROXY_USERNAME
static java.lang.String	FOUND_IN_PATTERN_TEXT
static java.lang.String	FOUND_IN_POST_DATA
static java.lang.String	FOUND_IN_PROXY_HOST
static java.lang.String	FOUND_IN_PROXY_PASSWORD
static java.lang.String	FOUND_IN_PROXY_PORT
static java.lang.String	FOUND_IN_PROXY_USERNAME
static java.lang.String	FOUND_IN_REQUEST_HEADER_KEY
static java.lang.String	FOUND_IN_REQUEST_HEADER_VALUE
static java.lang.String	FOUND_IN_REQUEST_LINE
static java.lang.String	FOUND_IN_RESPONSE_BODY
static java.lang.String	FOUND_IN_RESPONSE_HEADER_KEY
static java.lang.String	FOUND_IN_RESPONSE_HEADER_VALUE
static java.lang.String	FOUND_IN_RESPONSE_STATUS_LINE
static java.lang.String	FOUND_IN_SCRIPT_TEXT
static java.lang.String	FOUND_IN_URL
static org.apache.log4j.Logger	log Used for logging.
static java.lang.String	OBJECT_TYPE_EXTRACTOR_PATTERN
static java.lang.String	OBJECT_TYPE_PROXY_SESSION
static java.lang.String	OBJECT_TYPE_SCRAPEABLE_FILE
static java.lang.String	OBJECT_TYPE_SCRAPING_SESSION
static java.lang.String	OBJECT_TYPE_SCRIPT

Constructor Summary

Constructors

Constructor and Description
GlobalSearchResult(int objectID, java.lang.String objectName, java.lang.String objectType, java.lang.String foundIn, java.lang.String textToSearch, int numMatches)

Method Summary

Modifier and Type	Method and Description
static GlobalSearchResult	generateGlobalSearchResult(java.lang.String textToSearch, java.lang.String textToFind, java.lang.String objectName, int columnID, java.lang.String objectType, java.lang.String foundInColumn, boolean isCaseSensitive)
java.lang.String	getFoundIn()
java.lang.String	getHeaderName()
int	getNumMatches()
int	getObjectID()
java.lang.String	getObjectName()
int	getObjectSequence()
java.lang.String	getObjectType()
ProxySearchResult	getProxySearchResult()
int	getStartPoint()
java.lang.String	getTextToSearch()
void	setHeaderName(java.lang.String headerName)
void	setObjectSequence(int objectSequence)
void	setProxySearchResult(ProxySearchResult proxySearchResult)
void	setStartPoint(int startPoint)
void	setTextToSearch(java.lang.String textToSearch)

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.

OBJECT_TYPE_EXTRACTOR_PATTERN

public static final java.lang.String OBJECT_TYPE_EXTRACTOR_PATTERN

See Also:

Constant Field Values

OBJECT_TYPE_PROXY_SESSION

public static final java.lang.String OBJECT_TYPE_PROXY_SESSION

See Also:

Constant Field Values

OBJECT_TYPE_SCRAPEABLE_FILE

public static final java.lang.String OBJECT_TYPE_SCRAPEABLE_FILE

See Also:

Constant Field Values

OBJECT_TYPE_SCRAPING_SESSION

public static final java.lang.String OBJECT_TYPE_SCRAPING_SESSION

See Also:

Constant Field Values

OBJECT_TYPE_SCRIPT

public static final java.lang.String OBJECT_TYPE_SCRIPT

See Also:

Constant Field Values

FOUND_IN_IDENTIFIER

public static final java.lang.String FOUND_IN_IDENTIFIER

See Also:

Constant Field Values

FOUND_IN_NAME

public static final java.lang.String FOUND_IN_NAME

See Also:

Constant Field Values

FOUND_IN_NOTES

public static final java.lang.String FOUND_IN_NOTES

See Also:

Constant Field Values

FOUND_IN_NOTE

public static final java.lang.String FOUND_IN_NOTE

See Also:

Constant Field Values

FOUND_IN_KEY_STORE_FILE_PATH

public static final java.lang.String FOUND_IN_KEY_STORE_FILE_PATH

See Also:

Constant Field Values

FOUND_IN_KEY_STORE_PASSWORD

public static final java.lang.String FOUND_IN_KEY_STORE_PASSWORD

See Also:

Constant Field Values

FOUND_IN_PROXY_USERNAME

public static final java.lang.String FOUND_IN_PROXY_USERNAME

See Also:

Constant Field Values

FOUND_IN_PROXY_PASSWORD

public static final java.lang.String FOUND_IN_PROXY_PASSWORD

See Also:

Constant Field Values

FOUND_IN_PROXY_HOST

public static final java.lang.String FOUND_IN_PROXY_HOST

See Also:

Constant Field Values

FOUND_IN_PROXY_PORT

public static final java.lang.String FOUND_IN_PROXY_PORT

See Also:

Constant Field Values

FOUND_IN_NT_PROXY_USERNAME

public static final java.lang.String FOUND_IN_NT_PROXY_USERNAME

See Also:

Constant Field Values

FOUND_IN_NT_PROXY_PASSWORD

public static final java.lang.String FOUND_IN_NT_PROXY_PASSWORD

See Also:

Constant Field Values

FOUND_IN_NT_PROXY_HOST

public static final java.lang.String FOUND_IN_NT_PROXY_HOST

See Also:

Constant Field Values

FOUND_IN_NT_PROXY_DOMAIN

public static final java.lang.String FOUND_IN_NT_PROXY_DOMAIN

See Also:

Constant Field Values

FOUND_IN_PATTERN_TEXT

public static final java.lang.String FOUND_IN_PATTERN_TEXT

See Also:

Constant Field Values

FOUND_IN_SCRIPT_TEXT

public static final java.lang.String FOUND_IN_SCRIPT_TEXT

See Also:

Constant Field Values

FOUND_IN_URL

public static final java.lang.String FOUND_IN_URL

See Also:

Constant Field Values

FOUND_IN_AUTHENTICATION_USERNAME

public static final java.lang.String FOUND_IN_AUTHENTICATION_USERNAME

See Also:

Constant Field Values

FOUND_IN_AUTHENTICATION_PASSWORD

public static final java.lang.String FOUND_IN_AUTHENTICATION_PASSWORD

See Also:

Constant Field Values

FOUND_IN_HTTP_PARAMETER_KEY

public static final java.lang.String FOUND_IN_HTTP_PARAMETER_KEY

See Also:

Constant Field Values

FOUND_IN_HTTP_PARAMETER_VALUE

public static final java.lang.String FOUND_IN_HTTP_PARAMETER_VALUE

See Also:

Constant Field Values

FOUND_IN_HTTP_HEADER_KEY

public static final java.lang.String FOUND_IN_HTTP_HEADER_KEY

See Also:

Constant Field Values

FOUND_IN_HTTP_HEADER_VALUE

public static final java.lang.String FOUND_IN_HTTP_HEADER_VALUE

See Also:

Constant Field Values

FOUND_IN_LAST_REQUEST

public static final java.lang.String FOUND_IN_LAST_REQUEST

See Also:

Constant Field Values

FOUND_IN_LAST_RESPONSE

public static final java.lang.String FOUND_IN_LAST_RESPONSE

See Also:

Constant Field Values

FOUND_IN_LOG

public static final java.lang.String FOUND_IN_LOG

See Also:

Constant Field Values

FOUND_IN_CONTENT

public static final java.lang.String FOUND_IN_CONTENT

See Also:

Constant Field Values

FOUND_IN_REQUEST_LINE

public static final java.lang.String FOUND_IN_REQUEST_LINE

See Also:

Constant Field Values

FOUND_IN_REQUEST_HEADER_KEY

public static final java.lang.String FOUND_IN_REQUEST_HEADER_KEY

See Also:

Constant Field Values

FOUND_IN_REQUEST_HEADER_VALUE

public static final java.lang.String FOUND_IN_REQUEST_HEADER_VALUE

See Also:

Constant Field Values

FOUND_IN_POST_DATA

public static final java.lang.String FOUND_IN_POST_DATA

See Also:

Constant Field Values

FOUND_IN_RESPONSE_STATUS_LINE

public static final java.lang.String FOUND_IN_RESPONSE_STATUS_LINE

See Also:

Constant Field Values

FOUND_IN_RESPONSE_HEADER_KEY

public static final java.lang.String FOUND_IN_RESPONSE_HEADER_KEY

See Also:

Constant Field Values

FOUND_IN_RESPONSE_HEADER_VALUE

public static final java.lang.String FOUND_IN_RESPONSE_HEADER_VALUE

See Also:

Constant Field Values

FOUND_IN_RESPONSE_BODY

public static final java.lang.String FOUND_IN_RESPONSE_BODY

See Also:

Constant Field Values

Constructor Detail

GlobalSearchResult

public GlobalSearchResult(int objectID,
                          java.lang.String objectName,
                          java.lang.String objectType,
                          java.lang.String foundIn,
                          java.lang.String textToSearch,
                          int numMatches)

Method Detail

getObjectName

@Nullable
public java.lang.String getObjectName()

getObjectType

@Nullable
public java.lang.String getObjectType()

getFoundIn

@Nullable
public java.lang.String getFoundIn()

getObjectID

public int getObjectID()

getNumMatches

public int getNumMatches()

getObjectSequence

public int getObjectSequence()

setObjectSequence

public void setObjectSequence(int objectSequence)

getStartPoint

public int getStartPoint()

setStartPoint

public void setStartPoint(int startPoint)

getTextToSearch

@Nullable
public java.lang.String getTextToSearch()

setTextToSearch

public void setTextToSearch(java.lang.String textToSearch)

getProxySearchResult

@Nullable
public ProxySearchResult getProxySearchResult()

setProxySearchResult

public void setProxySearchResult(ProxySearchResult proxySearchResult)

getHeaderName

@Nullable
public java.lang.String getHeaderName()

setHeaderName

public void setHeaderName(java.lang.String headerName)

generateGlobalSearchResult

@Nullable
public static GlobalSearchResult generateGlobalSearchResult(@Nullable
                                                                       java.lang.String textToSearch,
                                                                       @Nullable
                                                                       java.lang.String textToFind,
                                                                       java.lang.String objectName,
                                                                       int columnID,
                                                                       java.lang.String objectType,
                                                                       java.lang.String foundInColumn,
                                                                       boolean isCaseSensitive)

Parameters:

textToSearch - The text to search.

textToFind - The text to find.

objectName - The name of object.

columnID - The ID of the db record.

objectType - The type of object.

foundInColumn - The column containing the found text.

isCaseSensitive - Case sensitive?

Returns:

The result