public interface OpenSearchParser
QueryRequest
into an OpenSearch URL
This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.
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).
|
void populateSearchOptions(org.apache.cxf.jaxrs.client.WebClient client, QueryRequest queryRequest, Subject subject, List<String> parameters)
client
- - OpenSearch URL to populatequeryRequest
- - The query request from which to populate the search optionssubject
- - The subject associated with the queryparameters
- - the given OpenSearch parametersvoid populateContextual(org.apache.cxf.jaxrs.client.WebClient client, Map<String,String> searchPhraseMap, List<String> parameters)
client
- - OpenSearch URL to populatesearchPhraseMap
- - a map of search queriesparameters
- - the given OpenSearch parametersvoid populateTemporal(org.apache.cxf.jaxrs.client.WebClient client, TemporalFilter temporal, List<String> parameters)
client
- - OpenSearch URL to populatetemporal
- - the TemporalFilter that contains the temporal informationparameters
- - the given OpenSearch parametersvoid populateGeospatial(org.apache.cxf.jaxrs.client.WebClient client, SpatialDistanceFilter spatial, boolean shouldConvertToBBox, List<String> parameters) throws UnsupportedQueryException
client
- - OpenSearch URL to populatespatial
- - SpatialDistanceFilter that contains the spatial datashouldConvertToBBox
- - true if the SpatialFilter should be converted to a Bounding Boxparameters
- - the given OpenSearch parametersUnsupportedQueryException
void populateGeospatial(org.apache.cxf.jaxrs.client.WebClient client, SpatialFilter spatial, boolean shouldConvertToBBox, List<String> parameters) throws UnsupportedQueryException
client
- - OpenSearch URL to populatespatial
- - SpatialFilter that contains the spatial datashouldConvertToBBox
- - true if the SpatialFilter should be converted to a Bounding Boxparameters
- - the given OpenSearch parametersUnsupportedQueryException
This work is licensed under a Creative Commons Attribution 4.0 International License.