net.sf.mmm.util.nls.base

Class ResourceBundleConverter

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.util.cli.api.AbstractMain

net.sf.mmm.util.cli.api.AbstractVersionedMain

net.sf.mmm.util.nls.base.AbstractResourceBundleCli

net.sf.mmm.util.nls.base.ResourceBundleConverter

@CliClass(usage="Converts resource-bundle property-files to different formats.")
 @CliMode(id="default",
         title="default",
         usage="Convert resource-bundle property-files from <bundle-class> for all available or the explicitly given locales. Example:\n\n{mainClass} --bundle-class foo.bar.NlsBundleMyExample \n\nFor each locale where a localization exists in property-file foo/bar/NlsBundleMyExample_<locale>.properties an according converted file is created in <path>. Already existing files will be overridden.")
public class ResourceBundleConverter
extends AbstractResourceBundleCli

This class can be used to create and update the localized bundles (properties) from an NlsBundle or AbstractResourceBundle. If you do not explicitly specify the bundle to synchronize as commandline option (using --bundle) this ResourceBundleConverter will automatically scan your classpath for NlsBundles and synchronize all of them.
This is a main-program to execute via command-line. Simply call it with the parameter --help to get help.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	argument
private static String	DEFAULT_ARGUMENT The default for option argument.
private ChoiceEvaluation	evalChoice
private Format	format
private Pattern	keyPattern
private String[]	locales
private NlsMessageFormatterFactory	messageFormatterFactory
static String	OPTION_ARGUMENT The command-line option to set the getFormat().
static String	OPTION_EVAL_CHOICE The command-line option to set the getEvalChoice().
static String	OPTION_FORMAT The command-line option to set the getFormat().
static String	OPTION_KEY_PATTERN The command-line option to set the key pattern.
static String	OPTION_PATH_EXPRESSION The command-line option to set the getFormat().
private String	pathExpression
private NlsResourceLocator	resourceLocator

Fields inherited from class net.sf.mmm.util.nls.base.AbstractResourceBundleCli

DEFAULT_BASE_PATH, OPTION_BUNDLE_CLASS, OPTION_DATE_PATTERN, OPTION_ENCODING, OPTION_LOCALE, OPTION_PATH

Fields inherited from class net.sf.mmm.util.cli.api.AbstractMain

EXIT_CODE_CONSTRAINT_VIOLATION, EXIT_CODE_ILLEGAL_SYNTAX, EXIT_CODE_OK, EXIT_CODE_UNEXPECTED

Constructor Summary

Constructors

Constructor and Description
ResourceBundleConverter() The constructor.

Method Summary

Modifier and Type	Method and Description
private void	convertArgument(NlsArgument nlsArgument, StringBuilder buffer, NlsMessageDescriptor messageDescriptor, List<String> argumentList)
private void	convertArgumentChoice(NlsFormatterChoice formatter, StringBuilder buffer, NlsMessageDescriptor messageDescriptor, List<String> argumentList)
private String	convertArgumentFormatter(NlsFormatterPlugin<?> formatter, String arg)
private String	convertArgumentIndex(NlsMessageDescriptor messageDescriptor, List<String> argumentList, String result, String key)
private String	convertArgumentJustification(Justification justification, String result)
private String	convertMessage(String message, String key, NlsBundleDescriptor bundle, String locale)
private String	convertSegment(String result, String segment, String type)
private NlsFormatterChoice.Choice	extracted(NlsFormatterChoice formatter)
String	getArgument()
ChoiceEvaluation	getEvalChoice()
Format	getFormat()
Pattern	getKeyPattern()
String[]	getLocales() This method gets the locales of the bundles that should be synchronized.
protected List<String>	getLocales(NlsBundleDescriptor bundle)
NlsMessageFormatterFactory	getMessageFormatterFactory()
String	getPathExpression()
protected String	getPathExpressionResolved(NlsBundleDescriptor bundle, String locale)
NlsResourceLocator	getResourceLocator()
protected File	getTargetFile(NlsBundleDescriptor bundle, String locale)
protected Map<String,String>	getVariableMap(NlsBundleDescriptor bundle, String locale)
static void	main(String[] arguments) This is the main method used to run this class as application.
protected int	runDefaultMode() This method is called from AbstractVersionedMain.run(CliModeObject) if the program is executed in default mode.
void	setArgument(String argument)
void	setEvalChoice(ChoiceEvaluation evalChoice)
void	setFormat(Format format)
void	setKeyPattern(Pattern pattern)
void	setLocales(String[] locales) This method sets the locales.
void	setPathExpression(String pathExpression)
protected void	synchronize(NlsBundleDescriptor bundle, String localeString, File targetFile, String date) Like AbstractResourceBundleCli.synchronize(NlsBundleDescriptor) but for a single Locale.

