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

Class BaseRenderer

java.lang.Object

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

All Implemented Interfaces:

Renderer

Direct Known Subclasses:

AlertSummaryRenderer, ClusterBlueprintRenderer, DefaultRenderer, MinimalRenderer

public abstract class BaseRenderer
extends Object
implements Renderer

Base renderer. Contains functionality which may be common across implementations.

Constructor Summary

Constructors

Constructor and Description
BaseRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	addKeys(Resource.Type resourceType, Set<String> properties) Add primary and all foreign keys for the specified resource type to the provided set.
protected void	addPrimaryKey(Resource.Type resourceType, Set<String> properties) Add primary key for the specified resource type to the provided set.
protected void	addSubResources(TreeNode<QueryInfo> queryTree, TreeNode<Set<String>> propertyTree) Add available sub resources to property node.
protected void	copyPropertiesToResult(TreeNode<QueryInfo> queryTree, TreeNode<Set<String>> propertyTree) Copies a tree of QueryInfo to a tree of Set.
protected void	ensureRequiredProperties(TreeNode<Set<String>> propertyTree, boolean addIfEmpty) Add required primary and foreign keys properties based on request type.
protected Schema	getSchema(Resource.Type type) Obtain a schema instance based on resource type.
void	init(SchemaFactory schemaFactory) Set a schema factory on the renderer.
protected boolean	isRequestWithNoProperties(TreeNode<QueryInfo> queryNode) Determine if the query node contains no properties and no children.
protected void	populateSubResourceDefaults(SubResourceDefinition subResource, Set<String> properties) Populate sub-resource properties.
boolean	requiresPropertyProviderInput() Obtains the property provider requirements of the given renderer implementation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.api.query.render.Renderer

finalizeProperties, finalizeResult, getResultPostProcessor

Constructor Detail

BaseRenderer

public BaseRenderer()

Method Detail

init

public void init(SchemaFactory schemaFactory)

Description copied from interface: Renderer

Set a schema factory on the renderer.

Specified by:

init in interface Renderer

Parameters:

schemaFactory - factory of schema instances

requiresPropertyProviderInput

public boolean requiresPropertyProviderInput()

Description copied from interface: Renderer

Obtains the property provider requirements of the given renderer implementation.

Specified by:

requiresPropertyProviderInput in interface Renderer

Returns:

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

getSchema

protected Schema getSchema(Resource.Type type)

Obtain a schema instance based on resource type.

Parameters:

type - resource type

Returns:

schema instance for the provided resource type

copyPropertiesToResult

protected void copyPropertiesToResult(TreeNode<QueryInfo> queryTree,
                                      TreeNode<Set<String>> propertyTree)

Copies a tree of QueryInfo to a tree of Set. This is useful in Renderer.finalizeProperties(TreeNode, boolean) for converting the passed in tree of query info to the return type which is a set of property names.

Parameters:

queryTree - source tree

propertyTree - target tree

addPrimaryKey

protected void addPrimaryKey(Resource.Type resourceType,
                             Set<String> properties)

Add primary key for the specified resource type to the provided set.

Parameters:

resourceType - resource type

properties - set of properties which pk will be added to

addKeys

protected void addKeys(Resource.Type resourceType,
                       Set<String> properties)

Add primary and all foreign keys for the specified resource type to the provided set.

Parameters:

resourceType - resource type

properties - set of properties which keys will be added to

isRequestWithNoProperties

protected boolean isRequestWithNoProperties(TreeNode<QueryInfo> queryNode)

Determine if the query node contains no properties and no children.

Parameters:

queryNode - the query node to check

Returns:

true if the node contains no properties or children; false otherwise

addSubResources

protected void addSubResources(TreeNode<QueryInfo> queryTree,
                               TreeNode<Set<String>> propertyTree)

Add available sub resources to property node.

Parameters:

queryTree - query tree

propertyTree - property tree

populateSubResourceDefaults

protected void populateSubResourceDefaults(SubResourceDefinition subResource,
                                           Set<String> properties)

Populate sub-resource properties.

Parameters:

subResource - definition of sub-resource

properties - property set to update

ensureRequiredProperties

protected void ensureRequiredProperties(TreeNode<Set<String>> propertyTree,
                                        boolean addIfEmpty)

Add required primary and foreign keys properties based on request type.

Parameters:

propertyTree - tree of properties

addIfEmpty - whether keys should be added to node with no properties