com.hpe.adm.nga.sdk.query

Class Query

java.lang.Object

com.hpe.adm.nga.sdk.query.Query

public class Query
extends Object

The class to build complex queries. An instance of this class is created using the statement(String, QueryMethod, Object) or not(String, QueryMethod, Object) methods.

See the REST API documentation for information as to how to build queries. This API supports building queries in a simplified Builder pattern

Each query statement consists of the field name, query method and the object of the query. The object can be a simple primitive or a further Query object

For example:
To build a query such as name eq 'entity_name' the following code is used:
Query.statement("name", QueryMethod.EqualTo, "entity_name");

To negate this statement such as !name eq 'entity_name' the following code is used:
Query.not("name", QueryMethod.EqualTo, "entity_name");

These statements produce a QueryBuilder object. By calling the Query.QueryBuilder.build() method this creates a Query object which can then be used in conjunction with entity or other contexts

Query objects can be chained together (and/or) by using the correct methods such as QueryBuilder#and(QueryBuilder) or Query.QueryBuilder.orNot(String, QueryMethod, Object)
Query.QueryBuilder.build() should be called once the entire query has been built

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.QueryBuilder Object that is used to build Query objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	queryString

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Query()

Method Summary

Modifier and Type	Method and Description
String	getQueryString() Accessor method of query string
static Query.QueryBuilder	not(String fieldName, QueryMethod method, Object fieldValue) QueryBuilder not
static Query.QueryBuilder	statement(String fieldName, QueryMethod method, Object fieldValue) QueryBuilder Statement
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

queryString

protected String queryString

Constructor Detail

Query

protected Query()

Method Detail

statement

public static Query.QueryBuilder statement(String fieldName,
                                           QueryMethod method,
                                           Object fieldValue)

QueryBuilder Statement

Parameters:

fieldName - - field name

method - - comparison function to use

fieldValue - - value to compare with

Returns:

The new object that can be used to build the query

not

public static Query.QueryBuilder not(String fieldName,
                                     QueryMethod method,
                                     Object fieldValue)

QueryBuilder not

Parameters:

fieldName - - field name

method - - comparison function to use

fieldValue - - value to compare with

Returns:

The new object that can be used to build the query

getQueryString

public String getQueryString()

Accessor method of query string

Returns:

query string

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation of the object.