Package de.fraunhofer.iosb.ilt.frostclient.query

Class Query

java.lang.Object

de.fraunhofer.iosb.ilt.frostclient.query.Query

All Implemented Interfaces:

QueryParameter, QueryRequest

public class Query
extends Object
implements QueryRequest, QueryParameter

A query for reading operations.

Constructor Summary

Constructors

Constructor	Description
Query(SensorThingsService service, Entity parent, NavigationPropertyEntitySet navigationLink)
Query(SensorThingsService service, EntityType entityType)

Method Summary

Modifier and Type	Method	Description
Query	count()	Add the count parameter as specified by the SensorThingsAPI specification.
void	delete()
Query	expand(String expansion)
Query	filter(String options)	Add the filter parameter as specified by the SensorThingsAPI specification.
Entity	first()	Get the first instance of an entity collection.
EntityType	getEntityType()
SensorThingsService	getService()
EntitySet	list()	Get an entity collection.
Query	orderBy(String clause)	Add the orderBy parameter as specified by the SensorThingsAPI specification.
Query	select(String... fields)
Query	skip(int n)	Add the skip parameter as specified by the SensorThingsAPI specification.
Query	top(int n)	Add the top parameter as specified by the SensorThingsAPI specification.

Methods inherited from class java.lang.Object

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

Constructor Details

Query

public Query(SensorThingsService service,
 EntityType entityType)

Query

public Query(SensorThingsService service,
 Entity parent,
 NavigationPropertyEntitySet navigationLink)

Method Details

getEntityType

public EntityType getEntityType()

getService

public SensorThingsService getService()

filter

public Query filter(String options)

Description copied from interface: QueryParameter

Add the filter parameter as specified by the SensorThingsAPI specification.

Specified by:

filter in interface QueryParameter

Parameters:

options - the filter options as a string

Returns:

the updated instance of the query

top

public Query top(int n)

Description copied from interface: QueryParameter

Add the top parameter as specified by the SensorThingsAPI specification.

Specified by:

top in interface QueryParameter

Parameters:

n - the limit

Returns:

the updated instance of the query

orderBy

public Query orderBy(String clause)

Description copied from interface: QueryParameter

Add the orderBy parameter as specified by the SensorThingsAPI specification.

Specified by:

orderBy in interface QueryParameter

Parameters:

clause - the order clause

Returns:

the updated instance of the query

skip

public Query skip(int n)

Description copied from interface: QueryParameter

Add the skip parameter as specified by the SensorThingsAPI specification.

Specified by:

skip in interface QueryParameter

Parameters:

n - the number of entities to skip

Returns:

the updated instance of the query

count

public Query count()

Description copied from interface: QueryParameter

Add the count parameter as specified by the SensorThingsAPI specification.

Specified by:

count in interface QueryParameter

Returns:

the updated instance of the query

expand

public Query expand(String expansion)

select

public Query select(String... fields)

first

public Entity first()
             throws ServiceFailureException

Description copied from interface: QueryRequest

Get the first instance of an entity collection.

Specified by:

first in interface QueryRequest

Returns:

the first instance

Throws:

ServiceFailureException - the request failed

list

public EntitySet list()
               throws ServiceFailureException

Description copied from interface: QueryRequest

Get an entity collection.

Specified by:

list in interface QueryRequest

Returns:

the entity collection

Throws:

ServiceFailureException - the request failed

delete

public void delete()
            throws ServiceFailureException

Throws:

ServiceFailureException