fj-i18n-xml-helper

Project to extract xml attributes or elements label and converting to property keys

1. Standalone tool quickstart

build :

mvn clean install -P singlepackage

run :

java -jar target/dist-fj-i18n-xml-helper-*.jar \
	--input-xml src/test/resources/config/test/xml \
	--output-xml target/test-output \
	--output-properties target/test-properties.xml \
	--convert-config src/test/resources/config/test/convert-config.xml

See sections on parameters and convert-config for more info.

2. API usage quickstart

Add maven dependency :

		<dependency>
			<groupId>org.fugerit.java</groupId>
			<artifactId>fj-i18n-xml-helper</artifactId>
			<version>${fj-i18n-xml-helper-version}</version>
		</dependency>	

		Properties params = new Properties();
		params.setProperty( I18NXmlHelper.ARG_CONVERT_CONFIG , "src/test/resources/config/test/convert-config.xml" );
		params.setProperty( I18NXmlHelper.ARG_INPUT_XML , "src/test/resources/config/test/xml" );
		params.setProperty( I18NXmlHelper.ARG_OUTPUT_XML , "target/test_xml" );
		params.setProperty( I18NXmlHelper.ARG_OUTPUT_PROPERTIES , "target/test_xml/test1_properties.xml" );
		params.setProperty( I18NXmlHelper.ARG_FILTER_EXT , "xml" );		// will filter files not ending with 'xml'
		try {
			int res = I18NXmlHelper.handle( params );
			Assert.assertEquals( Result.RESULT_CODE_OK , res );	
		} catch (ConfigRuntimeException e) {
			log.error( "Error "+e, e );
		}

It is possible to see the TestI18NXmlHelper unit test for an example.

See sections on parameters and convert-config for more info.

3. Parameters cheat sheet

name	required	default	description	since	info
input-xml	true	none	The input path to XML, if a directory all files will be handled recursively.	0.1.0	Will check only physical files
output-xml	true	none	The output path where to produce the XML, if input is a directory, output MUST be too.	0.1.0	The xml file indent can be different from input.
output-properties	true	none	The output xml properties containing the processed labels.	0.1.0	The order of the properties will not be random, but the same as they are found during processing.
convert-config	true	false	If set to true, the 'info' columns of tool parameters will be ignored.	0.1.0	By default will check on file system. To check path on class loader, prefix with 'cl://'
filter-ext	false	false	A extension filter, if inputXml is directory, only files matching the extension will be processed.	0.1.0	Directories will be recursed regardless of this param value.
catalog-rule-id	false	false	if set, the rule catalog in convert-config will be used instead of the default one.	0.1.0	If not set, the 'use-catalog' attribute of root xml element will be checked.
output-xslt	false	none	The path to an xslt, if not set a default xlst will be used, if set to 'legacy' can lead lead to different behaviors depending on JDK used.	0.1.0	See https://bugs.openjdk.org/browse/JDK-8262285?attachmentViewMode=list)
help	false	none	Print help about the tool.	0.1.0

4. convert-config cheat sheet

It is possible to see a sample configuration.

+--convert-config  - the main configuration, the default catalog can be set via 'use-catalog' attribute
   +--factory(*)   - a rule catalog, is a container for rules, 'id' attributes must be set
      +--data(*)   - implementation of a rule, attributes 'id', 'info' (for) and type ()
         +--config - custom configuration of a rule

The 'data' element

Attributes :

• id - id of the rule
• info - user defined information about the rule
• type - fully qualified name of a class implementing org.fugerit.java.tool.i18n.xml.convert.ConvertRule

And a child element 'config' with a custom configuration which will be passed by to ConvertRule.config() method.

5. Bundled convert rules

In API Mode it is possible to define custom rules, but there are some bundled ones in pacakge org.fugerit.java.tool.i18n.xml.convert.rules.bundled :

5.1 LabelExtract

Main rule, process elements and salve keys to properties.

config attributes

• elementFromPath : xpath to the parent element to process
• elementFrom : child element of elementFromPath to be processed for lebel
• elementTo : the new lement to be created with the property keys

The config element can have one or more key processing handler, which will transform the key to be set in property file :

keyTextHandler - See section 6. Text handlers

5.2 ElementRemove

Utility rule, remove an element with given path, no actions on the label properties.

config attributes

• elementToRemovePath : xpath to the element to remove

6. Text handlers

In some rules it is possible to set a chain of handlers, any handlers can have the following attributes :

test handler attributes

• id : id of the handler (can be used as description)
• position : 'prefix' or 'suffix' to set where the current handler result will be added.
• mode :
  • 'fixed' : the value attribute will be simply added
  • 'node' : will do a xpath search on current element for value path, and the value will be added (1), the found value will be normalized to aphanumeric.
  • 'normalize' : if value is 'removeWhitespaces' will simply remove whitespaces, if 'alphanumeric' will remove all non alphanumeric characters. 'regex' will be the value if provided to remove not wanted characters.
  • 'cut' : value should be the maximum size of the key
• value : see above for mode attribute.
• altValue : may sometimes be used by some mode
• info : may sometimes be used by some mode
• regex for 'node' and 'normalize', can be used to customized character removal expressions (for instance [^a-zA-Z0-9\.] will keep only alphanumeric and docs).

(1) - in 'node' mode if value is not found as a path, altValue will be tried in the same way. If again no result info attribute will be take as fixed value. And at last it will produce empty string.