QueryImpl (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.api.query.QueryImpl

All Implemented Interfaces:: Query, ResourceInstance

public class QueryImpl
extends Object
implements Query, ResourceInstance

Default read query.

Constructor Summary

Constructors
Constructor and Description
`QueryImpl(Map<Resource.Type,String> keyValueMap, ResourceDefinition resourceDefinition, ClusterController clusterController)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected Map<String,QueryImpl>`	`ensureSubResources()` Get the map of sub-resources.
`boolean`	`equals(Object o)`
`Result`	`execute()` Execute the query.
`protected Map<Resource,Set<Map<String,Object>>>`	`getJoinedResourceProperties(Set<String> propertyIds, Resource parentResource, String category)` Get a map of property sets keyed by the resources associated with this query.
`Map<Resource.Type,String>`	`getKeyValueMap()` Obtain the primary and foreign key properties for the resource.
`Predicate`	`getPredicate()` Return the predicate used to identify the associated resource.
`Set<String>`	`getProperties()` Obtain the properties of the query.
`Query`	`getQuery()` Return the query associated with the resource.
`Map<String,String>`	`getRequestInfoProps()` Get this Query's requestInfoProperties from the original request.
`ResourceDefinition`	`getResourceDefinition()` Return the resource definition for this resource type.
`Map<String,ResourceInstance>`	`getSubResources()` Return all sub-resource instances.
`int`	`hashCode()`
`boolean`	`isCollectionResource()` Determine if resource is a collection resource.
`void`	`setKeyValueMap(Map<Resource.Type,String> keyValueMap)` Set the values of the parent foreign keys.
`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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueryImpl
```
public QueryImpl(Map<Resource.Type,String> keyValueMap,
                 ResourceDefinition resourceDefinition,
                 ClusterController clusterController)
```
    Constructor
    
    Parameters:
    
    keyValueMap - the map of key values
    
    resourceDefinition - the resource definition
    
    clusterController - the cluster controller
- Method Detail
  - addProperty
```
public void addProperty(String propertyId,
                        TemporalInfo temporalInfo)
```
    Description copied from interface: Query
    
    Add a property to the query. This is the select portion of the query.
    
    Specified by:
    
    addProperty in interface Query
    
    Parameters:
    
    propertyId - the property id
    
    temporalInfo - temporal information for the property
  - addLocalProperty
```
public void addLocalProperty(String property)
```
    Description copied from interface: Query
    
    Add a local (not sub-resource) property to the query. This is the select portion of the query.
    
    Specified by:
    
    addLocalProperty in interface Query
    
    Parameters:
    
    property - the property id which contains the group, property name and whether the property is temporal
  - execute
```
public Result execute()
               throws UnsupportedPropertyException,
                      SystemException,
                      NoSuchResourceException,
                      NoSuchParentResourceException
```
    Description copied from interface: Query
    
    Execute the query.
    
    Specified by:
    
    execute in interface 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
```
public Predicate getPredicate()
```
    Description copied from interface: Query
    
    Return the predicate used to identify the associated resource. This includes the primary key and all parent id's;
    
    Specified by:
    
    getPredicate in interface Query
    
    Returns:
    
    the predicate used to identify the associated resource
  - getProperties
```
public Set<String> getProperties()
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    getProperties in interface Query
    
    Returns:
    
    the query properties
  - setUserPredicate
```
public void setUserPredicate(Predicate predicate)
```
    Description copied from interface: Query
    
    Set the user provided predicated on this query. This predicate will be "AND'd" with the internal query to produce the final predicate.
    
    Specified by:
    
    setUserPredicate in interface Query
    
    Parameters:
    
    predicate - the user provided predicate
  - setPageRequest
```
public void setPageRequest(PageRequest pageRequest)
```
    Description copied from interface: Query
    
    Set the page request information for this query.
    
    Specified by:
    
    setPageRequest in interface Query
    
    Parameters:
    
    pageRequest - the page request information
  - setSortRequest
```
public void setSortRequest(SortRequest sortRequest)
```
    Description copied from interface: Query
    
    Set the order request information on the query
    
    Specified by:
    
    setSortRequest in interface Query
    
    Parameters:
    
    sortRequest - the ordering info
  - setRenderer
```
public void setRenderer(Renderer renderer)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    setRenderer in interface Query
    
    Parameters:
    
    renderer - renderer for the query
  - setRequestInfoProps
```
public void setRequestInfoProps(Map<String,String> requestInfoProperties)
```
    Description copied from interface: Query
    
    Set this Query's requestInfoProperties from the original request. This will contain information such as directives.
    
    Specified by:
    
    setRequestInfoProps in interface Query
    
    Parameters:
    
    requestInfoProperties - a map a request info properties
  - getRequestInfoProps
```
public Map<String,String> getRequestInfoProps()
```
    Description copied from interface: Query
    
    Get this Query's requestInfoProperties from the original request. This will contain information such as directives.
    
    Specified by:
    
    getRequestInfoProps in interface Query
    
    Returns:
    
    a map a request info properties
  - setKeyValueMap
```
public void setKeyValueMap(Map<Resource.Type,String> keyValueMap)
```
    Description copied from interface: ResourceInstance
    
    Set the values of the parent foreign keys.
    
    Specified by:
    
    setKeyValueMap in interface ResourceInstance
    
    Parameters:
    
    keyValueMap - map of all parent foreign keys. Map from resource type to id value.
  - getKeyValueMap
```
public Map<Resource.Type,String> getKeyValueMap()
```
    Description copied from interface: ResourceInstance
    
    Obtain the primary and foreign key properties for the resource.
    
    Specified by:
    
    getKeyValueMap in interface ResourceInstance
    
    Returns:
    
    map of primary and foreign key values keyed by resource type
  - getQuery
```
public Query getQuery()
```
    Description copied from interface: ResourceInstance
    
    Return the query associated with the resource. Each resource has one query.
    
    Specified by:
    
    getQuery in interface ResourceInstance
    
    Returns:
    
    the associated query
  - getResourceDefinition
```
public ResourceDefinition getResourceDefinition()
```
    Description copied from interface: ResourceInstance
    
    Return the resource definition for this resource type. All information in the definition is static and is specific to the resource type, not the resource instance.
    
    Specified by:
    
    getResourceDefinition in interface ResourceInstance
    
    Returns:
    
    the associated resource definition
  - isCollectionResource
```
public boolean isCollectionResource()
```
    Description copied from interface: ResourceInstance
    
    Determine if resource is a collection resource.
    
    Specified by:
    
    isCollectionResource in interface ResourceInstance
    
    Returns:
    
    true if the resource is a collection resource; false otherwise
  - getSubResources
```
public Map<String,ResourceInstance> getSubResources()
```
    Description copied from interface: ResourceInstance
    
    Return all sub-resource instances. This will include all children of this resource as well as any other resources referred to via a foreign key property.
    
    Specified by:
    
    getSubResources in interface ResourceInstance
    
    Returns:
    
    all sub-resource instances
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - ensureSubResources
```
protected Map<String,QueryImpl> ensureSubResources()
```
    Get the map of sub-resources. Lazily create the map if required.
  - getJoinedResourceProperties
```
protected Map<Resource,Set<Map<String,Object>>> getJoinedResourceProperties(Set<String> propertyIds,
                                                                            Resource parentResource,
                                                                            String category)
                                                                     throws SystemException,
                                                                            UnsupportedPropertyException,
                                                                            NoSuchParentResourceException,
                                                                            NoSuchResourceException
```
    Get a map of property sets keyed by the resources associated with this query. The property sets should contain the joined sets of all of the requested properties from each resource's sub-resources. For example, if this query is associated with the resources AResource1, AResource1 and AResource3 as follows ...
```
 a_resources
 │
 └──AResource1 ─────────────AResource1 ─────────────AResource3
      │                       │                       │
      ├── b_resources         ├── b_resources         ├── BResources
      │   ├── BResource1      │   ├── BResource3      │    └── BResource5
      │   │     p1:1          │   │     p1:3          │          p1:5
      │   │     p2:5          │   │     p2:5          │          p2:5
      │   │                   │   │                   │
      │   └── BResource2      │   └── BResource4      └── c_resources
      │         p1:2          │         p1:4              └── CResource4
      │         p2:0          │         p2:0                    p3:4
      │                       │
      └── c_resources         └── c_resources
          ├── CResource1          └── CResource3
          │     p3:1                    p3:3
          │
          └── CResource2
                p3:2

 Given the following query ...

     api/v1/a_resources?b_resources/p1>3&b_resources/p2=5&c_resources/p3=1

 The caller should pass the following property ids ...

     b_resources/p1
     b_resources/p2
     c_resources/p3

 getJoinedResourceProperties should produce the following map of property sets
 by making recursive calls on the sub-resources of each of this query's resources,
 joining the resulting property sets, and adding them to the map keyed by the
 resource ...

  {
    AResource1=[{b_resources/p1=1, b_resources/p2=5, c_resources/p3=1},
                {b_resources/p1=2, b_resources/p2=0, c_resources/p3=1},
                {b_resources/p1=1, b_resources/p2=5, c_resources/p3=2},
                {b_resources/p1=2, b_resources/p2=0, c_resources/p3=2}],
    AResource2=[{b_resources/p1=3, b_resources/p2=5, c_resources/p3=3},
                {b_resources/p1=4, b_resources/p2=0, c_resources/p3=3}],
    AResource3=[{b_resources/p1=5, b_resources/p2=5, c_resources/p3=4}],
  }
 
```
    Parameters:
    
    propertyIds - the requested properties
    
    parentResource - the parent resource; may be null
    
    category - the sub-resource category; may be null
    
    Returns:
    
    a map of property sets keyed by the resources associated with this query
    
    Throws:
    
    SystemException
    
    UnsupportedPropertyException
    
    NoSuchParentResourceException
    
    NoSuchResourceException

Class QueryImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryImpl

Method Detail

addProperty

addLocalProperty

execute

getPredicate

getProperties

setUserPredicate

setPageRequest

setSortRequest

setRenderer

setRequestInfoProps

getRequestInfoProps

setKeyValueMap

getKeyValueMap

getQuery

getResourceDefinition

isCollectionResource

getSubResources

equals

hashCode

ensureSubResources

getJoinedResourceProperties