geography/org.eclipse.stem.data.geography/src/org/eclipse/stem/data/geography/NameReader.java

package org.eclipse.stem.data.geography;

/*******************************************************************************
 * Copyright (c) 2011 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/


import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.StringTokenizer;

import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.osgi.framework.Bundle;

/** 
 * This class is still under construction
 * TODO: works but must remove hard coded strings
 * 
 * process the raw region names files to obtain a map
 * of names keyed by stemIDs
 * 
 */
public class NameReader {
	

	static final String nameFilesPrefix = "src/org/eclipse/stem/data/geography/"; //$NON-NLS-1$ 
	//static final String nameFilesPrefix = "platform:/plugin/org.eclipse.stem.data.geography/src/org/eclipse/stem/data/geography/"; //$NON-NLS-1$ 
	
	static final String nameFilesSuffix = "_names.properties"; //$NON-NLS-1$
	
	
	public Map<String, String> regionNamesMap= new HashMap<String, String>();
	
	/** 
	 * process the raw region names files to obtain a map
	 * of names keyed by stemIDs
	 * 
	 */
	public NameReader() {
		
	}

	/**
	 * main method for testing
	 * @param args
	 */
//	@SuppressWarnings("nls")
//	public static void main(String[] args) {
//		
//		NameReader nr = new NameReader();
//		String nameFilesPrefix = "/Users/jhkauf/Documents/workspace/org.eclipse.stem.data.geography/src/org/eclipse/stem/data/geography/"; //$NON-NLS-1$ 
//		String testfileName = nameFilesPrefix+"MEX_names.properties";
////		nr.readNames(testfileName);
//	}// main()
	

	/**
	 * 
	 * @param countryCode
	 * @return
	 */
	@SuppressWarnings("nls")
	public Map<String, String> readNamesByCountryCode(String countryCode) {
		Bundle bundle = Platform.getBundle("org.eclipse.stem.data.geography");
		Path path = new Path(nameFilesPrefix+countryCode+nameFilesSuffix);
		URL fileURL = FileLocator.find(bundle, path, null);
//		String fileName = rootWorkspace+nameFilesPrefix+countryCode+nameFilesSuffix;
//		File nameFile = new File(fileName);
		return readNames(fileURL);
	}
	
	/**
	 * read in the level one Names and keys
	 * 
	 */
	@SuppressWarnings("nls")
	public Map<String, String> readNames(URL url) {
		
			//Activator.logInformation("reading Names for "+fileName);
		String fname = url.getFile();
			BufferedReader fileReader = openReader(fname);
			try {
				// Add all the source URLs for this country.
				
				if (fileReader != null) {
					String buffer = null;
					while (EOF(buffer = fileReader.readLine()) != true) {

						//Activator.logInformation(" "+buffer);
						// Tokenize
						//
						if((buffer.indexOf("SOURCE")==-1)&&(buffer.indexOf("VALID")==-1)&&(buffer.indexOf("#")==-1)&&(buffer.indexOf("-")>=0)) {
							StringTokenizer tokenizer = new StringTokenizer(buffer, "="); //$NON-NLS-1$

							// Level 2
							
							String stemID2 = tokenizer.nextToken().trim();
							String name = tokenizer.nextToken();
							
							
							regionNamesMap.put(stemID2, name);
							//Activator.logInformation(" mapped "+stemID2+" to "+name );
						}
						
						
					}
				} 
				}catch (Exception e) {
					Activator.logInformation("Error reading file"+fname,e);
					e.printStackTrace();
					System.exit(1);
				}
				return regionNamesMap;
	
	}// readName(String fileName)
	
	
	/**
	 * Create a newBufferedReader
	 * 
	 * @param fileName
	 *            the name of the file we want to open for reading
	 * 
	 * @return a reader to a given file
	 */
	static protected BufferedReader openReader(String file) {

		try {

			File f = new File(file);

			if (f.exists() == false) {
				return null;
			}

			return new BufferedReader(new FileReader(file));

		} catch (Exception e) {
			e.printStackTrace();
		}

		return null;
	}

	
	
	
	/**
	 * Indicate End-Of-File
	 * 
	 * @param buffer
	 *            A buffer of diva data
	 * 
	 * @return True if we have reached End-Of-File
	 */
	static protected boolean EOF(String buffer) {
		if (buffer == null )
			return true;
		return false;
	}


	
	
	
	
	
	
}// class