de.hybris.platform.commons.translator

Class TranslatorConfiguration

java.lang.Object

de.hybris.platform.commons.translator.TranslatorConfiguration

public class TranslatorConfiguration
extends java.lang.Object

TranslatorConfiguration is a class that is responsible for keeping the configuration for the Translator. This class is required in the Translator constructor.

Constructor Summary

Constructors

Constructor and Description
TranslatorConfiguration(java.io.InputStream parsersConfiguration, RenderersFactory renderersFactory) This constructor should be used when parsers configuration is defined in xml file
TranslatorConfiguration(java.util.Map<java.lang.String,AbstractParser> parsersConfiguration, RenderersFactory renderersFactory) This constructor should be used when parsers configuration is defined in database.

Method Summary

Modifier and Type	Method and Description
void	addPrerenderer(Prerenderer prerenderer) add Prerenderer to list of prerenderers
AbstractRenderer	getDefaultRenderer() get default renderer
AbstractParser	getParser(java.lang.String name) get parser from the configuration by the name
java.util.Set<java.lang.String>	getParsers() get all parsers names
java.util.List<Prerenderer>	getPrerendersList() get list of all available Prerenderers
AbstractRenderer	getRenderer(java.lang.String name) get renderer by name (from RenderersFactory)s
java.util.Set<java.lang.String>	getRenderers() get all renderers name
void	setPrerendersList(java.util.List<Prerenderer> prerendersList) set list of Prerenderers that would be usedin this configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslatorConfiguration

public TranslatorConfiguration(java.io.InputStream parsersConfiguration,
                               RenderersFactory renderersFactory)

This constructor should be used when parsers configuration is defined in xml file

Parameters:

parsersConfiguration - InputStream with parsers configuration (special xml)

renderersFactory - RenderersFactory that contains map of renderers

TranslatorConfiguration

public TranslatorConfiguration(java.util.Map<java.lang.String,AbstractParser> parsersConfiguration,
                               RenderersFactory renderersFactory)

This constructor should be used when parsers configuration is defined in database. Then from these configuration map has to be created and passed to this constructor.

Parameters:

parsersConfiguration - A Map that contains configurations for parsers (Start tag of the parser <=> AbstractParser)

renderersFactory - RenderersFactory that contains map of renderers

Method Detail

getParser

public AbstractParser getParser(java.lang.String name)

get parser from the configuration by the name

Parameters:

name - name of the parser that should be returned

Returns:

parser that was found for a given name (or null if none was found)

getRenderer

public AbstractRenderer getRenderer(java.lang.String name)

get renderer by name (from RenderersFactory)s

Parameters:

name -

Returns:

renderer that was found for a given name (or null if none was found)

getParsers

public java.util.Set<java.lang.String> getParsers()

get all parsers names

Returns:

set of all names of parsers from this configuration

getRenderers

public java.util.Set<java.lang.String> getRenderers()

get all renderers name

Returns:

set of all names of renderers from this configuration

getDefaultRenderer

public AbstractRenderer getDefaultRenderer()

get default renderer

Returns:

default renderer for this configuration

addPrerenderer

public void addPrerenderer(Prerenderer prerenderer)

add Prerenderer to list of prerenderers

Parameters:

prerenderer -

getPrerendersList

public java.util.List<Prerenderer> getPrerendersList()

get list of all available Prerenderers

Returns:

list of all Prerenderers available for this configuration

setPrerendersList

public void setPrerendersList(java.util.List<Prerenderer> prerendersList)

set list of Prerenderers that would be usedin this configuration