org.apache.ambari.server.api.query.render

Interface Renderer

All Known Implementing Classes:

AlertSummaryGroupedRenderer, AlertSummaryRenderer, BaseRenderer, ClusterBlueprintRenderer, DefaultRenderer, HostKerberosIdentityCsvRenderer, MetricsPaddingRenderer, MinimalRenderer

public interface Renderer

Responsible for the rendering of a result. This includes both the content (which properties), and the format of the query result. Format doesn't refer to json or xml, but instead to the structure of the categories, sub-resources and properties. Renderer's are registered for a resource type by adding them to the corresponding resource definition.

Method Summary

Modifier and Type	Method and Description
TreeNode<Set<String>>	finalizeProperties(TreeNode<QueryInfo> queryProperties, boolean isCollection) Finalize which properties are requested by the query.
Result	finalizeResult(Result queryResult) Finalize the query results.
ResultPostProcessor	getResultPostProcessor(Request request) Obtain the associated post processor.
void	init(SchemaFactory schemaFactory) Set a schema factory on the renderer.
boolean	requiresPropertyProviderInput() Obtains the property provider requirements of the given renderer implementation.

Method Detail

init

void init(SchemaFactory schemaFactory)

Set a schema factory on the renderer.

Parameters:

schemaFactory - factory of schema instances

finalizeProperties

TreeNode<Set<String>> finalizeProperties(TreeNode<QueryInfo> queryProperties,
                                         boolean isCollection)

Finalize which properties are requested by the query. This is called once per user query regardless of how many sub-queries the original query is decomposed into.

Parameters:

queryProperties - tree of query information. Contains query information for the root query and all sub-queries (children)

isCollection - whether the query is a collection

Returns:

tree of sets of string properties for each query including any sub-queries

finalizeResult

Result finalizeResult(Result queryResult)

Finalize the query results.

Parameters:

queryResult - result of query in native (default) format

Returns:

result in the format dictated by the renderer

getResultPostProcessor

ResultPostProcessor getResultPostProcessor(Request request)

Obtain the associated post processor. Post Processors existed prior to renderer's to allow the native result to be augmented before returning it to the user. This functionality should be merged into the renderer.

Parameters:

request - original request

Returns:

associated post processor

requiresPropertyProviderInput

boolean requiresPropertyProviderInput()

Obtains the property provider requirements of the given renderer implementation.

Returns:

true if property provider support is required false if property provider support is not required