A C D E F G H I M N O P Q R S T U X

A

ALL - Static variable in class net.sf.gsaapi.constants.Access

all results (secure and non-secure)

Access - class net.sf.gsaapi.constants.Access.

This class is a Java2 style enumeration implementation.

addField(String, String) - Method in class net.sf.gsaapi.GSAResult

Add an "additional" field-value pair.

addFileType(String, boolean) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

Add a term to filetypes inclusion/exclusion list.

addInTitle(String, boolean) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

add a term to titles inclusion/exclusion list.

addInUrl(String, boolean) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

add a term to url inclusion/exclusion list.

addMeta(String, String) - Method in class net.sf.gsaapi.GSAResult

Add a meta field value pair.

appendMappedQueryParams(StringBuffer, String, Map, String) - Static method in class net.sf.gsaapi.util.Util

For example, appends "¶m=key1:value1|key2:value2|key3:value3" to the specified StringBuffer.

appendQueryParam(StringBuffer, String, String) - Static method in class net.sf.gsaapi.util.Util

For example, appends "¶m=value" to StringBuffer.

appendQueryParam(StringBuffer, String, String[]) - Static method in class net.sf.gsaapi.util.Util

invokes appendQueryParam(StringBuffer, String, String) on each of the values.

C

characters(char[], int, int) - Method in class net.sf.gsaapi.ResponseBuilder

overridden characters from DefaultHandler

D

DEFAULT_PATH - Static variable in class net.sf.gsaapi.GSAClient

default path used by contructor that allows you to skip speciyfing the path

DEFAULT_PORT - Static variable in class net.sf.gsaapi.GSAClient

default port number used by constructor that allows you to skip specifying the port

DEFAULT_PROTOCOL - Static variable in class net.sf.gsaapi.GSAClient

default protocol used by constructor that allows you to skip specifying the protocol

DUPLICATE_DIRECTORY_FILTER - Static variable in class net.sf.gsaapi.constants.Filter

Only "Duplicate directory" filtering should be performed

DUPLICATE_SNIPPET_FILTER - Static variable in class net.sf.gsaapi.constants.Filter

Only "Duplicate snippet" filtering should be performed

E

ENTIRE_PAGE - Static variable in class net.sf.gsaapi.constants.SearchScope

Search for the query terms anywhere in the page.

encode(String) - Static method in class net.sf.gsaapi.util.Util

url encodes but catches UnsupportedEncodingException (since we know that will never be thrown).

endElement(String, String, String) - Method in class net.sf.gsaapi.ResponseBuilder

overridden endElement from DefaultHandler

equals(Object) - Method in class net.sf.gsaapi.constants.Access

equals(Object) - Method in class net.sf.gsaapi.constants.Filter

equals(Object) - Method in class net.sf.gsaapi.constants.OutputFormat

equals(Object) - Method in class net.sf.gsaapi.constants.SearchScope

escape(String, String) - Static method in class net.sf.gsaapi.util.Util

returns defolt if the URLEncoder.encode(str, "UTF-8") call fails.

F

FULL_FILTER - Static variable in class net.sf.gsaapi.constants.Filter

specifies that both "Duplicate directory" and "Duplicate snippet" filtering should be performed

Filter - class net.sf.gsaapi.constants.Filter.

This class is a Java2 style enumeration implementation.

filter(String) - Method in class net.sf.gsaapi.util.QueryStringFilter

Returns the filtered queryString (Thus, only the params specified in the constructor are retained and other params are stripped out of the query string)

G

GSACacheQueryUtil - class net.sf.gsaapi.util.GSACacheQueryUtil.

This is a utility class for constructing the urls for retrieving the "cached" version of the document crawled by the GSA.

GSACacheQueryUtil(GSAClient, GSAQuery) - Constructor for class net.sf.gsaapi.util.GSACacheQueryUtil

Construct a GSACacheQueryUtil instance from the GSAClient and GSAQuery instances

GSAClient - class net.sf.gsaapi.GSAClient.

Use a GSAClient instance to fire queries to a specific GSA site.

GSAClient(String, String, int, String) - Constructor for class net.sf.gsaapi.GSAClient

GSAClient(String, int, String) - Constructor for class net.sf.gsaapi.GSAClient

overloaded constructor that sets the defaults: DEFAULT_PROTOCOL

GSAClient(String, String) - Constructor for class net.sf.gsaapi.GSAClient

overloaded constructor that sets the defaults: DEFAULT_PROTOCOL, DEFAULT_PORT

