phonelib 0.6.5 → 0.6.6

data/data/libphonenumber/java/internal/prefixmapper/src/com/google/i18n/phonenumbers/prefixmapper/PhonePrefixMap.java

@@ -1,216 +0,0 @@
-/*
- * Copyright (C) 2011 The Libphonenumber Authors
- *
- * Licensed 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.
- */
-
-package com.google.i18n.phonenumbers.prefixmapper;
-
-import com.google.i18n.phonenumbers.PhoneNumberUtil;
-import com.google.i18n.phonenumbers.Phonenumber.PhoneNumber;
-
-import java.io.ByteArrayOutputStream;
-import java.io.Externalizable;
-import java.io.IOException;
-import java.io.ObjectInput;
-import java.io.ObjectOutput;
-import java.io.ObjectOutputStream;
-import java.util.SortedMap;
-import java.util.SortedSet;
-import java.util.logging.Logger;
-
-/**
- * A utility that maps phone number prefixes to a description string, which may be, for example,
- * the geographical area the prefix covers.
- *
- * @author Shaopeng Jia
- */
-public class PhonePrefixMap implements Externalizable {
-  private final PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
-  private static final Logger LOGGER = Logger.getLogger(PhonePrefixMap.class.getName());
-
-  private PhonePrefixMapStorageStrategy phonePrefixMapStorage;
-
-  // @VisibleForTesting
-  PhonePrefixMapStorageStrategy getPhonePrefixMapStorage() {
-    return phonePrefixMapStorage;
-  }
-
-  /**
-   * Creates an empty {@link PhonePrefixMap}. The default constructor is necessary for implementing
-   * {@link Externalizable}. The empty map could later be populated by
-   * {@link #readPhonePrefixMap(java.util.SortedMap)} or {@link #readExternal(java.io.ObjectInput)}.
-   */
-  public PhonePrefixMap() {}
-
-  /**
-   * Gets the size of the provided phone prefix map storage. The map storage passed-in will be
-   * filled as a result.
-   */
-  private static int getSizeOfPhonePrefixMapStorage(PhonePrefixMapStorageStrategy mapStorage,
-      SortedMap<Integer, String> phonePrefixMap) throws IOException {
-    mapStorage.readFromSortedMap(phonePrefixMap);
-    ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
-    ObjectOutputStream objectOutputStream = new ObjectOutputStream(byteArrayOutputStream);
-    mapStorage.writeExternal(objectOutputStream);
-    objectOutputStream.flush();
-    int sizeOfStorage = byteArrayOutputStream.size();
-    objectOutputStream.close();
-    return sizeOfStorage;
-  }
-
-  private PhonePrefixMapStorageStrategy createDefaultMapStorage() {
-    return new DefaultMapStorage();
-  }
-
-  private PhonePrefixMapStorageStrategy createFlyweightMapStorage() {
-    return new FlyweightMapStorage();
-  }
-
-  /**
-   * Gets the smaller phone prefix map storage strategy according to the provided phone prefix map.
-   * It actually uses (outputs the data to a stream) both strategies and retains the best one which
-   * make this method quite expensive.
-   */
-  // @VisibleForTesting
-  PhonePrefixMapStorageStrategy getSmallerMapStorage(SortedMap<Integer, String> phonePrefixMap) {
-    try {
-      PhonePrefixMapStorageStrategy flyweightMapStorage = createFlyweightMapStorage();
-      int sizeOfFlyweightMapStorage = getSizeOfPhonePrefixMapStorage(flyweightMapStorage,
-                                                                     phonePrefixMap);
-
-      PhonePrefixMapStorageStrategy defaultMapStorage = createDefaultMapStorage();
-      int sizeOfDefaultMapStorage = getSizeOfPhonePrefixMapStorage(defaultMapStorage,
-                                                                   phonePrefixMap);
-
-      return sizeOfFlyweightMapStorage < sizeOfDefaultMapStorage
-          ? flyweightMapStorage : defaultMapStorage;
-    } catch (IOException e) {
-      LOGGER.severe(e.getMessage());
-      return createFlyweightMapStorage();
-    }
-  }
-
-  /**
-   * Creates an {@link PhonePrefixMap} initialized with {@code sortedPhonePrefixMap}.  Note that the
-   * underlying implementation of this method is expensive thus should not be called by
-   * time-critical applications.
-   *
-   * @param sortedPhonePrefixMap  a map from phone number prefixes to descriptions of those prefixes
-   * sorted in ascending order of the phone number prefixes as integers.
-   */
-  public void readPhonePrefixMap(SortedMap<Integer, String> sortedPhonePrefixMap) {
-    phonePrefixMapStorage = getSmallerMapStorage(sortedPhonePrefixMap);
-  }
-
-  /**
-   * Supports Java Serialization.
-   */
-  public void readExternal(ObjectInput objectInput) throws IOException {
-    // Read the phone prefix map storage strategy flag.
-    boolean useFlyweightMapStorage = objectInput.readBoolean();
-    if (useFlyweightMapStorage) {
-      phonePrefixMapStorage = new FlyweightMapStorage();
-    } else {
-      phonePrefixMapStorage = new DefaultMapStorage();
-    }
-    phonePrefixMapStorage.readExternal(objectInput);
-  }
-
-  /**
-   * Supports Java Serialization.
-   */
-  public void writeExternal(ObjectOutput objectOutput) throws IOException {
-    objectOutput.writeBoolean(phonePrefixMapStorage instanceof FlyweightMapStorage);
-    phonePrefixMapStorage.writeExternal(objectOutput);
-  }
-
-  /**
-   * Returns the description of the {@code number}. This method distinguishes the case of an invalid
-   * prefix and a prefix for which the name is not available in the current language. If the
-   * description is not available in the current language an empty string is returned. If no
-   * description was found for the provided number, null is returned.
-   *
-   * @param number  the phone number to look up
-   * @return  the description of the number
-   */
-  String lookup(long number) {
-    int numOfEntries = phonePrefixMapStorage.getNumOfEntries();
-    if (numOfEntries == 0) {
-      return null;
-    }
-    long phonePrefix = number;
-    int currentIndex = numOfEntries - 1;
-    SortedSet<Integer> currentSetOfLengths = phonePrefixMapStorage.getPossibleLengths();
-    while (currentSetOfLengths.size() > 0) {
-      Integer possibleLength = currentSetOfLengths.last();
-      String phonePrefixStr = String.valueOf(phonePrefix);
-      if (phonePrefixStr.length() > possibleLength) {
-        phonePrefix = Long.parseLong(phonePrefixStr.substring(0, possibleLength));
-      }
-      currentIndex = binarySearch(0, currentIndex, phonePrefix);
-      if (currentIndex < 0) {
-        return null;
-      }
-      int currentPrefix = phonePrefixMapStorage.getPrefix(currentIndex);
-      if (phonePrefix == currentPrefix) {
-        return phonePrefixMapStorage.getDescription(currentIndex);
-      }
-      currentSetOfLengths = currentSetOfLengths.headSet(possibleLength);
-    }
-    return null;
-  }
-
-  /**
-   * As per {@link #lookup(long)}, but receives the number as a PhoneNumber instead of a long.
-   *
-   * @param number  the phone number to look up
-   * @return  the description corresponding to the prefix that best matches this phone number
-   */
-  public String lookup(PhoneNumber number) {
-    long phonePrefix =
-        Long.parseLong(number.getCountryCode() + phoneUtil.getNationalSignificantNumber(number));
-    return lookup(phonePrefix);
-  }
-
-  /**
-   * Does a binary search for {@code value} in the provided array from {@code start} to {@code end}
-   * (inclusive). Returns the position if {@code value} is found; otherwise, returns the
-   * position which has the largest value that is less than {@code value}. This means if
-   * {@code value} is the smallest, -1 will be returned.
-   */
-  private int binarySearch(int start, int end, long value) {
-    int current = 0;
-    while (start <= end) {
-      current = (start + end) >>> 1;
-      int currentValue = phonePrefixMapStorage.getPrefix(current);
-      if (currentValue == value) {
-        return current;
-      } else if (currentValue > value) {
-        current--;
-        end = current;
-      } else {
-        start = current + 1;
-      }
-    }
-    return current;
-  }
-
-  /**
-   * Dumps the mappings contained in the phone prefix map.
-   */
-  @Override
-  public String toString() {
-    return phonePrefixMapStorage.toString();
-  }
-}

