Dictionary.java

/**
 * 
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
 * 
 * @author Wei Zhang,  Language Technology Institute, School of Computer Science, Carnegie-Mellon University.
 * email: wei.zhang@cs.cmu.edu
 * 
 */
package edu.cmu.geolocator.resource.dictionary;

import java.io.BufferedReader;
import java.io.IOException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;

import edu.cmu.geolocator.common.StringUtil;
import edu.cmu.geolocator.io.GetReader;

//This gazetteer is just for quick search.

public class Dictionary {

	public static enum DicType {
		SET, MAP, GAZ
	};

	public static enum MapValueType {
		POPULATION, COUNTRY, GEONAMEGAZENTRY
	};

	HashSet<String> set;
	HashMap<String, String> map;

	public Object getDic(DicType t) {
		if (t == DicType.SET)
			return set;
		else if (t == DicType.MAP)
			return map;
		else
			return null;

	}

	// type is to determine if the file is from geonames or from dictionary.
	Dictionary(DicType type, int size) {
		if (type == DicType.SET)
			set = new HashSet<String>(size);
		else if (type == DicType.MAP)
			map = new HashMap<String, String>(size);
		else
			System.err
					.println("Dictionary Type is wrong. Sould be dictionary(HashSet) or map(HashMap)");
	}

	// read file from dictionary file
	// keepspace to add to the dictionary if true.
	public static Dictionary getSetFromListFile(String filename,
			 boolean normalized, boolean keepspace)
			throws IOException {
		Dictionary d = new Dictionary(DicType.SET, 20);
		BufferedReader reader = GetReader.getUTF8FileReader(filename);
		String e;
//		int count = 0;
		if (keepspace) {

			while ((e = reader.readLine()) != null) {
				if (e.startsWith("##"))
					continue;
				if (normalized)
					e = StringUtil.getDeAccentLoweredString(e.trim());
				if(e.endsWith("'s"))
					d.set.add(StringUtil.getDeAccentLoweredString(e.substring(0,e.length()-2)));
				d.set.add(StringUtil.getDeAccentLoweredString(e));
			}

		} else {
			while ((e = reader.readLine()) != null) {
				if (e.startsWith("##"))
					continue;
				e = e.replace(" ", "");
				if (normalized)
					e = StringUtil.getDeAccentLoweredString(e.trim());
				if(e.endsWith("'s"))
					d.set.add(StringUtil.getDeAccentLoweredString(e.substring(0,e.length()-2)));
				
				d.set.add(StringUtil.getDeAccentLoweredString(e));
			}
		}
		reader.close();
		return d;
	}

	public static Dictionary getSetFromListFile(String filename, int size,
			 boolean normalized, boolean keepspace)
			throws IOException {
		Dictionary d = new Dictionary(DicType.SET, 20);
		BufferedReader reader = GetReader.getUTF8FileReader(filename);
		String e;
		int count = 0;
		if (keepspace) {

			while ((e = reader.readLine()) != null) {
				if(count++<size)break;
				if (e.startsWith("##"))
					continue;
				if (normalized)
					e = StringUtil.getDeAccentLoweredString(e.trim());
				if(e.endsWith("'s"))
					d.set.add(StringUtil.getDeAccentLoweredString(e.substring(0,e.length()-2)));
				
				d.set.add(StringUtil.getDeAccentLoweredString(e));
			}

		} else {
			while ((e = reader.readLine()) != null) {
				if (e.startsWith("##"))
					continue;
				e = e.replace(" ", "");
				if (normalized)
					e = StringUtil.getDeAccentLoweredString(e.trim());
				if(e.endsWith("'s"))
					d.set.add(StringUtil.getDeAccentLoweredString(e.substring(0,e.length()-2)));
				
				d.set.add(StringUtil.getDeAccentLoweredString(e));
			}
		}
		reader.close();
		return d;
	}


	public static void main(String argv[]) throws Exception {

	}
}