Methods inherited from class net.sf.mmm.util.nls.base.AbstractResourceBundleCli

getBundleClasses, getBundleHelper, getDatePattern, getEncoding, getNewline, getPath, getReflectionUtil, getResourceBundleLocator, getTargetFileMkdirs, setBundleClasses, setBundleHelper, setDatePattern, setEncoding, setLocales, setNewline, setPath, setReflectionUtil, setResourceBundleLocator, synchronize

Methods inherited from class net.sf.mmm.util.cli.api.AbstractVersionedMain

getVersion, run

Methods inherited from class net.sf.mmm.util.cli.api.AbstractMain

getIocContainer, getOutputSettings, getParserBuilder, getStandardError, getStandardOutput, getStreamUtil, handleError, printHelp, run, runAndExit, setStandardError, setStandardOutput, validate

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_KEY_PATTERN

public static final String OPTION_KEY_PATTERN

The command-line option to set the key pattern.

See Also:

Constant Field Values

OPTION_FORMAT

public static final String OPTION_FORMAT

The command-line option to set the getFormat().

See Also:

Constant Field Values

OPTION_PATH_EXPRESSION

public static final String OPTION_PATH_EXPRESSION

The command-line option to set the getFormat().

See Also:

Constant Field Values

OPTION_ARGUMENT

public static final String OPTION_ARGUMENT

The command-line option to set the getFormat().

See Also:

Constant Field Values

OPTION_EVAL_CHOICE

public static final String OPTION_EVAL_CHOICE

The command-line option to set the getEvalChoice().

See Also:

Constant Field Values

DEFAULT_ARGUMENT

private static final String DEFAULT_ARGUMENT

The default for option argument.

See Also:

Constant Field Values

locales

@CliOption(name="--locale",
           aliases="-l",
           operand="LOCALE",
           required=false,
           usage="The list of locales to process. Each locale has to be in the form \"ll[_CC[_vv]]\" where \"ll\" is the lowercase ISO 639 code, CC is the uppercase ISO 3166 2-letter code and vv is an arbitrary variant. Examples are \"de\", \"en_US\" or \"th_TH_TH\".")
private String[] locales

keyPattern

@CliOption(name="--key-pattern",
           aliases="-k",
           operand="REGEX",
           required=false,
           usage="Use {operand} as regular expression to filter the resource bundle keys (e.g. \"label.*\").")
private Pattern keyPattern

format

@CliOption(name="--format",
           aliases="-f",
           operand="FORMAT",
           required=false,
           usage="Write the converted output in the specified format {operand} (Default is \"{default}\").")
private Format format

pathExpression

@CliOption(name="--path-expression",
           aliases="-x",
           operand="EXP",
           required=false,
           usage="Use the expression {operand} for the path of the converted output file including filename relative to the output path (Default is \"{default}\").")
private String pathExpression

argument

@CliOption(name="--argument",
           aliases="-a",
           operand="EXP",
           required=false,
           usage="Convert the arguments of the messages to the format {operand} (e.g. \"\\{{key}}\" or \"\\{index,format}\"). Can be used to convert the syntax for other NLS frameworks such as angular-translate (Default is \"{default}\").")
private String argument

evalChoice

@CliOption(name="--eval-choice",
           aliases="-c",
           operand="EVAL",
           required=false,
           usage="Simplify and resolve CHOICE format expressions using {operand}.")
private ChoiceEvaluation evalChoice

resourceLocator

private NlsResourceLocator resourceLocator

messageFormatterFactory

private NlsMessageFormatterFactory messageFormatterFactory

Constructor Detail

ResourceBundleConverter

public ResourceBundleConverter()

The constructor.

Method Detail

getResourceLocator

public NlsResourceLocator getResourceLocator()

Returns:

the resourceLocator

getMessageFormatterFactory

public NlsMessageFormatterFactory getMessageFormatterFactory()

Returns:

the messageFormatterFactory

getKeyPattern

public Pattern getKeyPattern()

Returns:

the optional Pattern the resource bundle keys have to match for being added to the converted file.

setKeyPattern

public void setKeyPattern(Pattern pattern)

Parameters:

pattern - the new value of getKeyPattern().

getFormat

public Format getFormat()

Returns:

the Format to convert to.

setFormat

