com.hp.ucmdb.api.topology.queryparameter

Interface QueryParameters

@NotFinalAPI
public interface QueryParameters

This interface provides access to a map of execution parameters.

This map may be used to determine the values of named conditions (see CompletePropertyCondition) or even replace those named conditions completely (using addConditionReplacement(java.lang.String, com.hp.ucmdb.api.topology.ConditionExpression<com.hp.ucmdb.api.topology.CompletePropertyCondition, com.hp.ucmdb.api.topology.PropertiesConditionOperand>)).

The addValueXXX methods adds a name and value pair to a the map. The name is the name of the condition set at query creation time. The value (or values) are the replacement for the original value set (if any existed) in the query. Using a name that does not appear in the value will not cause exceptions, but will also not change the query runtime behavior.

The addConditionReplacement(java.lang.String, com.hp.ucmdb.api.topology.ConditionExpression<com.hp.ucmdb.api.topology.CompletePropertyCondition, com.hp.ucmdb.api.topology.PropertiesConditionOperand>) method replaces the entire named condition with the provided condition. The new condition can be created using the builder.

Note: all value type checks are done in the api server, not in the client layer. Incompatible or incomplete parameters will cause a validation exception to be thrown.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
QueryParameters	addConditionReplacement(String name, ConditionExpression<CompletePropertyCondition,PropertiesConditionOperand> condition) Adds a condition expression to replace the named condition.
QueryParameters	addQueryParameter(String name, QueryParameter queryParameter) Adds the given query parameter to the this query parameters.
QueryParameters	addValue(String name, Object value) Adds a single value.
QueryParameters	addValues(String name, Collection<?> valueCollection) Adds a series of values.
QueryParameters	addValuesInRange(String name, Object lowValue, Object highValue) Adds range in-boundries using low and high values.
QueryParameters	addValuesOutOfRange(String name, Object lowValue, Object highValue) Adds range out-boundries using low and high values.
PropertyConditionBuilder	createConditionBuilder()
boolean	isEmpty()
Map<String,QueryParameter>	parametersMap()

Method Detail

addValue

QueryParameters addValue(String name,
                         Object value)

Adds a single value.

Note: Collections as a single value can be added as well by using this method. Using collections value is not allowed for list attributes. Collections can be used for conditions with "in" operators. Here is an example of adding a collections value for an executable query with an "in" condition on "note" attribute :

 ExecutableQuery executableQuery = topologyQueryService.createExecutableQuery(queryName);
 ArrayList parameterValue = new ArrayList();
 parameterValue.add("value1");
 parameterValue.add("value2");
 executableQuery.queryParameters().addValue("conditionNote", parameterValue);
 topologyQueryService.executeQuery(executableQuery);
 

Parameters:

name - the name of the condition the value is to fill.

value - the execution value.

Returns:

this object for method chaining.

addValues

QueryParameters addValues(String name,
                          Collection<?> valueCollection)

Adds a series of values.

If the condition supports values collections (e.g. "in" operator), the values will be passed "as-is". Here is an example of adding values for an executable query with an "in" condition on "note" attribute:

 ExecutableQuery executableQuery = topologyQueryService.createExecutableQuery(queryName);
 ArrayList parameterValue = new ArrayList();
 parameterValue.add("value1");
 parameterValue.add("value2");
 executableQuery.queryParameters().addValues("conditionNote", parameterValue);
 topologyQueryService.executeQuery(executableQuery);

This will be the same as using addValue method:

executableQuery.queryParameters().addValue("conditionNote", parameterValue);

If the condition does not support collections it will be replaced with a condition expression composed of copies of the original condition, each with a single value from the collection, "or"-ed with each other (so that any value from the collection can be a match). Here is an example of adding values for an executable query with a "contains" condition on "nodeRole" attribute of string list type. This will be converted in a condition that has the "or" operator : nodeRole contains value1 or nodeRole contains value2.

 ExecutableQuery executableQuery = topologyQueryService.createExecutableQuery(queryName);
 ArrayList parameterValue = new ArrayList();
 parameterValue.add("value1");
 parameterValue.add("value2");
 executableQuery.queryParameters().addValues("conditionNodeRole", parameterValue);
 topologyQueryService.executeQuery(executableQuery);
 

Parameters:

name - the name of the condition the value is to fill.

valueCollection - the values collections.

Returns:

this object for method chaining.

addValuesInRange

QueryParameters addValuesInRange(String name,
                                 Object lowValue,
                                 Object highValue)

Adds range in-boundries using low and high values.

The condition will be replaced with two conditions, "and"-ed with each other, so that the property will be higher than the low value and lower than the high value (low < x < high).

Parameters:

name - the name of the condition the value is to fill.

lowValue - the execution low value.

highValue - the execution high value.

Returns:

this object for method chaining.

addValuesOutOfRange

QueryParameters addValuesOutOfRange(String name,
                                    Object lowValue,
                                    Object highValue)

Adds range out-boundries using low and high values.

The condition will be replaced with two conditions, "or"-ed with each other, so that the property will be lower than the low value or higher than the high value ((x < low) or (high < x)).

Parameters:

name - the name of the condition the value is to fill.

lowValue - the execution low value.

highValue - the execution high value.

Returns:

this object for method chaining.

addConditionReplacement

QueryParameters addConditionReplacement(String name,
                                        ConditionExpression<CompletePropertyCondition,PropertiesConditionOperand> condition)

Adds a condition expression to replace the named condition.

The given condition expression will completely replace the existing condition. Before execution, all conditions in the expression must be complete.

A condition expression can be created using the builder from createConditionBuilder().

Parameters:

name - the name of the condition the value is to fill.

condition - the replacing condition expression.

Returns:

this object for method chaining.

addQueryParameter

QueryParameters addQueryParameter(String name,
                                  QueryParameter queryParameter)

Adds the given query parameter to the this query parameters. This method should be used by automatic builders only.

Parameters:

name - the name of the condition the parameter refers to.

queryParameter - the query parameter.

Returns:

this object for method chaining.

createConditionBuilder

PropertyConditionBuilder createConditionBuilder()

Returns:

a builder for creating condition expressions.

parametersMap

Map<String,QueryParameter> parametersMap()

Returns:

the map of already added parameters.

isEmpty

boolean isEmpty()

Returns:

true if no parameter was defined, false otherwise.