GSAClient(String) - Constructor for class net.sf.gsaapi.GSAClient

overloaded constructor that sets the defaults: DEFAULT_PROTOCOL, DEFAULT_PORT, DEFAULT_PATH

GSAClientDelegate - interface net.sf.gsaapi.GSAClientDelegate.

GSAClientDelegate allows specifying an implementation class that will handle the requests to a url and return the response.

GSAClientDemo - class net.sf.gsaapi.demo.GSAClientDemo.

A Java application demonstrating the use of the GSA-JAPI.

GSAClientDemo() - Constructor for class net.sf.gsaapi.demo.GSAClientDemo

GSAOneBoxResponse - class net.sf.gsaapi.GSAOneBoxResponse.

NOTE: OneBox support in this API is experimental only.

GSAOneBoxResponse() - Constructor for class net.sf.gsaapi.GSAOneBoxResponse

create the GSAOneBoxResponse instance.

GSAOneBoxResult - class net.sf.gsaapi.GSAOneBoxResult.

NOTE: OneBox support in this API is experimental only.

GSAOneBoxResult() - Constructor for class net.sf.gsaapi.GSAOneBoxResult

constructor is intended for internal use only.

GSAQuery - class net.sf.gsaapi.GSAQuery.

Encapsulates the query parameters to be sent to the GSA.

GSAQuery() - Constructor for class net.sf.gsaapi.GSAQuery

create an instance of GSAQuery.

GSAQuery.GSAQueryTerm - class net.sf.gsaapi.GSAQuery.GSAQueryTerm.

This class is required because the GSA query term supports a "special term" syntax.

GSAQuery.GSAQueryTerm(String) - Constructor for class net.sf.gsaapi.GSAQuery.GSAQueryTerm

Search for all the words specified in the query string (words are whitespace delimited in the string)

GSAQuery.GSAQueryTerm() - Constructor for class net.sf.gsaapi.GSAQuery.GSAQueryTerm

GSAResponse - class net.sf.gsaapi.GSAResponse.

The Java binding to the XML response received from querying the GSA.

GSAResponse() - Constructor for class net.sf.gsaapi.GSAResponse

constructor is intended for internal use only.

GSAResult - class net.sf.gsaapi.GSAResult.

The Java binding to the result element of the XML response received from querying the GSA.

GSAResult() - Constructor for class net.sf.gsaapi.GSAResult

constructor is intended for internal use only.

getCacheDocEncoding() - Method in class net.sf.gsaapi.GSAResult

If a cached version is available, the encoding of the cached document.

getCacheDocId() - Method in class net.sf.gsaapi.GSAResult

returns the cache identifier for the document.

getCacheDocSize() - Method in class net.sf.gsaapi.GSAResult

String representing the value of the cached documents approximate size.

getCacheDocUrl(GSAResult, boolean) - Method in class net.sf.gsaapi.util.GSACacheQueryUtil

returns a url pointing to the cached document if the cached document exists.

getEndIndex() - Method in class net.sf.gsaapi.GSAResponse

index of the last available result

getEscapedUrl() - Method in class net.sf.gsaapi.GSAResult

return the escaped url as returned by the GSA.

getField(String) - Method in class net.sf.gsaapi.GSAResult

Get the value for the "additional" field.

getFieldEntries() - Method in class net.sf.gsaapi.GSAOneBoxResult

returns the array of Entry objects correponding to the "field" entries in this GSAOneBoxResult instance.

getFields() - Method in class net.sf.gsaapi.GSAResult

get the map of "additional" fields associated with this result (if any).

getGSAResponse(GSAQuery) - Method in class net.sf.gsaapi.GSAClient

Returns the search results parsed and wrapped by GSAReponse instance.

getGSAResponse(String) - Method in class net.sf.gsaapi.GSAClient

Normally you should be using one of the overloaded "search(GSAQuery)" functions.

getHost() - Method in class net.sf.gsaapi.GSAClient

returns the value for the host parameter passed to the constructor

getImageSource() - Method in class net.sf.gsaapi.GSAOneBoxResponse

getIndentation() - Method in class net.sf.gsaapi.GSAResult

Get the suggested indentation level.

getLanguage() - Method in class net.sf.gsaapi.GSAResult

get the language associated with this result.

getMeta(String) - Method in class net.sf.gsaapi.GSAResult

get the value for the meta (custom) field.

getMetas() - Method in class net.sf.gsaapi.GSAResult

get the map of meta information associated with this result (if any).

getMimeType() - Method in class net.sf.gsaapi.GSAResult

Get the result mime type.

