org.apache.ambari.server.api.query

Interface Query

All Known Implementing Classes:

QueryImpl

public interface Query

Responsible for querying the back end for read requests

Method Summary

Modifier and Type	Method and Description
void	addLocalProperty(String property) Add a local (not sub-resource) property to the query.
void	addProperty(String propertyId, TemporalInfo temporalInfo) Add a property to the query.
Result	execute() Execute the query.
Predicate	getPredicate() Return the predicate used to identify the associated resource.
Set<String>	getProperties() Obtain the properties of the query.
Map<String,String>	getRequestInfoProps() Get this Query's requestInfoProperties from the original request.
void	setPageRequest(PageRequest pageRequest) Set the page request information for this query.
void	setRenderer(Renderer renderer) Set the corresponding renderer.
void	setRequestInfoProps(Map<String,String> requestInfoProperties) Set this Query's requestInfoProperties from the original request.
void	setSortRequest(SortRequest sortRequest) Set the order request information on the query
void	setUserPredicate(Predicate predicate) Set the user provided predicated on this query.

Method Detail

addProperty

void addProperty(String propertyId,
                 TemporalInfo temporalInfo)

Add a property to the query. This is the select portion of the query.

Parameters:

propertyId - the property id

temporalInfo - temporal information for the property

addLocalProperty

void addLocalProperty(String property)

Add a local (not sub-resource) property to the query. This is the select portion of the query.

Parameters:

property - the property id which contains the group, property name and whether the property is temporal

getProperties

Set<String> getProperties()

Obtain the properties of the query. These are the properties that make up the select portion of the query for which values are to be retrieved.

Returns:

the query properties

execute

Result execute()
        throws UnsupportedPropertyException,
               SystemException,
               NoSuchResourceException,
               NoSuchParentResourceException

Execute the query.

Returns:

the result of the query.

Throws:

UnsupportedPropertyException - if the query or query predicate contains invalid non-existent properties

SystemException - an internal error occurred

NoSuchResourceException - the query didn't match any resources

NoSuchParentResourceException - a specified parent resource doesn't exist

getPredicate

Predicate getPredicate()

Return the predicate used to identify the associated resource. This includes the primary key and all parent id's;

Returns:

the predicate used to identify the associated resource

setUserPredicate

void setUserPredicate(Predicate predicate)

Set the user provided predicated on this query. This predicate will be "AND'd" with the internal query to produce the final predicate.

Parameters:

predicate - the user provided predicate

setPageRequest

void setPageRequest(PageRequest pageRequest)

Set the page request information for this query.

Parameters:

pageRequest - the page request information

setSortRequest

void setSortRequest(SortRequest sortRequest)

Set the order request information on the query

Parameters:

sortRequest - the ordering info

setRenderer

void setRenderer(Renderer renderer)

Set the corresponding renderer. The renderer is responsible for the rendering of the query result, including which properties are contained and the format of the result.

Parameters:

renderer - renderer for the query

setRequestInfoProps

void setRequestInfoProps(Map<String,String> requestInfoProperties)

Set this Query's requestInfoProperties from the original request. This will contain information such as directives.

Parameters:

requestInfoProperties - a map a request info properties

getRequestInfoProps

Map<String,String> getRequestInfoProps()

Get this Query's requestInfoProperties from the original request. This will contain information such as directives.

Returns:

a map a request info properties