Package me.datafox.dfxengine.text

Class TextFactoryImpl

java.lang.Object

me.datafox.dfxengine.text.TextFactoryImpl

All Implemented Interfaces:

TextFactory

public class TextFactoryImpl
extends Object
implements TextFactory

Implementation of TextFactory, a singleton class that generates Strings from Text objects. It manages Names, NameConverters, NumberFormatters, NumberSuffixFacctories, TextConfiguration and the PluralConverter. This class is designed to be used with the Injector.

Constructor Summary

Constructors

Constructor	Description
TextFactoryImpl(org.slf4j.Logger logger, HandleManager handleManager, TextHandles handles, List<Name<?>> names, List<NameConverter<?>> nameConverters, List<NumberFormatter> numberFormatters, List<NumberSuffixFormatter> numberSuffixFormatters, PluralConverter pluralConverter)

Method Summary

Modifier and Type	Method	Description
<T> Name<T>	addName(Name<T> name)
<T> void	addNameConverter(NameConverter<T> converter)
void	addNumberFormatter(NumberFormatter formatter)
void	addNumberSuffixFormatter(NumberSuffixFormatter formatter)	If no default NumberSuffixFormatter is set and this NumberSuffixFormatter can format any number (NumberSuffixFormatter.isInfinite() returns true), it will be set as default.
String	build(List<Text> texts)
String	build(Text text)
<T> Name<T>	createName(T object, String name)	The PluralConverter is used to generate the plural form.
<T> Name<T>	createName(T object, String singular, String plural)
TextConfiguration	getConfiguration()	This method should always return the same TextConfiguration instance.
NumberSuffixFormatter	getDefaultNumberSuffixFormatter()
<T> Name<T>	getName(T object)	If a Name associated with the object is present, it is returned.
<T> String	getName(T object, boolean plural)	If a Name associated with the object is present, it is used.
<T> NameConverter<T>	getNameConverter(Class<T> type)
NumberFormatter	getNumberFormatter(Handle handle)
NumberFormatter	getNumberFormatter(TextConfiguration configuration)
NumberSuffixFormatter	getNumberSuffixFormatter(Handle handle)
NumberSuffixFormatter	getNumberSuffixFormatter(TextConfiguration configuration)
PluralConverter	getPluralConverter()
void	initialize(List<TextConfiguration> configurations)
void	setConfiguration(TextConfiguration configuration)	Clears current TextConfiguration and applies the provided one to it.
void	setDefaultNumberSuffixFormatter(NumberSuffixFormatter formatter)	The default NumberSuffixFormatter must be capable of formatting any number (NumberSuffixFormatter.isInfinite() returns true).
void	setPluralConverter(PluralConverter converter)

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.datafox.dfxengine.text.api.TextFactory

getHandleManager

Constructor Details

TextFactoryImpl

public TextFactoryImpl(org.slf4j.Logger logger,
 HandleManager handleManager,
 TextHandles handles,
 List<Name<?>> names,
 List<NameConverter<?>> nameConverters,
 List<NumberFormatter> numberFormatters,
 List<NumberSuffixFormatter> numberSuffixFormatters,
 PluralConverter pluralConverter)

Parameters:

logger - Logger for this factory

handleManager - HandleManager for this factory

handles - TextHandles for this factory

names - Names for this factory

nameConverters - NameConverters for this factory

numberFormatters - NumberFormatters for this factory

numberSuffixFormatters - NumberSuffixFormatters for this factory

pluralConverter - PluralConverter for this factory

Method Details

build

public String build(Text text)

Specified by:

build in interface TextFactory

Parameters:

text - Text object to build

Returns:

String representation of the text

build

public String build(List<Text> texts)

Specified by:

build in interface TextFactory

Parameters:

texts - Text objects to build

Returns:

String representation of the texts

createName

public <T> Name<T> createName(T object,
 String name)

The PluralConverter is used to generate the plural form.

Specified by:

createName in interface TextFactory

Type Parameters:

T - type of the object

Parameters:

object - object to be named

name - name for the object in singular form

Returns:

Name associated with the object

createName

public <T> Name<T> createName(T object,
 String singular,
 String plural)

Specified by:

createName in interface TextFactory

Type Parameters:

T - type of the object to be named

Parameters:

object - object to be named

singular - name for the object in singular form

plural - name for the object in plural form

Returns:

Name associated with the object

addName

public <T> Name<T> addName(Name<T> name)

Specified by:

addName in interface TextFactory

Type Parameters:

T - type of the object to be named

Parameters:

name - Name object

Returns:

previous Name associated with the owner, or null if no previous mapping is present

getName

public <T> Name<T> getName(T object)

Description copied from interface: TextFactory