getModuleResults() - Method in class net.sf.gsaapi.GSAOneBoxResponse

getNextResponseUrl() - Method in class net.sf.gsaapi.GSAResponse

return the url to the next batch of responses

getNumResults() - Method in class net.sf.gsaapi.GSAResponse

number of results

getOneBoxResponses() - Method in class net.sf.gsaapi.GSAResponse

return the object that wraps the OneBox response

getParams() - Method in class net.sf.gsaapi.GSAResponse

meta field-values associated with this query-response

getPath() - Method in class net.sf.gsaapi.GSAClient

returns the value for the path parameter passed to the constructor

getPort() - Method in class net.sf.gsaapi.GSAClient

returns the value for the port parameter passed to the constructor

getPreviousResponseUrl() - Method in class net.sf.gsaapi.GSAResponse

return the url to the previous batch of responses

getProtocol() - Method in class net.sf.gsaapi.GSAClient

returns the value for the protocol parameter passed to the constructor

getProviderName() - Method in class net.sf.gsaapi.GSAOneBoxResponse

getQuery() - Method in class net.sf.gsaapi.GSAResponse

(canonical form of) the query that was made in order to get this response

getQueryString() - Method in class net.sf.gsaapi.GSAQuery

This method is mainly to facilicate automated testing.

getRating() - Method in class net.sf.gsaapi.GSAResult

0-10 relevance rating for this result.

getResponseStream(String) - Method in interface net.sf.gsaapi.GSAClientDelegate

Returns the InputStream pointing to the url specified.

getResults() - Method in class net.sf.gsaapi.GSAResponse

get list of results in this batch

getSearchTime() - Method in class net.sf.gsaapi.GSAResponse

how long did this search take (in seconds)

getStartIndex() - Method in class net.sf.gsaapi.GSAResponse

start index of the results with respect to first result for the query

getString(Object, String) - Static method in class net.sf.gsaapi.util.Util

calls the overloaded public method: getString(Object, String, boolean) with the value true for the boolean parameter

getString(Object, String, boolean) - Static method in class net.sf.gsaapi.util.Util

Returns obj.toString() if obj is not null and if the expression !

getSummary() - Method in class net.sf.gsaapi.GSAResult

get result summary.

getTitle() - Method in class net.sf.gsaapi.GSAResult

get result title.

getTitleLink() - Method in class net.sf.gsaapi.GSAOneBoxResponse

getTitleText() - Method in class net.sf.gsaapi.GSAOneBoxResponse

getUrl() - Method in class net.sf.gsaapi.GSAOneBoxResult

returns the url associated with this GSAOneBoxResult instance

getUrl() - Method in class net.sf.gsaapi.GSAResult

get url for the result.

getValue() - Method in class net.sf.gsaapi.GSAQuery

return the HTTP GET query string.

getValue() - Method in class net.sf.gsaapi.constants.Access

getValue() - Method in class net.sf.gsaapi.constants.Filter

getValue() - Method in class net.sf.gsaapi.constants.OutputFormat

getValue() - Method in class net.sf.gsaapi.constants.SearchScope

H

hashCode() - Method in class net.sf.gsaapi.constants.Access

hashCode() - Method in class net.sf.gsaapi.constants.Filter

hashCode() - Method in class net.sf.gsaapi.constants.OutputFormat

hashCode() - Method in class net.sf.gsaapi.constants.SearchScope

I

isFiltered() - Method in class net.sf.gsaapi.GSAResponse

true if result is automatically filtered

M

MAX_RESULTS - Static variable in class net.sf.gsaapi.GSAQuery

the absolute maximum number of results that a query can generate.

MAX_RESULTS_PER_QUERY - Static variable in class net.sf.gsaapi.GSAQuery

The maximum number of results to be fetched in one invokation of a query.

main(String[]) - Static method in class net.sf.gsaapi.demo.GSAClientDemo

no command line args expected.

N

NO_FILTER - Static variable in class net.sf.gsaapi.constants.Filter

specifies that no filtering should be performed

net.sf.gsaapi - package net.sf.gsaapi

net.sf.gsaapi.constants - package net.sf.gsaapi.constants

net.sf.gsaapi.demo - package net.sf.gsaapi.demo

net.sf.gsaapi.util - package net.sf.gsaapi.util

O

OutputFormat - class net.sf.gsaapi.constants.OutputFormat.

This class is a Java2 style enumeration implementation.

P

PUBLIC - Static variable in class net.sf.gsaapi.constants.Access

non-secure results

Q

