ddf.catalog.source.opensearch.impl

Class OpenSearchParserImpl

java.lang.Object

ddf.catalog.source.opensearch.impl.OpenSearchParserImpl

All Implemented Interfaces:

OpenSearchParser

public class OpenSearchParserImpl
extends Object
implements OpenSearchParser

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEARCH_TERMS

Constructor Summary

Constructors

Constructor and Description
OpenSearchParserImpl()

Method Summary

Modifier and Type	Method and Description
void	populateContextual(org.apache.cxf.jaxrs.client.WebClient client, Map<String,String> searchPhraseMap, List<String> parameters) Fills in the OpenSearch query URL with contextual information (Note: Section 2.2 - Query: The OpenSearch specification does not define a syntax for its primary query parameter, searchTerms, but it is generally used to support simple keyword queries.)
void	populateGeospatial(org.apache.cxf.jaxrs.client.WebClient client, SpatialDistanceFilter spatial, boolean shouldConvertToBBox, List<String> parameters) Fills in the OpenSearch query URL with geospatial information (poly, lat, lon, and radius).
void	populateGeospatial(org.apache.cxf.jaxrs.client.WebClient client, SpatialFilter spatial, boolean shouldConvertToBBox, List<String> parameters) Fills in the OpenSearch query URL with geospatial information (poly, lat, lon, and radius).
void	populateSearchOptions(org.apache.cxf.jaxrs.client.WebClient client, QueryRequest queryRequest, Subject subject, List<String> parameters) Populates general site information.
void	populateTemporal(org.apache.cxf.jaxrs.client.WebClient client, TemporalFilter temporal, List<String> parameters) Fills in the OpenSearch query URL with temporal information (Start, End, and Name).

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_TERMS

public static final String SEARCH_TERMS

See Also:

Constant Field Values

Constructor Detail

OpenSearchParserImpl

public OpenSearchParserImpl()

Method Detail

populateSearchOptions

public void populateSearchOptions(org.apache.cxf.jaxrs.client.WebClient client,
                                  QueryRequest queryRequest,
                                  Subject subject,
                                  List<String> parameters)

Description copied from interface: OpenSearchParser

Populates general site information.

Specified by:

populateSearchOptions in interface OpenSearchParser

Parameters:

client - - OpenSearch URL to populate

queryRequest - - The query request from which to populate the search options

subject - - The subject associated with the query

parameters - - the given OpenSearch parameters

populateContextual

public void populateContextual(org.apache.cxf.jaxrs.client.WebClient client,
                               Map<String,String> searchPhraseMap,
                               List<String> parameters)

Description copied from interface: OpenSearchParser

Fills in the OpenSearch query URL with contextual information (Note: Section 2.2 - Query: The OpenSearch specification does not define a syntax for its primary query parameter, searchTerms, but it is generally used to support simple keyword queries.)

Specified by:

populateContextual in interface OpenSearchParser

Parameters:

client - - OpenSearch URL to populate

searchPhraseMap - - a map of search queries

parameters - - the given OpenSearch parameters

populateTemporal

public void populateTemporal(org.apache.cxf.jaxrs.client.WebClient client,
                             TemporalFilter temporal,
                             List<String> parameters)

Description copied from interface: OpenSearchParser

Fills in the OpenSearch query URL with temporal information (Start, End, and Name). Currently name is empty due to incompatibility with endpoints.

Specified by:

populateTemporal in interface OpenSearchParser

Parameters:

client - - OpenSearch URL to populate

temporal - - the TemporalFilter that contains the temporal information

parameters - - the given OpenSearch parameters

populateGeospatial

public void populateGeospatial(org.apache.cxf.jaxrs.client.WebClient client,
                               SpatialDistanceFilter spatial,
                               boolean shouldConvertToBBox,
                               List<String> parameters)
                        throws UnsupportedQueryException

Description copied from interface: OpenSearchParser

Fills in the OpenSearch query URL with geospatial information (poly, lat, lon, and radius).

Specified by:

populateGeospatial in interface OpenSearchParser

Parameters:

client - - OpenSearch URL to populate

spatial - - SpatialDistanceFilter that contains the spatial data

shouldConvertToBBox - - true if the SpatialFilter should be converted to a Bounding Box

parameters - - the given OpenSearch parameters

Throws:

UnsupportedQueryException

populateGeospatial

public void populateGeospatial(org.apache.cxf.jaxrs.client.WebClient client,
                               SpatialFilter spatial,
                               boolean shouldConvertToBBox,
                               List<String> parameters)
                        throws UnsupportedQueryException

Description copied from interface: OpenSearchParser

Fills in the OpenSearch query URL with geospatial information (poly, lat, lon, and radius).

Specified by:

populateGeospatial in interface OpenSearchParser

Parameters:

client - - OpenSearch URL to populate

spatial - - SpatialFilter that contains the spatial data

shouldConvertToBBox - - true if the SpatialFilter should be converted to a Bounding Box

parameters - - the given OpenSearch parameters

Throws:

UnsupportedQueryException