de.viaboxx.nlstools.tasks

Class MergeLocaleTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

de.viaboxx.nlstools.tasks.MergeLocaleTask

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DiffMergeLocaleTask

public class MergeLocaleTask
extends org.apache.tools.ant.Task

This task takes two bundles and is able to merge new locales in one file into the existing bundle. This is useful if the translation is not a complete version of the locale bundle and you can't just replace the file. If there are translations missing, it inserts empty messages for that key. Example:

 <taskdef name="mergeLocale">
 classname="de.viaboxx.nlstools.tasks.MergeLocaleTask">
 <classpath refid="maven.test.classpath"/>
 </taskdef>

 <mergeLocale
 from="src/main/bundles/Common.xml"
 with="src/main/bundles/Common_de_DE.xml"
 locales="de_DE;en,it" (if empty, process ALL locales)
 to="src/main/bundles/Common_de_DE.xml"/>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected MBBundles	loadedBundles
protected MBBundles	translatedBundles

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
MergeLocaleTask()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected MBText	findMBTextForLocale(String key, String locale, MBBundles bundles)
String	getBundleNames() merge specific bundles only. if empty (default), merge all bundles.
File	getFrom() The xml file with path name to read from
String	getLocales() semicolon separated locale names
File	getTo() The xml file with the path name to write into
File	getWith() The xml file with new translated locales
protected boolean	isBundleToProcess(MBBundle bundle)
protected void	loadExecute()
static String	localesString(MBBundles bundles, String locales)
static String	localesString(Set<String> locales)
protected void	outputExecute()
protected void	processExecute()
void	setBundleNames(String bundleNames)
void	setFrom(File from)
void	setLocales(String locales)
void	setTo(File to)
void	setWith(File xmlWithNewLocale)
static StringTokenizer	tokenize(String input)

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Field Detail

loadedBundles

protected MBBundles loadedBundles

translatedBundles

protected MBBundles translatedBundles

Constructor Detail

MergeLocaleTask

public MergeLocaleTask()

Method Detail

getFrom

public File getFrom()

The xml file with path name to read from

Returns:

setFrom

public void setFrom(File from)

getTo

public File getTo()

The xml file with the path name to write into

Returns:

setTo

public void setTo(File to)

getWith

public File getWith()

The xml file with new translated locales

Returns:

setWith

public void setWith(File xmlWithNewLocale)

getBundleNames

public String getBundleNames()

merge specific bundles only. if empty (default), merge all bundles. bundle names separated by , or ;

Returns:

setBundleNames

public void setBundleNames(String bundleNames)

getLocales

public String getLocales()

semicolon separated locale names

Returns:

setLocales

public void setLocales(String locales)

execute

public void execute()

Overrides:

execute in class org.apache.tools.ant.Task

tokenize

public static StringTokenizer tokenize(String input)

localesString

public static String localesString(Set<String> locales)

localesString

public static String localesString(MBBundles bundles,
                                   String locales)

isBundleToProcess

protected boolean isBundleToProcess(MBBundle bundle)

processExecute

protected void processExecute()

outputExecute

protected void outputExecute()
                      throws Exception

Throws:

Exception

loadExecute

protected void loadExecute()
                    throws Exception

Throws:

Exception

findMBTextForLocale

protected MBText findMBTextForLocale(String key,
                                     String locale,
                                     MBBundles bundles)