org.safs.model.tools

Class ComponentGenerator

java.lang.Object

org.safs.model.tools.ComponentGenerator

public class ComponentGenerator
extends java.lang.Object

Process a standard SAFS AppMap file and create a static JSAFS-compatible AppMap with matching org.safs.model.Component references. These contain just item names and no recognition string information.

For a SAFS App Map named "App.map" this will create "AppMap.java".

If the input parameter is a directory, and not a specific file, then ALL *.map files will be processed into the resulting java file.

This Class is a standalone Java application typically invoked as shown below in static method 'main' below.

Author:

Carl Nagle Oct 15, 2013

See Also:

Component, main(String[])

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	ARG_ENCODING
(package private) static java.lang.String	ARG_IN
(package private) static java.lang.String	ARG_NAME
(package private) static java.lang.String	ARG_OUT
(package private) static java.lang.String	ARG_PACKAGE
(package private) static java.lang.String	BASH
(package private) static java.lang.String	EMPTY_SECTION
(package private) static java.lang.String	HASH
(package private) static java.lang.String	HELP_OUT
(package private) static java.lang.String	SEMI
(package private) static java.io.BufferedWriter	writer

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) java org.safs.model.tools.ComponentGenerator [args]
(package private) static java.lang.String	normalize(java.lang.String name) The purpose is to make a valid java variable/class name. Replace all invalid characters (not suitable for a java variable/class name) with "_". If the string start with numbers, remove those numbers. Valid characters are a-z, A-Z, 0-9 and _. As a map can contain "." in the section-name or item-name, and this program will convert the map to a java file, and these names are going to be used as java class-name or field-name, but "." is not valid for class/field name, we must convert it to a valid character "_".
(package private) static void	writeln(java.lang.String line)

Methods inherited from class java.lang.Object

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

Field Detail

writer

static java.io.BufferedWriter writer

ARG_IN

static final java.lang.String ARG_IN

See Also:

Constant Field Values

ARG_OUT

static final java.lang.String ARG_OUT

See Also:

Constant Field Values

ARG_NAME

static final java.lang.String ARG_NAME

See Also:

Constant Field Values

ARG_PACKAGE

static final java.lang.String ARG_PACKAGE

See Also:

Constant Field Values

ARG_ENCODING

static final java.lang.String ARG_ENCODING

See Also:

Constant Field Values

HELP_OUT

static final java.lang.String HELP_OUT

See Also:

Constant Field Values

EMPTY_SECTION

static final java.lang.String EMPTY_SECTION

See Also:

Constant Field Values

BASH

static final java.lang.String BASH

See Also:

Constant Field Values

SEMI

static final java.lang.String SEMI

See Also:

Constant Field Values

HASH

static final java.lang.String HASH

See Also:

Constant Field Values

Method Detail

writeln

static void writeln(java.lang.String line)
             throws java.io.IOException

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)

java org.safs.model.tools.ComponentGenerator [args]

args:

-in AppMapPath

REQUIRED relative or absolute path to the SAFS App Map file or directory to process.

Examples:

-in "TIDTest.map"
-in "C:/SAFS/Project/Datapool/TIDTest.map"
-in "C:/SAFS/Project/Datapool"

-out OutputDirectory

REQUIRED path to the directory in which to write the new Java Class file.

Example:

-out "C:/SAFS/DatastoreJ/"

-name classname

OPTIONAL Alternate name to give the generated class.

Example:

-name Map
-name AppMap
-name Comps

-package JavaPackageName

OPTIONAL package name to use for the output Java Class file. When not specified, no package name is written. The class is part of the nameless (default) Java package.

Example:

-package "org.safs.model.examples.advanced"

-encoding AppMapEncoding

OPTIONAL character encoding used for the existing SAFS App Map. This argument is actually REQUIRED if the SAFS App Map is encoded in something other than the System default character encoding.

Examples:

-encoding "UTF-8"
-encoding "UTF-16"
-encoding "ISO-SomethingOrOther"

Putting it all together for some sample invocations:

  java org.safs.model.tools.ComponentGenerator -in "TIDTest.map" -out "c:/safs/datastorej/"
  java org.safs.model.tools.ComponentGenerator -in "TIDTest.map" -out "c:/safs/datastorej/" -encoding "UTF-8"
  java org.safs.model.tools.ComponentGenerator -in "c:/safs/project/datapool/tidtest.map" -out "c:/safs/datastorej"
  java org.safs.model.tools.ComponentGenerator -in "tidtest.map" -out "c:/safs/datastorej/org/safs/sample/" -package "org.safs.sample"
  

normalize

static java.lang.String normalize(java.lang.String name)

The purpose is to make a valid java variable/class name.
Replace all invalid characters (not suitable for a java variable/class name) with "_".
If the string start with numbers, remove those numbers.
Valid characters are a-z, A-Z, 0-9 and _.
As a map can contain "." in the section-name or item-name, and this program
will convert the map to a java file, and these names are going to be used as
java class-name or field-name, but "." is not valid for class/field name, we
must convert it to a valid character "_".

Parameters:

name - String, the string to normalize

Returns:

String, the normalized string