Package org.codice.ddf.opensearch.endpoint

Class OpenSearchEndpoint

java.lang.Object

org.codice.ddf.opensearch.endpoint.OpenSearchEndpoint

All Implemented Interfaces:

OpenSearch

@Path("/")
public class OpenSearchEndpoint
extends Object
implements OpenSearch

Constructor Summary

Constructors

Constructor	Description
OpenSearchEndpoint(ddf.catalog.CatalogFramework framework, ddf.catalog.filter.FilterBuilder filterBuilder)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	processQuery(String searchTerms, String maxResults, String sources, String maxTimeout, String startIndex, String count, String geometry, String bbox, String polygon, String lat, String lon, String radius, String dateStart, String dateEnd, String dateOffset, String sort, String format, String selectors, javax.ws.rs.core.UriInfo ui, String type, String versions, javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchEndpoint

public OpenSearchEndpoint(ddf.catalog.CatalogFramework framework,
 ddf.catalog.filter.FilterBuilder filterBuilder)

Method Details

processQuery

@GET
public javax.ws.rs.core.Response processQuery(@QueryParam("q")
 String searchTerms,
 @QueryParam("mr")
 String maxResults,
 @QueryParam("src")
 String sources,
 @QueryParam("mt")
 String maxTimeout,
 @QueryParam("start")
 String startIndex,
 @QueryParam("count")
 String count,
 @QueryParam("geometry")
 String geometry,
 @QueryParam("bbox")
 String bbox,
 @QueryParam("polygon")
 String polygon,
 @QueryParam("lat")
 String lat,
 @QueryParam("lon")
 String lon,
 @QueryParam("radius")
 String radius,
 @QueryParam("dtstart")
 String dateStart,
 @QueryParam("dtend")
 String dateEnd,
 @QueryParam("dtoffset")
 String dateOffset,
 @QueryParam("sort")
 String sort,
 @QueryParam("format")
 String format,
 @QueryParam("selector")
 String selectors,
 @Context
 javax.ws.rs.core.UriInfo ui,
 @QueryParam("type")
 String type,
 @QueryParam("version")
 String versions,
 @Context
 javax.servlet.http.HttpServletRequest request)

Specified by:

processQuery in interface OpenSearch

Parameters:

searchTerms - Space-delimited list of search terms.

maxResults - Maximum # of results to return. If count is also specified, the count value will take precedence over the maxResults value

sources - Comma-delimited list of data sources to query (default: default sources selected).

maxTimeout - Maximum timeout (msec) for query to respond (default: mt=30000).

startIndex - Index of first result to return. Integer >= 0 (default: start=1).

count - Number of results to retrieve per page (default: count=10).

geometry - WKT Geometries.

bbox - Comma-delimited list of lat/lon (deg) bounding box coordinates (geo format: geo:bbox ~ West,South,East,North).

polygon - Comma-delimited list of lat/lon (deg) pairs, in clockwise order around the polygon, with the last point being the same as the first in order to close the polygon.

lat - Latitude in decimal degrees (typical GPS receiver WGS84 coordinates).

lon - Longitude in decimal degrees (typical GPS receiver WGS84 coordinates).

radius - The radius (m) parameter, used with the lat and lon parameters, specifies the search distance from this point (default: radius=5000).

dateStart - Specifies the beginning of the time slice of the search on the modified time field (RFC-3339 - Date and Time format, i.e. YYYY-MM-DDTHH:mm:ssZ). Default value of "1970-01-01T00:00:00Z" is used when dtend is indicated but dtstart is not specified

dateEnd - Specifies the ending of the time slice of the search on the modified time field (RFC-3339 - Date and Time format, i.e. YYYY-MM-DDTHH:mm:ssZ). Current GMT date/time is used when dtstart is specified but not dtend.

dateOffset - Specifies an offset, backwards from the current time, to search on the modified time field for entries. Defined in milliseconds.

sort - Specifies sort by field as sort=:, where may be 'date' or 'relevance' (default is 'relevance'). The conditional param is optional but has a value of 'asc' or 'desc' (default is 'desc'). When is 'relevance', must be 'desc'.

format - Defines the format that the return type should be in. (example:atom, html)

selectors - Defines a comma-delimited list of XPath selectors to narrow the query.

type - Specifies the type of data to search for. (example: nitf)

versions - Specifies the versions in a comma-delimited list.