data/data/libphonenumber/java/internal/prefixmapper/src/com/google/i18n/phonenumbers/prefixmapper/PhonePrefixMapStorageStrategy.java

@@ -1,108 +0,0 @@
-/*
- * Copyright (C) 2011 The Libphonenumber Authors
- *
- * Licensed 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.
- */
-
-package com.google.i18n.phonenumbers.prefixmapper;
-
-import java.io.IOException;
-import java.io.ObjectInput;
-import java.io.ObjectOutput;
-import java.util.SortedMap;
-import java.util.TreeSet;
-
-/**
- * Abstracts the way phone prefix data is stored into memory and serialized to a stream. It is used
- * by {@link PhonePrefixMap} to support the most space-efficient storage strategy according to the
- * provided data.
- *
- * @author Philippe Liard
- */
-abstract class PhonePrefixMapStorageStrategy {
-  protected int numOfEntries = 0;
-  protected final TreeSet<Integer> possibleLengths = new TreeSet<Integer>();
-
-  /**
-   * Gets the phone number prefix located at the provided {@code index}.
-   *
-   * @param index  the index of the prefix that needs to be returned
-   * @return  the phone number prefix at the provided index
-   */
-  public abstract int getPrefix(int index);
-
-  /**
-   * Gets the description corresponding to the phone number prefix located at the provided {@code
-   * index}. If the description is not available in the current language an empty string is
-   * returned.
-   *
-   * @param index  the index of the phone number prefix that needs to be returned
-   * @return  the description corresponding to the phone number prefix at the provided index
-   */
-  public abstract String getDescription(int index);
-
-  /**
-   * Sets the internal state of the underlying storage implementation from the provided {@code
-   * sortedPhonePrefixMap} that maps phone number prefixes to description strings.
-   *
-   * @param sortedPhonePrefixMap  a sorted map that maps phone number prefixes including country
-   *    calling code to description strings
-   */
-  public abstract void readFromSortedMap(SortedMap<Integer, String> sortedPhonePrefixMap);
-
-  /**
-   * Sets the internal state of the underlying storage implementation reading the provided {@code
-   * objectInput}.
-   *
-   * @param objectInput  the object input stream from which the phone prefix map is read
-   * @throws IOException  if an error occurred reading the provided input stream
-   */
-  public abstract void readExternal(ObjectInput objectInput) throws IOException;
-
-  /**
-   * Writes the internal state of the underlying storage implementation to the provided {@code
-   * objectOutput}.
-   *
-   * @param objectOutput  the object output stream to which the phone prefix map is written
-   * @throws IOException  if an error occurred writing to the provided output stream
-   */
-  public abstract void writeExternal(ObjectOutput objectOutput) throws IOException;
-
-  /**
-   * @return  the number of entries contained in the phone prefix map
-   */
-  public int getNumOfEntries() {
-    return numOfEntries;
-  }
-
-  /**
-   * @return  the set containing the possible lengths of prefixes
-   */
-  public TreeSet<Integer> getPossibleLengths() {
-    return possibleLengths;
-  }
-
-  @Override
-  public String toString() {
-    StringBuilder output = new StringBuilder();
-    int numOfEntries = getNumOfEntries();
-
-    for (int i = 0; i < numOfEntries; i++) {
-      output.append(getPrefix(i))
-          .append("|")
-          .append(getDescription(i))
-          .append("\n");
-    }
-    return output.toString();
-  }
-}

