oracle.ide.index

Interface QueryResult

public interface QueryResult

A result from an index query. This consists of the URL containing the result, as well as the offset and length of the result within the file.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() Deprecated. if there is more than one key, the result must match all the criteria. So this method is not useful.
int	getLength() Get the length of the result.
int	getOffset() Get the offset of the result within the file.
java.net.URL	getURL() Get the URL of the file containing the result.

Method Detail

getKey

@Deprecated
java.lang.String getKey()

Deprecated. if there is more than one key, the result must match all the criteria. So this method is not useful.

The index key matching this result.

Returns:

the index key matching this result

getURL

java.net.URL getURL()

Get the URL of the file containing the result.

Returns:

the URL containing the result

getOffset

int getOffset()

Get the offset of the result within the file. This can be -1 for some criteria that do not have a location, such as file name.

Returns:

the offset of the result, or -1 if the result does not have a location

getLength

int getLength()

Get the length of the result. This can be -1 for some criteria that do not have a location, such as file name.

Returns:

the length of the result, or -1 if the result does not have a location