org.gcube.opensearch.opensearchoperator

Class QueryParser

java.lang.Object

org.gcube.opensearch.opensearchoperator.QueryParser

public class QueryParser
extends Object

An OpenSearch query parser, responsible for parsing and processing an OpenSearch query and a set of fixed parameters. After processing, a mapping of parameter names and values both for query and fixed parameters, as well as a set of all namespaces present in the parameters are available

Author:

gerasimos.farantatos, NKUA

Constructor Summary

Constructors

Constructor and Description
QueryParser(String queryString, String[] fixedParams) Creates a new instance and processes the query and fixed parameter strings

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getFixedParamsMap() Retrieves all fixed parameter name-value mappings
String	getFixedTerms() Retrieves the fixed parameter corresponding to the searchTerms standard OpenSearch parameter
Set<String>	getNamespaces() Retrieves all namespaces present in the OpenSearch query and the fixed parameters
Map<String,String>	getParams() Retrieves all parameter name-value mappings
String	getTerms() Retrieves the search terms, as specified by the searchTerms standard OpenSearch parameter

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryParser

public QueryParser(String queryString,
           String[] fixedParams)
            throws UnsupportedEncodingException

Creates a new instance and processes the query and fixed parameter strings

Parameters:

queryString - The OpenSearch operator query string

fixedParams - The fixed parameters array

Throws:

UnsupportedEncodingException - If the encoding used to decode the encoded namespace prefixes is not supported

Method Detail

getTerms

public String getTerms()

Retrieves the search terms, as specified by the searchTerms standard OpenSearch parameter

Returns:

The search terms

getParams

public Map<String,String> getParams()

Retrieves all parameter name-value mappings

Returns:

All parameters and their corresponding values

getFixedTerms

public String getFixedTerms()

Retrieves the fixed parameter corresponding to the searchTerms standard OpenSearch parameter

Returns:

The fixed search terms

getFixedParamsMap

public Map<String,String> getFixedParamsMap()

Retrieves all fixed parameter name-value mappings

Returns:

All fixed parameters and their corresponding values

getNamespaces

public Set<String> getNamespaces()

Retrieves all namespaces present in the OpenSearch query and the fixed parameters

Returns:

The namespaces found