/** This method sets up and runs this generator. */
public void run() {
// Read and keep in memory a list of the countries we want.
targetList = GenUtils.populateList(targetFile);
// Read and keep in memory a list of the ISO3166-1 ALPHA2, ALPHA3, and
// numeric codes.
codeList = GenUtils.populateList(iso3166_1);
// Read and keep in memory a list of the missing ISO3166-2 codes
codefixList = GenUtils.populateList(fixFile);
// Now, process each item in the target list.
process();
}
/**
* Args: {@code --inputDirectory src/main/java --viewsPackageName com.app.views
* --resourcesPackageName com.app.resources --outputDirectory target/gen}.
*/
public static void main(final String[] args) throws Exception {
final Map<String, String> settings = GenUtils.parseArgs(args);
final File inputDirectory = new File(settings.get("inputDirectory"));
final File outputDirectory = new File(settings.get("outputDirectory"));
final String viewsPackageName = settings.get("viewsPackageName");
final String resourcesPackageName = settings.get("resourcesPackageName");
Generator generator = new Generator(inputDirectory, outputDirectory);
generator.setViewsPackageName(viewsPackageName);
generator.setResourcesPackageName(resourcesPackageName);
generator.generate();
}
/**
* Process our global list of target countries. For each country in list, generate its
* name.properties file.
*/
protected void process() {
final int LEVEL_1 = 1;
final int LEVEL_2 = 2;
// A writer for the new file we are creating.
PrintWriter propertiesFile = null;
// Object holding ISO3166-1 related data.
ISOCode1 isoCode = null;
// Name of the new properties file.
String fileName = null;
// A list for ISO 3166-2 objects
List<ISOCode2> iso2List = new ArrayList<ISOCode2>();
// Filenames for lex1 and lex2 files for a given country.
String lexAdmin1File = null;
String lexAdmin2File = null;
// Lists holding the lex1 and lex2 values.
// NOTE: lex values are the lexicographically sorted values for
// administration levels.
List<String> lex1DataSet = null;
List<String> lex2DataSet = null;
// Lists for holding lex1 and lex2 objects for a given country.
List<Lex1Obj> lex1List = null;
List<Lex2Obj> lex2List = null;
int size = targetList.size();
// Iterate for every country and create its names.properties file.
for (int i = 0; i < size; i++) {
// Get the next country in the list.
String file = targetList.get(i).trim();
// An index for unknwon or n.a. entries
int unkCounter = 1;
// Open the data source file for this country.
BufferedReader reader = GenUtils.openReader(file);
System.out.println(
"\t\t<<<< NAME GENERATOR -- Processing country : "
+ file
+ " >>>>"); //$NON-NLS-1$ //$NON-NLS-2$
try {
if (reader != null) {
String buffer = null;
// Describes level
// of data we
// are now processing : LEVEL0, LEVEL1, or LEVEL2.
int level = -1;
// Record the previous level.
int oldlevel = level - 1;
// We take a chunk of the data [BUFFER_MIN,BUFFER_MAX] to
// make processing more
// efficient, we dont need all of it.
int BUFFER_MIN = 0;
int BUFFER_MAX = 120;
// String used to ignore repeated entries.
List<String> entryList = null;
while (GenUtils.EOF(buffer = reader.readLine()) != true) {
// Make sure that we mark all unknown data.
buffer = buffer.replace(",,", ",UNKNOWN,"); // $NON-NLS-1$ //$NON-NLS-2$
String[] items =
GenUtils.extract(
buffer.length() < BUFFER_MAX
? buffer
: buffer.substring(BUFFER_MIN, BUFFER_MAX));
// Get the ISO3166-1 info for this country
if (isoCode == null) {
isoCode = GenUtils.getISOCode(items[ISOData.COUNTRY_NAME], codeList);
}
// Get the level of the data we are processing.
level = GenUtils.getDataLevel(items);
if (level != 0 && iso2List != null) {
// Load the ISO 3166-2 objects for this country
iso2List = GenUtils.loadISO2(iso3166_2);
}
// If the directory does not exist for this country,
// create it using ISO alpha3 code.
File countryDir = new File(outputDir + isoCode.getAlpha3());
if (countryDir != null && countryDir.exists() == false) {
// Directory does not exist. Create it.
countryDir.mkdir();
}
// Create and open the new file.
if (propertiesFile == null) {
// Create the file name for the new properties.file.
fileName =
countryDir
+ "\\"
+ isoCode.getAlpha3() // $NON-NLS-1$
+ "_names.properties"; //$NON-NLS-1$
// Create tne new properties.file for this country.
propertiesFile = GenUtils.openWriter(fileName);
}
// This variable indicates a transition in our data
// processing
boolean transition = (level != oldlevel) ? true : false;
// Variable used to hold the formatted output data.
String data = null;
// The current entity we are dealing with.
// Based on its admin level it can be a country, a
// county, etc;
String current = null;
// We have switched to a different data level (i,e,
// admin 0 to admin 1)
if (transition == true) {
// Keep track of previous level in order to detect
// transitions.
oldlevel = level;
// Reset our repeated history
if (entryList != null) {
entryList.clear();
}
entryList = new ArrayList<String>();
// Reset counter of UNKNOWN and N.A. entries.
unkCounter = 1;
if (level == 0) {
// Add an explanation of the key format in our
// data files.
data = GenUtils.getKeyFormatExplanation();
// Add the header.
data += getHeader(isoCode, level);
} else {
// Add the header
data = getHeader(isoCode, level);
}
GenUtils.addData(propertiesFile, data);
data = null;
}
switch (level) {
case DataTypes.LEVEL_0:
// Handle level 0 data different than the other
// admin levels.
if (transition == true) {
data =
items[ISOData.ALPHA3_CODE]
+ " = " //$NON-NLS-1$
+ items[ISOData.COUNTRY_NAME]
+ "\n"; //$NON-NLS-1$
GenUtils.addData(propertiesFile, data);
}
continue;
case DataTypes.LEVEL_1:
current = items[ISOData.ADMIN1_NAME].toUpperCase();
break;
case DataTypes.LEVEL_2:
current = items[ISOData.ADMIN2_NAME].toUpperCase();
break;
} // Switch
// Handle UNKNOWN and N.A. entries differently.
if (current.equals("UNKNOWN") || current.equals("N.A.")) { // $NON-NLS-1$ //$NON-NLS-2$
if (level == 1) {
current =
isoCode.getAlpha2()
+ "-UNK-" //$NON-NLS-1$
+ String.valueOf(unkCounter++);
} else {
// Level 2 data.
current =
isoCode.getAlpha3()
+ ".L2." //$NON-NLS-1$
+ String.valueOf(unkCounter++);
}
}
// Verify for repeated entries -- avvoid duplcates
switch (level) {
case LEVEL_1:
if (GenUtils.isRepeated(current, entryList) == true) {
// Duplicated, ignore.
continue;
}
// Remember this entity to avoid duplicates.
entryList.add(current);
break;
case LEVEL_2:
if (GenUtils.isRepeated(items[ISOData.ADMIN1_NAME] + current, entryList) == true) {
// Duplicated, ignore.
continue;
}
// Remember this entity to avoid duplicates.
entryList.add(items[ISOData.ADMIN1_NAME] + current);
break;
}
String descriptor = null;
// We get the descriptor for administration entities
// differently based on its level.
if (level == 2) {
if (lex1DataSet == null && lex2DataSet == null) {
// Compose the file names for the lex files for
// this
// country.
lexAdmin1File =
lexDir + isoCode.getAlpha3() + "\\" + isoCode.getAlpha3(); // $NON-NLS-1$
lexAdmin2File = lexAdmin1File;
lexAdmin1File += "_ADMIN1_LEX.txt"; // $NON-NLS-1$
lexAdmin2File += "_ADMIN2_LEX.txt"; // $NON-NLS-1$
// Load the lex1 and lex2 files for this
// country.
lex1DataSet = GenUtils.populateList(lexAdmin1File);
lex2DataSet = GenUtils.populateList(lexAdmin2File);
// Create a method to search for an item on a
// list of lex data objects.
lex1List = GenUtils.createLex1List(lex1DataSet);
lex2List = GenUtils.createLex2List(lex2DataSet);
}
// Compose the level2 descriptor using the lex data:
// STEP 1: Do a look up in the lex 2 lists.
// Get the lex 2 object for the current entry.
Lex2Obj lex2Current =
GenUtils.lex2Lookup(lex2List, items[ISOData.ADMIN1_NAME], current);
// Get the lex 1 object to which lex2Current belongs
// to.
Lex1Obj lex1Current = GenUtils.lex1Lookup(lex1List, lex2Current.getAdmin1());
// STEP 2: piece together the ID using the
// proper lex objects : the USA is a special
// case
if (lex1Current.getDescriptor().contains("US-")) { // $NON-NLS-1$
descriptor =
lex1Current.getDescriptor()
+ "-" //$NON-NLS-1$
+ lex1Current.getFormattedIndex()
+ lex2Current.getFormattedIndexUSA();
} else {
descriptor =
lex1Current.getDescriptor()
+ "-" //$NON-NLS-1$
+ "G"
+ lex1Current.getFormattedIndex() // $NON-NLS-1$
+ lex2Current.getFormattedIndex();
// Add some commens to allow reverse engineering
// or
// backtracking the origin of this generated key
// as
// much as possible.
data =
"# Generated key details : " //$NON-NLS-1$
+ " Level 1 ( " //$NON-NLS-1$
+ lex1Current.getDescriptor()
+ " = " //$NON-NLS-1$
+ lex1Current.getAdmin1()
+ " ). " //$NON-NLS-1$
+ "Level 2 ( " //$NON-NLS-1$
+ lex1Current.getFormattedIndex()
+ lex2Current.getFormattedIndex()
+ " = "
+ lex2Current.getAdmin2() // $NON-NLS-1$
+ " ). \n"; //$NON-NLS-1$
}
if (current.contains(".L2.")) { // $NON-NLS-1$
current = descriptor;
}
} else { // Compose descriptor for level 1 and level
// 0 data.
// Get the descriptor for this entity.
descriptor = GenUtils.getISO2Descriptor(iso2List, current, isoCode.getAlpha2());
// If we cant find the descriptor, then look in the
// fix list.
if (descriptor.equals(current) == true) {
// Look for a descriptor in the fix file
descriptor = GenUtils.getFixCode(codefixList, current, items[ISOData.COUNTRY_NAME]);
// If there is no descriptor still, generate
// one!
if (descriptor.equals(current) == true) {
descriptor =
isoCode.getAlpha2()
+ "-" //$NON-NLS-1$
+ current;
}
}
// Handle the USA as a special case
if (descriptor.contains("US-")) { // $NON-NLS-1$
data = "#" + current + "\n"; // $NON-NLS-1$ //$NON-NLS-2$
}
}
// System.out.println("Descriptor is : " + descriptor
// + " at level : " + level + " for " + current);
if (data != null) {
data += descriptor + " = " + current + "\n"; // $NON-NLS-1$ //$NON-NLS-2$
} else {
data = descriptor + " = " + current + "\n"; // $NON-NLS-1$ //$NON-NLS-2$
}
GenUtils.addData(propertiesFile, data);
data = null;
} // while
// Reset all lex-related items
if (lex1DataSet != null) {
lex1DataSet.clear();
lex1DataSet = null;
}
if (lex2DataSet != null) {
lex2DataSet.clear();
lex2DataSet = null;
}
if (lex1List != null) {
lex1List.clear();
lex1List = null;
}
if (lex2List != null) {
lex2List.clear();
lex2List = null;
}
lexAdmin1File = null;
lexAdmin2File = null;
// We dont need the ISO code object for this country
// anymore, we are done processing it.
isoCode = null;
// Close all open resources.
reader.close();
if (propertiesFile != null) {
propertiesFile.close();
propertiesFile = null;
System.out.println("\t\tGenerated : " + fileName); // $NON-NLS-1$
fileName = null;
}
// Run garbage collection
// System.gc();
}
} catch (IOException e) {
e.printStackTrace();
}
} // for
}
/** @param configFile */
public NameGenerator(String configFile) {
// Load all configuration variables
HashMap<String, String> vars = GenUtils.loadConfigFile(configFile);
Set<String> keys = vars.keySet();
Iterator it = keys.iterator();
while (it.hasNext()) {
String var = (String) it.next();
// Assign values to configuration variables :
if (var.equals("WORKSPACE")) { // $NON-NLS-1$
workspace = vars.get(var);
} else if (var.equals("ISO3166_1")) { // $NON-NLS-1$
iso3166_1 = vars.get(var);
} else if (var.equals("ISO3166_2")) { // $NON-NLS-1$
iso3166_2 = vars.get(var);
} else if (var.equals("ISO_FIX")) { // $NON-NLS-1$
fixFile = vars.get(var);
} else if (var.equals("TARGET_LIST")) { // $NON-NLS-1$
targetFile = vars.get(var);
} else if (var.equals("LEX_DIR")) { // $NON-NLS-1$
lexDir = vars.get(var);
} else if (var.equals("PROPERTIES_OUTPUT")) { // $NON-NLS-1$
outputDir = vars.get(var);
}
} // while
// The workspace variable should end with a slash character
if (workspace.endsWith("\\") == false) { // $NON-NLS-1$
workspace += "\\"; // $NON-NLS-1$
}
String path = workspace + GenConstants.PARAMS_DIR;
// Set remaining config vars using WORKSPACE (workspace relative)
if (iso3166_1 == null) {
iso3166_1 = path + GenConstants.ISO3166_1_FILE;
}
if (iso3166_2 == null) {
iso3166_2 = path + GenConstants.ISO3166_2_FILE;
}
if (fixFile == null) {
fixFile = path + GenConstants.ISOFIX_FILE;
}
if (targetFile == null) {
targetFile = path + GenConstants.COUNTRIES_LIST;
}
if (lexDir == null) {
lexDir = path + GenConstants.LEX_DIR;
}
if (outputDir == null) {
outputDir = workspace + GenConstants.PROPERTIES_OUTPUT_DIR;
}
targetList = null;
// Set the URL IDs that are relevant for area data.
initNameURLSet();
// Set which URLs are active and which ones should be commented out.
// setURLStatus();
}