If a Name associated with the object is present, it is returned. Otherwise, a new Name is created using NameConverter if a valid one is present or Object.toString() if not. The PluralConverter will be used for the plural form if the NameConverter is not plural capable or not present.

Specified by:

getName in interface TextFactory

Type Parameters:

T - type of the object to be named

Parameters:

object - object to be named

Returns:

Name associated with the object

getName

public <T> String getName(T object,
 boolean plural)

Description copied from interface: TextFactory

If a Name associated with the object is present, it is used. Otherwise, a new Name is created using NameConverter if a valid one is present or Object.toString() if not. The PluralConverter will be used for the plural form if the NameConverter is not plural capable or not present.

Specified by:

getName in interface TextFactory

Type Parameters:

T - type of the object to be named

Parameters:

object - object to be named

plural - if true, the plural form is returned

Returns:

name of the object

addNameConverter

public <T> void addNameConverter(NameConverter<T> converter)

Specified by:

addNameConverter in interface TextFactory

Type Parameters:

T - type of the object that this NameConverter is capable of converting

Parameters:

converter - NameConverter to be registered

getNameConverter

public <T> NameConverter<T> getNameConverter(Class<T> type)

Specified by:

getNameConverter in interface TextFactory

Type Parameters:

T - type of the object to be named

Parameters:

type - Class of the object to be named

Returns:

NameConverter associated with the type or any of its interfaces or superclasses

addNumberFormatter

public void addNumberFormatter(NumberFormatter formatter)

Specified by:

addNumberFormatter in interface TextFactory

Parameters:

formatter - NumberFormatter to be registered

getNumberFormatter

public NumberFormatter getNumberFormatter(Handle handle)

Specified by:

getNumberFormatter in interface TextFactory

Parameters:

handle - Handle of a NumberFormatter

Returns:

NumberFormatter associated with the Handle or null if none is present

getNumberFormatter

public NumberFormatter getNumberFormatter(TextConfiguration configuration)

Specified by:

getNumberFormatter in interface TextFactory

Parameters:

configuration - TextConfiguration to be used

Returns:

NumberFormatter configured in the TextConfiguration or null if none is present

addNumberSuffixFormatter

public void addNumberSuffixFormatter(NumberSuffixFormatter formatter)

If no default NumberSuffixFormatter is set and this NumberSuffixFormatter can format any number (NumberSuffixFormatter.isInfinite() returns true), it will be set as default.

Specified by:

addNumberSuffixFormatter in interface TextFactory

Parameters:

formatter - NumberSuffixFormatter to be registered

getNumberSuffixFormatter

public NumberSuffixFormatter getNumberSuffixFormatter(Handle handle)

Specified by:

getNumberSuffixFormatter in interface TextFactory

Parameters:

handle - Handle of a NumberSuffixFormatter

Returns:

NumberSuffixFormatter associated with the Handle or null if none is present

getNumberSuffixFormatter

public NumberSuffixFormatter getNumberSuffixFormatter(TextConfiguration configuration)

Specified by:

getNumberSuffixFormatter in interface TextFactory

Parameters:

configuration - TextConfiguration to be used

Returns:

NumberSuffixFormatter configured in the TextConfiguration or null if none is present

setDefaultNumberSuffixFormatter

public void setDefaultNumberSuffixFormatter(NumberSuffixFormatter formatter)

The default NumberSuffixFormatter must be capable of formatting any number (NumberSuffixFormatter.isInfinite() returns true).

Specified by:

setDefaultNumberSuffixFormatter in interface TextFactory

Parameters:

formatter - NumberSuffixFormatter to be set as default

getDefaultNumberSuffixFormatter

public NumberSuffixFormatter getDefaultNumberSuffixFormatter()

Specified by:

getDefaultNumberSuffixFormatter in interface TextFactory

Returns:

default NumberSuffixFormatter or null if none is present

setConfiguration

public void setConfiguration(TextConfiguration configuration)

Clears current TextConfiguration and applies the provided one to it. This method should not overwrite the current TextConfiguration instance and only alter its state.

Specified by:

setConfiguration in interface TextFactory

Parameters:

configuration - TextConfiguration to be applied

getConfiguration

public TextConfiguration getConfiguration()

Description copied from interface: TextFactory

This method should always return the same TextConfiguration instance.

Specified by:

getConfiguration in interface TextFactory

Returns:

current TextConfiguration

setPluralConverter

public void setPluralConverter(PluralConverter converter)

Specified by:

setPluralConverter in interface TextFactory

Parameters:

converter - PluralConverter to be registered

getPluralConverter

public PluralConverter getPluralConverter()

Specified by:

getPluralConverter in interface TextFactory

Returns:

registered PluralConverter or null if none is present

initialize

public void initialize(List<TextConfiguration> configurations)