public void setFormat(Format format)

Parameters:

format - the new value of getFormat().

getPathExpression

public String getPathExpression()

Returns:

the expression for the path of the converted output file relative to AbstractResourceBundleCli.getPath(). Includes an optional path and the filename.

setPathExpression

public void setPathExpression(String pathExpression)

Parameters:

pathExpression - the new value of getPathExpression().

getArgument

public String getArgument()

Returns:

the expression/pattern used to convert NlsArguments.

setArgument

public void setArgument(String argument)

Parameters:

argument - the new value of getArgument().

getEvalChoice

public ChoiceEvaluation getEvalChoice()

Returns:

the ChoiceEvaluation or null to leave unmodified.

setEvalChoice

public void setEvalChoice(ChoiceEvaluation evalChoice)

Parameters:

evalChoice - the new value of getEvalChoice().

getLocales

public String[] getLocales()

Description copied from class: AbstractResourceBundleCli

This method gets the locales of the bundles that should be synchronized. Examples for locales (entries of the returned array) are "", "en", or "en_GB".

Specified by:

getLocales in class AbstractResourceBundleCli

Returns:

the locales to create/update.

setLocales

public void setLocales(String[] locales)

Description copied from class: AbstractResourceBundleCli

This method sets the locales.

Specified by:

setLocales in class AbstractResourceBundleCli

Parameters:

locales - are the locales to set

getLocales

protected List<String> getLocales(NlsBundleDescriptor bundle)

Overrides:

getLocales in class AbstractResourceBundleCli

Parameters:

bundle - the NlsBundleDescriptor.

Returns:

the locales to process for the bundle.

getTargetFile

protected File getTargetFile(NlsBundleDescriptor bundle,
                             String locale)

Specified by:

getTargetFile in class AbstractResourceBundleCli

getPathExpressionResolved

protected String getPathExpressionResolved(NlsBundleDescriptor bundle,
                                           String locale)

Parameters:

bundle - the NlsBundleDescriptor.

locale - the Locale.

Returns:

the path expression with all variables resolved.

getVariableMap

protected Map<String,String> getVariableMap(NlsBundleDescriptor bundle,
                                            String locale)

Parameters:

bundle - the NlsBundleDescriptor.

locale - the Locale.

Returns:

a Map with the variables to resolve.

runDefaultMode

protected int runDefaultMode()
                      throws Exception

Description copied from class: AbstractVersionedMain

This method is called from AbstractVersionedMain.run(CliModeObject) if the program is executed in default mode.

Overrides:

runDefaultMode in class AbstractResourceBundleCli

Returns:

the error-code or AbstractMain.EXIT_CODE_OK on success.

Throws:

Exception - in case of an unexpected error.

synchronize

protected void synchronize(NlsBundleDescriptor bundle,
                           String localeString,
                           File targetFile,
                           String date)
                    throws IOException

Description copied from class: AbstractResourceBundleCli

Like AbstractResourceBundleCli.synchronize(NlsBundleDescriptor) but for a single Locale.

Specified by:

synchronize in class AbstractResourceBundleCli

Parameters:

bundle - the bundle instance as java object.

localeString - the locale to synchronize as string.

targetFile - the File to write to. May not yet exists but parent folder exists.

date - is the current date as string.

Throws:

IOException - if an I/O problem occurred.

convertMessage

private String convertMessage(String message,
                              String key,
                              NlsBundleDescriptor bundle,
                              String locale)

convertArgument

private void convertArgument(NlsArgument nlsArgument,
                             StringBuilder buffer,
                             NlsMessageDescriptor messageDescriptor,
                             List<String> argumentList)

convertArgumentChoice

private void convertArgumentChoice(NlsFormatterChoice formatter,
                                   StringBuilder buffer,
                                   NlsMessageDescriptor messageDescriptor,
                                   List<String> argumentList)

extracted

private NlsFormatterChoice.Choice extracted(NlsFormatterChoice formatter)

convertArgumentIndex

private String convertArgumentIndex(NlsMessageDescriptor messageDescriptor,
                                    List<String> argumentList,
                                    String result,
                                    String key)

convertArgumentFormatter

private String convertArgumentFormatter(NlsFormatterPlugin<?> formatter,
                                        String arg)

convertSegment

private String convertSegment(String result,
                              String segment,
                              String type)

convertArgumentJustification

private String convertArgumentJustification(Justification justification,
                                            String result)

main

public static void main(String[] arguments)

This is the main method used to run this class as application.

Parameters:

arguments - are the command-line arguments.