com.amazon.ask.response.template.impl

Class BaseTemplateFactory<Input,Output>

java.lang.Object

com.amazon.ask.response.template.impl.BaseTemplateFactory<Input,Output>

Type Parameters:

Input - Skill input type.

Output - Skill output type.

All Implemented Interfaces:

TemplateFactory<Input,Output>

public class BaseTemplateFactory<Input,Output>
extends Object
implements TemplateFactory<Input,Output>

TemplateFactory implementation to chain TemplateLoader and TemplateRenderer. It is responsible to pass in template name, data map and Input to get response output for skill request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseTemplateFactory.Builder<Input,Output,Self extends BaseTemplateFactory.Builder<Input,Output,Self>> Base Template Factory Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TemplateLoader<Input>>	templateLoaders List of loader interfaces for template loading from data store.
protected TemplateRenderer<Output>	templateRenderer Renderer interface for template rendering and response conversion.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTemplateFactory(List<TemplateLoader<Input>> templateLoaders, TemplateRenderer<Output> templateRenderer) Constructor to build an instance of BaseTemplateFactory.

Method Summary

Modifier and Type	Method and Description
static <Input,Output> BaseTemplateFactory.Builder<Input,Output,?>	builder() Return Builder instance.
static <Input,Output,Self extends BaseTemplateFactory.Builder<Input,Output,Self>> BaseTemplateFactory.Builder<Input,Output,Self>	forTypes(Class<Input> input, Class<Output> output) Return Builder instance.
Output	processTemplate(String responseTemplateName, Map<String,Object> dataMap, Input input) Process response template and data to generate skill response.

Methods inherited from class java.lang.Object

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

Field Detail

templateLoaders

protected final List<TemplateLoader<Input>> templateLoaders

List of loader interfaces for template loading from data store.

templateRenderer

protected final TemplateRenderer<Output> templateRenderer

Renderer interface for template rendering and response conversion.

Constructor Detail

BaseTemplateFactory

protected BaseTemplateFactory(List<TemplateLoader<Input>> templateLoaders,
                              TemplateRenderer<Output> templateRenderer)

Constructor to build an instance of BaseTemplateFactory.

Parameters:

templateLoaders - template loaders.

templateRenderer - template renderer.

Method Detail

forTypes

public static <Input,Output,Self extends BaseTemplateFactory.Builder<Input,Output,Self>> BaseTemplateFactory.Builder<Input,Output,Self> forTypes(Class<Input> input,
                                                                                                                                                 Class<Output> output)

Return Builder instance.

Type Parameters:

Input - Skill input type.

Output - Skill output type.

Self - of type Builder class or any parent class of Builder.

Parameters:

input - class of type input.

output - class of type output.

Returns:

BaseTemplateFactory.Builder.

builder

public static <Input,Output> BaseTemplateFactory.Builder<Input,Output,?> builder()

Return Builder instance.

Type Parameters:

Input - Skill input type.

Output - Skill output type.

Returns:

BaseTemplateFactory.Builder.

processTemplate

public Output processTemplate(String responseTemplateName,
                              Map<String,Object> dataMap,
                              Input input)
                       throws TemplateFactoryException

Process response template and data to generate skill response..

Specified by:

processTemplate in interface TemplateFactory<Input,Output>

Parameters:

responseTemplateName - template name

dataMap - map that contains template injecting data

input - skill request input

Returns:

skill response output

Throws:

TemplateFactoryException - if fail to process template