com.evrythng.java.wrapper.service

Class SearchService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.SearchService

public class SearchService
extends EvrythngServiceBase

Service wrapper for the /search endpoints of the EVRYTHNG Engine API.

Author:

Michel Yerly (my)

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_SEARCH
static String	QP_CUSTOM_FIELDS
static String	QP_IDENTIFIERS
static String	QP_LATITUDE Deprecated. since 1.16 - use LatQueryParamValue instead
static String	QP_LONGITUDE Deprecated. since 1.16 - use LonQueryParamValue instead
static String	QP_MAX_DISTANCE Deprecated. since 1.16 - use MaxDistQueryParamValue instead
static String	QP_PROPERTIES
static String	QP_SEARCH_ALL Deprecated. since 1.16 - use QSearchQueryParamValue instead.
static String	QP_TAGS Deprecated. since 1.16 - use TagsQueryParamValue instead.
static String	QP_TYPES Deprecated. since 1.16 - use TypesQueryParamValue instead.

Constructor Summary

Constructors

Constructor and Description
SearchService(ApiManager apiManager)

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<GlobalSearchResult>	fieldSearch(EnumSet<EvrythngType> types) Searches evrythng entities using criteria for specific fields.
EvrythngApiBuilder.Builder<GlobalSearchResult>	fieldSearch(EvrythngType type)
EvrythngApiBuilder.Builder<GlobalSearchResult>	geoSearch(EnumSet<EvrythngType> types, double latitude, double longitude, double maxDistance) Performs a geo-location based search.
EvrythngApiBuilder.Builder<GlobalSearchResult>	geoSearch(EvrythngType type, double latitude, double longitude, double maxDistance)
static String	qpCustomField(String customFieldName) Creates the query parameter name for a custom field.
static String	qpIdentifier(String identifierName) Creates the query parameter name for an identifier.
static String	qpProperty(String propertyName) Creates the query parameter name for a property name.
EvrythngApiBuilder.Builder<GlobalSearchResult>	search(EnumSet<EvrythngType> types, String searchText) Searches evrythng entities using a string search criterion.
EvrythngApiBuilder.Builder<GlobalSearchResult>	search(EvrythngType type)
EvrythngApiBuilder.Builder<GlobalSearchResult>	search(EvrythngType type, String searchText)

Methods inherited from class com.evrythng.java.wrapper.core.EvrythngServiceBase

absoluteUri, delete, deleteMultiple, encodeBase64, get, getConfig, iterator, mqttUrl, onBuilderCreated, post, post, postAsynchronously, postMultipart, postMultipart, put, put, putMultipart, putMultipart, putMultiple, urlEncodePathPart

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEARCH

public static final String PATH_SEARCH

See Also:

Constant Field Values

QP_SEARCH_ALL

@Deprecated
public static final String QP_SEARCH_ALL

Deprecated. since 1.16 - use QSearchQueryParamValue instead.

See Also:

Constant Field Values

QP_TYPES

@Deprecated
public static final String QP_TYPES

Deprecated. since 1.16 - use TypesQueryParamValue instead.

See Also:

Constant Field Values

QP_IDENTIFIERS

public static final String QP_IDENTIFIERS

See Also:

Constant Field Values

QP_CUSTOM_FIELDS

public static final String QP_CUSTOM_FIELDS

See Also:

Constant Field Values

QP_TAGS

@Deprecated
public static final String QP_TAGS

Deprecated. since 1.16 - use TagsQueryParamValue instead.

See Also:

Constant Field Values

QP_PROPERTIES

public static final String QP_PROPERTIES

See Also:

Constant Field Values

QP_LATITUDE

@Deprecated
public static final String QP_LATITUDE

Deprecated. since 1.16 - use LatQueryParamValue instead

See Also:

Constant Field Values

QP_LONGITUDE

@Deprecated
public static final String QP_LONGITUDE

Deprecated. since 1.16 - use LonQueryParamValue instead

See Also:

Constant Field Values

QP_MAX_DISTANCE

@Deprecated
public static final String QP_MAX_DISTANCE

Deprecated. since 1.16 - use MaxDistQueryParamValue instead

See Also:

Constant Field Values

Constructor Detail

SearchService

public SearchService(ApiManager apiManager)

Method Detail

search

public EvrythngApiBuilder.Builder<GlobalSearchResult> search(EnumSet<EvrythngType> types,
                                                             String searchText)
                                                      throws EvrythngClientException

Searches evrythng entities using a string search criterion.

Parameters:

types - The entity types to search for.

searchText - The search criterion.

Returns:

The search results.

Throws:

EvrythngClientException

search

public EvrythngApiBuilder.Builder<GlobalSearchResult> search(EvrythngType type,
                                                             String searchText)
                                                      throws EvrythngClientException

Parameters:

type - The entity type to search for.

searchText - The search criterion.

Returns:

The search results.

Throws:

EvrythngClientException

See Also:

search(EnumSet, String)

search

public EvrythngApiBuilder.Builder<GlobalSearchResult> search(EvrythngType type)
                                                      throws EvrythngClientException

Parameters:

type - The entity type to search for.

Returns:

The search results.

Throws:

EvrythngClientException

See Also:

search(EnumSet, String)

fieldSearch

public EvrythngApiBuilder.Builder<GlobalSearchResult> fieldSearch(EnumSet<EvrythngType> types)
                                                           throws EvrythngClientException

Searches evrythng entities using criteria for specific fields. Use query params to specify the fields.

Parameters:

types - The entity types to search for.

Returns:

The search results.

Throws:

EvrythngClientException

See Also:

QP_CUSTOM_FIELDS, QP_PROPERTIES, QP_TAGS, qpCustomField(String), qpProperty(String)

fieldSearch

public EvrythngApiBuilder.Builder<GlobalSearchResult> fieldSearch(EvrythngType type)
                                                           throws EvrythngClientException

Parameters:

type - The entity type to search for.

Throws:

EvrythngClientException

See Also:

fieldSearch(EnumSet)

geoSearch

public EvrythngApiBuilder.Builder<GlobalSearchResult> geoSearch(EnumSet<EvrythngType> types,
                                                                double latitude,
                                                                double longitude,
                                                                double maxDistance)
                                                         throws EvrythngClientException

Performs a geo-location based search.

Parameters:

types - The entity types to search for.

latitude - The latitude in degrees.

longitude - The longitude in degrees.

maxDistance - The maximal distance in kilometers to search.

Returns:

The search results.

Throws:

EvrythngClientException

geoSearch

public EvrythngApiBuilder.Builder<GlobalSearchResult> geoSearch(EvrythngType type,
                                                                double latitude,
                                                                double longitude,
                                                                double maxDistance)
                                                         throws EvrythngClientException

Parameters:

type - The entity type to search for.

latitude - The latitude in degrees.

longitude - The longitude in degrees.

maxDistance - The maximal distance in kilometers to search.

Returns:

The search results.

Throws:

EvrythngClientException

See Also:

geoSearch(EnumSet, double, double, double)

qpIdentifier

public static String qpIdentifier(String identifierName)

Creates the query parameter name for an identifier.

Parameters:

identifierName - The identifier name, for example "ean" or "upc".

Returns:

The query parameter name.

qpCustomField

public static String qpCustomField(String customFieldName)

Creates the query parameter name for a custom field.

Parameters:

customFieldName - The custom field name, for example "ean" or "upc".

Returns:

The query parameter name.

qpProperty

public static String qpProperty(String propertyName)

Creates the query parameter name for a property name.

Parameters:

propertyName - The property name, for example "ean" or "upc".

Returns:

The query parameter name.