|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder
public class BasicQueryBuilder
Query builder class that implements the QueryBuilder interface, providing standard OpenSearch parameter functionality.
Constructor Summary | |
---|---|
BasicQueryBuilder(URLTemplate template,
java.lang.String startIndexDef,
java.lang.String startPageDef)
Creates a new BasicQueryBuilder operating on a URL template, with default values for startIndex and startPage OpenSearch parameters (typically provided from the URL element which encloses the URL template) |
|
BasicQueryBuilder(URLTemplate template,
java.lang.String countDef,
java.lang.String startIndexDef,
java.lang.String startPageDef)
Creates a new BasicQueryBuilder. |
Method Summary | |
---|---|
QueryBuilder |
clone()
Returns a copy of this query builder |
java.util.List<java.lang.String> |
getOptionalParameters()
Returns a list containing all optional parameters of the query builder |
java.lang.String |
getParameterValue(java.lang.String name)
Retrieves the value assigned to a parameter of the query builder |
java.lang.String |
getQuery()
Retrieves the search query corresponding to the current state of the query builder |
java.lang.String |
getRawTemplate()
Returns the query template associated with this query builder |
java.util.List<java.lang.String> |
getRequiredParameters()
Returns a list containing all required parameters of the query builder |
java.lang.Integer |
getStartIndexDef()
Returns the default value of the StartIndex OpenSearch parameter associated with this query builder |
java.lang.Integer |
getStartPageDef()
Returns the default value of the StartPage OpenSearch parameter associated with this query builder |
java.util.List<java.lang.String> |
getUnsetParameters()
Returns a list containing all parameters to which no value has been assigned |
boolean |
hasParameter(java.lang.String name)
Determines if a parameter is contained in the parameter set of the query builder |
boolean |
isParameterSet(java.lang.String name)
Determines if a parameter has an assigned value. |
boolean |
isQueryComplete()
Determines whether the query is complete and therefore ready to be issued, i.e. |
static void |
main(java.lang.String[] args)
|
BasicQueryBuilder |
setParameter(java.lang.String name,
java.lang.Integer value)
Assigns an integral value to a parameter of the query builder |
BasicQueryBuilder |
setParameter(java.lang.String name,
java.lang.String value)
Assigns a string value to a parameter of the query builder |
BasicQueryBuilder |
setParameters(java.util.List<java.lang.String> names,
java.util.List<java.lang.Object> values)
Assigns to each parameter contained in the list of the first argument the respective value contained in the list of the secord argument |
QueryBuilder |
setParameters(QueryElement queryEl)
Sets all parameters of the query builder that are also contained in the QueryElement provided with the values contained in the QueryElement |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BasicQueryBuilder(URLTemplate template, java.lang.String startIndexDef, java.lang.String startPageDef) throws java.lang.Exception
template
- The query template that will be used to construct queriesstartIndexDef
- The default value for the startIndex standard OpenSearch parameterstartPageDef
- The default value for the startPage standard OpenSearch parameter
java.lang.Exception
- In case of errorpublic BasicQueryBuilder(URLTemplate template, java.lang.String countDef, java.lang.String startIndexDef, java.lang.String startPageDef) throws java.lang.Exception
BasicQueryBuilder(URLTemplate, String, String)
except that it takes an additional default
value for the count standard OpenSearch parameter
template
- The query template that will be used to construct queriescountDef
- The default value for the count standard OpenSearch parameterstartIndexDef
- The default value for the startIndex standard OpenSearch parameterstartPageDef
- The default value for the startPage standard OpenSearch parameter
java.lang.Exception
- In case of errorMethod Detail |
---|
public QueryBuilder clone()
QueryBuilder
clone
in interface QueryBuilder
clone
in class java.lang.Object
public java.util.List<java.lang.String> getRequiredParameters()
getRequiredParameters
in interface QueryBuilder
QueryBuilder.getRequiredParameters()
public java.util.List<java.lang.String> getOptionalParameters()
getOptionalParameters
in interface QueryBuilder
QueryBuilder.getOptionalParameters()
public java.lang.String getParameterValue(java.lang.String name) throws NonExistentParameterException
getParameterValue
in interface QueryBuilder
name
- The qualified name of the parameter
NonExistentParameterException
- If the parameter is not contained in the parameter set of the query builderQueryBuilder.getParameterValue(String)
public java.util.List<java.lang.String> getUnsetParameters()
getUnsetParameters
in interface QueryBuilder
QueryBuilder.getUnsetParameters()
public java.lang.String getRawTemplate()
getRawTemplate
in interface QueryBuilder
QueryBuilder.getRawTemplate()
public boolean hasParameter(java.lang.String name)
hasParameter
in interface QueryBuilder
name
- The qualified name of the parameter to be checked
QueryBuilder.hasParameter(String)
public BasicQueryBuilder setParameter(java.lang.String name, java.lang.String value) throws NonExistentParameterException, java.lang.Exception
setParameter
in interface QueryBuilder
name
- The qualified name of the parametervalue
- The value to be assigned to the parameter
NonExistentParameterException
- If the parameter is not contained in the parameter set of the query builder
java.lang.Exception
- In case of other errorQueryBuilder.setParameter(String, String)
public BasicQueryBuilder setParameter(java.lang.String name, java.lang.Integer value) throws NonExistentParameterException
setParameter
in interface QueryBuilder
name
- The qualified name of the parametervalue
- The value to be assigned to the parameter
NonExistentParameterException
- If the parameter is not contained in the parameter set of the query builderQueryBuilder.setParameter(String, Integer)
public BasicQueryBuilder setParameters(java.util.List<java.lang.String> names, java.util.List<java.lang.Object> values) throws NonExistentParameterException, java.lang.Exception
setParameters
in interface QueryBuilder
names
- A list of parameter qualified namesvalues
- A list of parameter values to be assigned to the respective parameter
NonExistentParameterException
- If a parameter of the list is not contained in the parameter of the query builder
java.lang.Exception
- In case of other errorQueryBuilder.setParameters(List, List)
public boolean isParameterSet(java.lang.String name)
isParameterSet
in interface QueryBuilder
name
- The qualified name of the parameter
QueryBuilder.isParameterSet(String)
public boolean isQueryComplete()
isQueryComplete
in interface QueryBuilder
QueryBuilder.isQueryComplete()
public java.lang.String getQuery() throws IncompleteQueryException, MalformedQueryException, java.lang.Exception
getQuery
in interface QueryBuilder
IncompleteQueryException
- If the query is not complete, i.e. there still exist unset required parameters
MalformedQueryException
- If the query is malformed, e.g. if a parameter value is not of the correct form
java.lang.Exception
- In case of other errorQueryBuilder.getQuery()
public QueryBuilder setParameters(QueryElement queryEl) throws NonExistentParameterException, java.lang.Exception
setParameters
in interface QueryBuilder
queryEl
- The query element which will be used to assign values to the parameters of the query builder
java.lang.Exception
- In case of error
NonExistentParameterException
QueryBuilder.setParameters(QueryElement)
public java.lang.Integer getStartIndexDef()
getStartIndexDef
in interface QueryBuilder
QueryBuilder.getStartIndexDef()
public java.lang.Integer getStartPageDef()
getStartPageDef
in interface QueryBuilder
QueryBuilder.getStartPageDef()
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |