|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator
public abstract class QueryElementDecorator
Constructor Summary | |
---|---|
QueryElementDecorator(QueryElement el)
|
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 |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public QueryElementDecorator(QueryElement el)
Method Detail |
---|
public void parse() throws java.lang.Exception
parse
in interface QueryElement
java.lang.Exception
- If the query element is not valid according to the OpenSearch specification or in case of other errorQueryElement.parse()
public java.lang.String getRole() throws java.lang.Exception
getRole
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getRole()
public java.lang.String getTitle() throws java.lang.Exception
getTitle
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getTitle()
public java.lang.String getTotalResults() throws java.lang.Exception
getTotalResults
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getTotalResults()
public java.lang.String getSearchTerms() throws java.lang.Exception
getSearchTerms
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getSearchTerms()
public java.lang.String getCount() throws java.lang.Exception
getCount
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getCount()
public java.lang.String getStartIndex() throws java.lang.Exception
getStartIndex
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getStartIndex()
public java.lang.String getStartPage() throws java.lang.Exception
getStartPage
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getStartPage()
public java.lang.String getLanguage() throws java.lang.Exception
getLanguage
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getLanguage()
public java.lang.String getInputEncoding() throws java.lang.Exception
getInputEncoding
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getInputEncoding()
public java.lang.String getOutputEncoding() throws java.lang.Exception
getOutputEncoding
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.getOutputEncoding()
public boolean describesExampleQuery() throws java.lang.Exception
describesExampleQuery
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.describesExampleQuery()
public java.util.Map<java.lang.String,java.lang.String> getQueryParameters() throws java.lang.Exception
getQueryParameters
in interface QueryElement
java.lang.Exception
- In case of errorQueryElement.getQueryParameters()
public boolean isRoleSupported() throws java.lang.Exception
isRoleSupported
in interface QueryElement
java.lang.Exception
- If the query element is not initialized or in case of other errorQueryElement.isRoleSupported()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |