com.emc.vipr.client.core.search

Class SearchBuilder<T extends DataObjectRestRep>

java.lang.Object

com.emc.vipr.client.core.search.SearchBuilder<T>

Type Parameters:

T - Resource type returned by this search builder.

Direct Known Subclasses:

ApprovalSearchBuilder, OrderSearchBuilder, ProjectSearchBuilder, VirtualArraySearchBuilder

public class SearchBuilder<T extends DataObjectRestRep>
extends java.lang.Object

A builder for search queries.

Constructor Summary

Constructors

Constructor and Description
SearchBuilder(AbstractResources<T> resources)

Method Summary

Modifier and Type	Method and Description
SearchBuilder<T>	by(java.lang.String name, java.lang.Object value) Adds a single parameter to search by.
SearchBuilder<T>	byAll(java.util.Map<java.lang.String,java.lang.Object> parameters) Adds multiple search parameters to search by.
SearchBuilder<T>	byExactName(java.lang.String name) Shortcut to search by exact name.
SearchBuilder<T>	byName(java.lang.String name) Shortcut to search by name.
SearchBuilder<T>	byTag(java.lang.String tag) Shortcut to search by tag.
SearchBuilder<T>	filter(ResourceFilter<T> addFilter) Filters the results returned by the search query.
T	first() Runs a search based on the criteria built with this SearchBuilder.
java.util.List<T>	run() Runs a search based on the criteria built with this SearchBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchBuilder

public SearchBuilder(AbstractResources<T> resources)

Method Detail

by

public SearchBuilder<T> by(java.lang.String name,
                           java.lang.Object value)

Adds a single parameter to search by.

Parameters:

name - the parameter name.

value - the parameter value.

Returns:

This SearchBuilder.

byAll

public SearchBuilder<T> byAll(java.util.Map<java.lang.String,java.lang.Object> parameters)

Adds multiple search parameters to search by.

Parameters:

parameters - Map containing name value pairs

Returns:

This SearchBuilder.

filter

public SearchBuilder<T> filter(ResourceFilter<T> addFilter)

Filters the results returned by the search query. Multiple filters can be added.

Parameters:

addFilter - Filter to use for filtering the search results.

Returns:

This SearchBuilder.

byName

public SearchBuilder<T> byName(java.lang.String name)

Shortcut to search by name.

Parameters:

name - Name of the resource.

Returns:

This SearchBuilder.

byExactName

public SearchBuilder<T> byExactName(java.lang.String name)

Shortcut to search by exact name. This both searches by name and adds a filter to ensure the exact name string is matched.

Parameters:

name - Name of the resource.

Returns:

This SearchBuilder.

byTag

public SearchBuilder<T> byTag(java.lang.String tag)

Shortcut to search by tag.

Parameters:

tag - Tag on the resource.

Returns:

This SearchBuilder.

first

public T first()

Runs a search based on the criteria built with this SearchBuilder. Only the first search result is returned.

Returns:

The first search result.

run

public java.util.List<T> run()

Runs a search based on the criteria built with this SearchBuilder. All search results are queried and returned.

Returns:

All search results.