QueryStringFilter - class net.sf.gsaapi.util.QueryStringFilter.

This is a simple utility to manipulate url query strings.

QueryStringFilter(String[]) - Constructor for class net.sf.gsaapi.util.QueryStringFilter

Constructor specifying the array of Strings representing the params that should be retained when filtering.

R

ResponseBuilder - class net.sf.gsaapi.ResponseBuilder.

This is the default response builder that the GSAClient will use in binding the XML response to Java objects.

S

SECURE - Static variable in class net.sf.gsaapi.constants.Access

"secure" results

SearchScope - class net.sf.gsaapi.constants.SearchScope.

This class is a Java2 style enumeration implementation.

search(GSAQuery) - Method in class net.sf.gsaapi.GSAClient

If a valid query does not result in any results, an empty List will be returned.

search(String) - Method in class net.sf.gsaapi.GSAClient

Normally, you should be using one of the overloaded "search(GSAQuery)" methods which internally call this method.

setAccess(Access) - Method in class net.sf.gsaapi.GSAQuery

restrict results to public or secure (or do not restrict) based on the value of the Access parameter.

setAllInTitle(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

all the terms specified must be in the page title.

setAllInUrl(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

all the terms specified must be in the page url.

setAndQueryTerms(String[]) - Method in class net.sf.gsaapi.GSAQuery

restrict search to documents containing all of the specified terms.

setCacheDocEncoding(String) - Method in class net.sf.gsaapi.GSAResult

set the value for encoding of the cached document.

setCacheDocId(String) - Method in class net.sf.gsaapi.GSAResult

set value for the cache identifier for the document.

setCacheDocSize(String) - Method in class net.sf.gsaapi.GSAResult

set the value for the cached documents approximate size.

setCachedDocument(String) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

search for cached document at specified location.

setClientDelegate(GSAClientDelegate) - Method in class net.sf.gsaapi.GSAClient

specify the GSAClientDelegate instance that will actually query the url and return an input stream to the response.

setDateRange(long, long) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

set a daterange filter.

setEscapedUrl(String) - Method in class net.sf.gsaapi.GSAResult

set the value for the escaped url String.

setExactPhraseQueryTerm(String) - Method in class net.sf.gsaapi.GSAQuery

search for the documents containing the exact specified phrase.

setExcludeFileType(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

Exclude documents with specified file extensions.

setFetchMetaFields(String[]) - Method in class net.sf.gsaapi.GSAQuery

Fetch specified META tags if they exist in the document.

setFields(Map) - Method in class net.sf.gsaapi.GSAResult

Set the "additional" field-values associated with this result if any.

setFilter(Filter) - Method in class net.sf.gsaapi.GSAQuery

Set the filter char code that indicates type of filtering to be performed.

setFrontend(String) - Method in class net.sf.gsaapi.GSAQuery

A string representing any valid frontend.

setInTitle(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

search for the specified strings in title.

setInUrl(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

search for the specified strings in url.

setIncludeFileType(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

Restrict search to specified file extensions.

setIndentation(int) - Method in class net.sf.gsaapi.GSAResult

set the indentation for this result item (suggestion).

setInputEncoding(String) - Method in class net.sf.gsaapi.GSAQuery

Set input encoding (advanced use only)

setLanguage(String) - Method in class net.sf.gsaapi.GSAQuery

Restrict search to pages in specified languages only.

setLanguage(String) - Method in class net.sf.gsaapi.GSAResult

set the language that the result is supposed to be of.

setMaxResults(int) - Method in class net.sf.gsaapi.GSAQuery

Restrict search results to these many at most.

setMetas(Map) - Method in class net.sf.gsaapi.GSAResult

set the meta field-values associated with this result if any.

setMimeType(String) - Method in class net.sf.gsaapi.GSAResult

Mime type of the result.

setNotInTitle(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

remove results that contain specified terms in title

setNotInUrl(List) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

setNumKeyMatches(byte) - Method in class net.sf.gsaapi.GSAQuery

Number of keymatches in a document (max value accepted by GSA is 5).

setOrQueryTerms(String[]) - Method in class net.sf.gsaapi.GSAQuery

search documents containing any or all of specified terms.

setOutputEncoding(String) - Method in class net.sf.gsaapi.GSAQuery

Set output encoding (advanced use only)

setOutputFormat(OutputFormat) - Method in class net.sf.gsaapi.GSAQuery

setPartialMetaFields(Properties) - Method in class net.sf.gsaapi.GSAQuery

Calls GSAQuery.setPartialMetaFields(Properties, boolean) with the boolean argument set to true.

setPartialMetaFields(Properties, boolean) - Method in class net.sf.gsaapi.GSAQuery

Set the meta fields based filtering criteria.

setProxyReload(boolean) - Method in class net.sf.gsaapi.GSAQuery

Setting this to true forces reloading of the proxystylesheet by the GSA server.

setProxycustom(String) - Method in class net.sf.gsaapi.GSAQuery

sets the proxycustom url param.

setProxystylesheet(String) - Method in class net.sf.gsaapi.GSAQuery

set the value for proxystylesheet.

setProxystylesheet(String) - Method in class net.sf.gsaapi.util.GSACacheQueryUtil

If set, the returned url link contains the following substring: "proxystylesheet=<value>" where <value> is the value passed to this method.

setQueryString(String) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

set the queryString.

setQueryTerm(GSAQuery.GSAQueryTerm) - Method in class net.sf.gsaapi.GSAQuery

setRating(int) - Method in class net.sf.gsaapi.GSAResult

Relevance rating as returned.

setRequiredMetaFields(Properties) - Method in class net.sf.gsaapi.GSAQuery

Calls GSAQuery.setRequiredMetaFields(Properties, boolean) with the boolean argument set to true.

setRequiredMetaFields(Properties, boolean) - Method in class net.sf.gsaapi.GSAQuery

Set the meta fields based filtering criteria.

setScrollAhead(int) - Method in class net.sf.gsaapi.GSAQuery

scroll ahead to display (n+1)th result as the first result.

setSearchScope(SearchScope) - Method in class net.sf.gsaapi.GSAQuery

Indicate part of page to which the search is to be restricted.

setSite(String, boolean) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

Set the site (domain) for inclusion or exclusion.

setSiteCollections(String[]) - Method in class net.sf.gsaapi.GSAQuery

Restrict search to exclude documents from specified "siteCollections".

setSortByDate(boolean, char) - Method in class net.sf.gsaapi.GSAQuery

sort by date (default sorted by "relevance") and in the specified sort-direction and mode If this method is invoked, the returned results also contain a custom field named "date" with the date value specified in YYYY-MM-DD formatted string.

setSummary(String) - Method in class net.sf.gsaapi.GSAResult

Set the result summary.

setTitle(String) - Method in class net.sf.gsaapi.GSAResult

Set the result title.

setUrl(String) - Method in class net.sf.gsaapi.GSAResult

Set the content url for the result.

setWebDocument(String) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

search for document at specified location.

setWithLinksTo(String) - Method in class net.sf.gsaapi.GSAQuery.GSAQueryTerm

search for documents linking to specified document (url string).

startDocument() - Method in class net.sf.gsaapi.ResponseBuilder

overridden startDocument from DefaultHandler

startElement(String, String, String, Attributes) - Method in class net.sf.gsaapi.ResponseBuilder

overridden startElement from DefaultHandler

stringSeparated(List, String, String) - Static method in class net.sf.gsaapi.util.Util

Given a list of string tokens, returns the string <prefix><token1><delim><prefix><token2><delim><prefix><tokenN> .

stringSeparated(String[], String, String) - Static method in class net.sf.gsaapi.util.Util

overloaded form of stringSeparated(List, String, String) that takes String[] instead of List

T

TITLE - Static variable in class net.sf.gsaapi.constants.SearchScope

Search for the query terms in document title only.

toHtmlCode(char) - Static method in class net.sf.gsaapi.util.Util

converts the character to HTML entity &#c; where c is the integer value of the character.

toJulian(Date) - Static method in class net.sf.gsaapi.util.Util

Converts a java.util.Date instance to a long value representing the Julian Day Number.

toString() - Method in class net.sf.gsaapi.GSAResponse

to aid in debugging

toString() - Method in class net.sf.gsaapi.GSAResult

toString method: creates a String representation of the object

U

URL - Static variable in class net.sf.gsaapi.constants.SearchScope

Search for the query terms in document url only.

Util - class net.sf.gsaapi.util.Util.

Utilities class.

Util() - Constructor for class net.sf.gsaapi.util.Util

unsetSortByDate() - Method in class net.sf.gsaapi.GSAQuery

This method removes any sort-value set by previous calls to setSortByDate.

X

XML - Static variable in class net.sf.gsaapi.constants.OutputFormat

specifies that results should be in XML

XML_NO_DTD - Static variable in class net.sf.gsaapi.constants.OutputFormat

specifies that the results should be in xml, and no DTD be included in the xml document.

A C D E F G H I M N O P Q R S T U X