com.dnanexus

Class DXSearch.PropertiesQuery

java.lang.Object

com.dnanexus.DXSearch.PropertiesQuery

Enclosing class:

DXSearch

public abstract static class DXSearch.PropertiesQuery
extends Object

A query for objects (data objects, executions, or projects) with specified properties.

Method Summary

Modifier and Type	Method and Description
static DXSearch.PropertiesQuery	allOf(DXSearch.PropertiesQuery... propertiesQueries) A query that must match all of the specified property queries recursively.
static DXSearch.PropertiesQuery	allOf(List<DXSearch.PropertiesQuery> propertiesQueries) A query that must match all of the property queries in the provided list.
static DXSearch.PropertiesQuery	anyOf(DXSearch.PropertiesQuery... propertiesQueries) A query that matches any of the specified property queries recursively.
static DXSearch.PropertiesQuery	anyOf(List<DXSearch.PropertiesQuery> propertiesQueries) A query that matches any of the property queries in the provided list.
static DXSearch.PropertiesQuery	withKey(String propertyKey) A query that the specified property key is present.
static DXSearch.PropertiesQuery	withKeyAndBoolean(String propertyKey, Boolean propertyExists) A query that the specified property key is present of not on the data object
static DXSearch.PropertiesQuery	withKeyAndMapValue(String propertyKey, Map<String,String> mapValue) A query that the specified property is defined by the mapping
static DXSearch.PropertiesQuery	withKeyAndValue(String propertyKey, String propertyValue) A query that the specified property key has the specified property value.

Methods inherited from class java.lang.Object

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

Method Detail

allOf

public static DXSearch.PropertiesQuery allOf(List<DXSearch.PropertiesQuery> propertiesQueries)

A query that must match all of the property queries in the provided list.

Parameters:

propertiesQueries - list of queries, all of which must be matched

Returns:

query

allOf

public static DXSearch.PropertiesQuery allOf(DXSearch.PropertiesQuery... propertiesQueries)

A query that must match all of the specified property queries recursively.

Parameters:

propertiesQueries - queries, all of which must be matched

Returns:

query

anyOf

public static DXSearch.PropertiesQuery anyOf(List<DXSearch.PropertiesQuery> propertiesQueries)

A query that matches any of the property queries in the provided list.

Parameters:

propertiesQueries - list of queries, at least one of which must be matched

Returns:

query

anyOf

public static DXSearch.PropertiesQuery anyOf(DXSearch.PropertiesQuery... propertiesQueries)

A query that matches any of the specified property queries recursively.

Parameters:

propertiesQueries - queries, at least one of which must be matched

Returns:

query

withKey

public static DXSearch.PropertiesQuery withKey(String propertyKey)

A query that the specified property key is present.

Parameters:

propertyKey - property key that must be present

Returns:

query

withKeyAndValue

public static DXSearch.PropertiesQuery withKeyAndValue(String propertyKey,
                                                       String propertyValue)

A query that the specified property key has the specified property value.

Parameters:

propertyKey - property key

propertyValue - property value

Returns:

query

withKeyAndBoolean

public static DXSearch.PropertiesQuery withKeyAndBoolean(String propertyKey,
                                                         Boolean propertyExists)

A query that the specified property key is present of not on the data object

Parameters:

propertyKey - property key

propertyExists - boolean value - true if the property is present on a data object, false, if it is not

Returns:

query

withKeyAndMapValue

public static DXSearch.PropertiesQuery withKeyAndMapValue(String propertyKey,
                                                          Map<String,String> mapValue)

A query that the specified property is defined by the mapping

Parameters:

propertyKey - property key

mapValue - a hash map with the key defining the relation (e.g. $ne indication "not equal") and the value being a string value of the property

Returns:

query