org.apache.ambari.server.api.resources

Interface ResourceInstance

All Known Implementing Classes:

QueryImpl

public interface ResourceInstance

Resource instance which contains request specific state.

Method Summary

Modifier and Type	Method and Description
Map<Resource.Type,String>	getKeyValueMap() Obtain the primary and foreign key properties for the resource.
Query	getQuery() Return the query associated with the resource.
ResourceDefinition	getResourceDefinition() Return the resource definition for this resource type.
Map<String,ResourceInstance>	getSubResources() Return all sub-resource instances.
boolean	isCollectionResource() Determine if resource is a collection resource.
void	setKeyValueMap(Map<Resource.Type,String> keyValueMap) Set the values of the parent foreign keys.

Method Detail

setKeyValueMap

void setKeyValueMap(Map<Resource.Type,String> keyValueMap)

Set the values of the parent foreign keys.

Parameters:

keyValueMap - map of all parent foreign keys. Map from resource type to id value.

getKeyValueMap

Map<Resource.Type,String> getKeyValueMap()

Obtain the primary and foreign key properties for the resource.

Returns:

map of primary and foreign key values keyed by resource type

getQuery

Query getQuery()

Return the query associated with the resource. Each resource has one query.

Returns:

the associated query

getResourceDefinition

ResourceDefinition getResourceDefinition()

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.

Returns:

the associated resource definition

getSubResources

Map<String,ResourceInstance> getSubResources()

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.

Returns:

all sub-resource instances

isCollectionResource

boolean isCollectionResource()

Determine if resource is a collection resource.

Returns:

true if the resource is a collection resource; false otherwise