org.gcube.opensearch.opensearchlibrary.queryelements
Interface QueryElement

All Known Implementing Classes:
BasicQueryElement, GeoQueryElement, QueryElementDecorator, SRUQueryElement, TimeQueryElement

public interface QueryElement

Interface of the Query Element class that is used to process Query elements contained in a DescriptionDocument

Author:
gerasimos.farantatos

Method Summary
 boolean describesExampleQuery()
          Determines whethe the query element describes an example query
 java.lang.String getCount()
          Returns the value of the count OpenSearch parameter contained in the query element
 java.lang.String getInputEncoding()
          Returns the value of the inputEncoding OpenSearch parameter contained in the query element
 java.lang.String getLanguage()
          Returns the value of the language OpenSearch parameter contained in the query element
 java.lang.String getOutputEncoding()
          Returns the value of the outputEncoding OpenSearch parameter contained in the query element
 java.util.Map<java.lang.String,java.lang.String> getQueryParameters()
          Returns all parameters contained in the query element along with their corresponding values
 java.lang.String getRole()
          Returns the role of the search request described in the query element
 java.lang.String getSearchTerms()
          Returns the value of the searchTerms OpenSearch parameter contained in the query element
 java.lang.String getStartIndex()
          Returns the value of the startIndex OpenSearch parameter contained in the query element
 java.lang.String getStartPage()
          Returns the value of the startPage OpenSearch parameter contained in the query element
 java.lang.String getTitle()
          Returns a description describing the search request described in the query element
 java.lang.String getTotalResults()
          Returns the expected number of results that will be returned if the search request contained in the query element were made
 boolean isRoleSupported()
          Determines whether the query element supports the query role provided
 void parse()
          Processes a query element
 

Method Detail

parse

void parse()
           throws java.lang.Exception
Processes a query element

Throws:
java.lang.Exception - If the query element is not valid according to the OpenSearch specification or in case of other error

getRole

java.lang.String getRole()
                         throws java.lang.Exception
Returns the role of the search request described in the query element

Returns:
The role of the search request
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getTitle

java.lang.String getTitle()
                          throws java.lang.Exception
Returns a description describing the search request described in the query element

Returns:
A description of the search request
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getTotalResults

java.lang.String getTotalResults()
                                 throws java.lang.Exception
Returns the expected number of results that will be returned if the search request contained in the query element were made

Returns:
The expected number of results
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getSearchTerms

java.lang.String getSearchTerms()
                                throws java.lang.Exception
Returns the value of the searchTerms OpenSearch parameter contained in the query element

Returns:
The value of the searchTerms parameter
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getCount

java.lang.String getCount()
                          throws java.lang.Exception
Returns the value of the count OpenSearch parameter contained in the query element

Returns:
The value of the count parameter
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getStartIndex

java.lang.String getStartIndex()
                               throws java.lang.Exception
Returns the value of the startIndex OpenSearch parameter contained in the query element

Returns:
The value of the startIndex parameter
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getStartPage

java.lang.String getStartPage()
                              throws java.lang.Exception
Returns the value of the startPage OpenSearch parameter contained in the query element

Returns:
The value of the startPage parameter
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getLanguage

java.lang.String getLanguage()
                             throws java.lang.Exception
Returns the value of the language OpenSearch parameter contained in the query element

Returns:
The value of the language parameter
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getInputEncoding

java.lang.String getInputEncoding()
                                  throws java.lang.Exception
Returns the value of the inputEncoding OpenSearch parameter contained in the query element

Returns:
The value of the inputEncoding parameter
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getOutputEncoding

java.lang.String getOutputEncoding()
                                   throws java.lang.Exception
Returns the value of the outputEncoding OpenSearch parameter contained in the query element

Returns:
The value of the outputEncoding parameter
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

describesExampleQuery

boolean describesExampleQuery()
                              throws java.lang.Exception
Determines whethe the query element describes an example query

Returns:
true if the query element describes an example query, false otherwise
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error

getQueryParameters

java.util.Map<java.lang.String,java.lang.String> getQueryParameters()
                                                                    throws java.lang.Exception
Returns all parameters contained in the query element along with their corresponding values

Returns:
All parameters-value pairs contained in the query element
Throws:
java.lang.Exception - In case of error

isRoleSupported

boolean isRoleSupported()
                        throws java.lang.Exception
Determines whether the query element supports the query role provided

Returns:
true if the query element supports the role provided, false otherwise
Throws:
java.lang.Exception - If the query element is not initialized or in case of other error