data/data/libphonenumber/java/internal/prefixmapper/src/com/google/i18n/phonenumbers/prefixmapper/PrefixFileReader.java

@@ -1,143 +0,0 @@
-/*
- * Copyright (C) 2011 The Libphonenumber Authors
- *
- * Licensed 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.
- */
-
-package com.google.i18n.phonenumbers.prefixmapper;
-
-import com.google.i18n.phonenumbers.Phonenumber.PhoneNumber;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.ObjectInputStream;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-/**
- * A helper class doing file handling and lookup of phone number prefix mappings.
- *
- * @author Shaopeng Jia
- */
-public class PrefixFileReader {
-  private static final Logger LOGGER = Logger.getLogger(PrefixFileReader.class.getName());
-
-  private final String phonePrefixDataDirectory;
-  // The mappingFileProvider knows for which combination of countryCallingCode and language a phone
-  // prefix mapping file is available in the file system, so that a file can be loaded when needed.
-  private MappingFileProvider mappingFileProvider = new MappingFileProvider();
-  // A mapping from countryCallingCode_lang to the corresponding phone prefix map that has been
-  // loaded.
-  private Map<String, PhonePrefixMap> availablePhonePrefixMaps =
-      new HashMap<String, PhonePrefixMap>();
-
-  public PrefixFileReader(String phonePrefixDataDirectory) {
-    this.phonePrefixDataDirectory = phonePrefixDataDirectory;
-    loadMappingFileProvider();
-  }
-
-  private void loadMappingFileProvider() {
-    InputStream source =
-        PrefixFileReader.class.getResourceAsStream(phonePrefixDataDirectory + "config");
-    ObjectInputStream in = null;
-    try {
-      in = new ObjectInputStream(source);
-      mappingFileProvider.readExternal(in);
-    } catch (IOException e) {
-      LOGGER.log(Level.WARNING, e.toString());
-    } finally {
-      close(in);
-    }
-  }
-
-  private PhonePrefixMap getPhonePrefixDescriptions(
-      int prefixMapKey, String language, String script, String region) {
-    String fileName = mappingFileProvider.getFileName(prefixMapKey, language, script, region);
-    if (fileName.length() == 0) {
-      return null;
-    }
-    if (!availablePhonePrefixMaps.containsKey(fileName)) {
-      loadPhonePrefixMapFromFile(fileName);
-    }
-    return availablePhonePrefixMaps.get(fileName);
-  }
-
-  private void loadPhonePrefixMapFromFile(String fileName) {
-    InputStream source =
-        PrefixFileReader.class.getResourceAsStream(phonePrefixDataDirectory + fileName);
-    ObjectInputStream in = null;
-    try {
-      in = new ObjectInputStream(source);
-      PhonePrefixMap map = new PhonePrefixMap();
-      map.readExternal(in);
-      availablePhonePrefixMaps.put(fileName, map);
-    } catch (IOException e) {
-      LOGGER.log(Level.WARNING, e.toString());
-    } finally {
-      close(in);
-    }
-  }
-
-  private static void close(InputStream in) {
-    if (in != null) {
-      try {
-        in.close();
-      } catch (IOException e) {
-        LOGGER.log(Level.WARNING, e.toString());
-      }
-    }
-  }
-
-  /**
-   * Returns a text description in the given language for the given phone number.
-   *
-   * @param number  the phone number for which we want to get a text description
-   * @param lang  two-letter lowercase ISO language codes as defined by ISO 639-1
-   * @param script  four-letter titlecase (the first letter is uppercase and the rest of the letters
-   *     are lowercase) ISO script codes as defined in ISO 15924
-   * @param region  two-letter uppercase ISO country codes as defined by ISO 3166-1
-   * @return  a text description in the given language for the given phone number, or an empty
-   *     string if a description is not available
-   */
-  public String getDescriptionForNumber(
-      PhoneNumber number, String lang, String script, String region) {
-    int countryCallingCode = number.getCountryCode();
-    // As the NANPA data is split into multiple files covering 3-digit areas, use a phone number
-    // prefix of 4 digits for NANPA instead, e.g. 1650.
-    int phonePrefix = (countryCallingCode != 1) ?
-        countryCallingCode : (1000 + (int) (number.getNationalNumber() / 10000000));
-    PhonePrefixMap phonePrefixDescriptions =
-        getPhonePrefixDescriptions(phonePrefix, lang, script, region);
-    String description = (phonePrefixDescriptions != null) ?
-        phonePrefixDescriptions.lookup(number) : null;
-    // When a location is not available in the requested language, fall back to English.
-    if ((description == null || description.length() == 0) && mayFallBackToEnglish(lang)) {
-      PhonePrefixMap defaultMap = getPhonePrefixDescriptions(phonePrefix, "en", "", "");
-      if (defaultMap == null) {
-        return "";
-      }
-      description = defaultMap.lookup(number);
-    }
-    return description != null ? description : "";
-  }
-
-  private boolean mayFallBackToEnglish(String lang) {
-    // Don't fall back to English if the requested language is among the following:
-    // - Chinese
-    // - Japanese
-    // - Korean
-    return !lang.equals("zh") && !lang.equals("ja") && !lang.equals("ko");
-  }
-}