Port of FormatInterpreter with tests
diff --git a/src/com/android/i18n/addressinput/FormatInterpreter.java b/src/com/android/i18n/addressinput/FormatInterpreter.java
new file mode 100644
index 0000000..5ce665b
--- /dev/null
+++ b/src/com/android/i18n/addressinput/FormatInterpreter.java
@@ -0,0 +1,282 @@
+/*
+ * Copyright (C) 2010 Google Inc.
+ *
+ * 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.android.i18n.addressinput;
+
+import com.android.i18n.addressinput.LookupKey.ScriptType;
+
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.HashMap;
+import java.util.Map;
+import org.json.JSONException;
+import org.json.JSONObject;
+import org.json.JSONTokener;
+
+/**
+ * Address format interpreter. A utility to find address format related info.
+ */
+public class FormatInterpreter {
+ private static final String NEW_LINE = "%n";
+ private final String DEFAULT_FORMAT;
+ private final FormOptions FORM_OPTIONS;
+
+ /**
+ * Creates a new instance of {@link FormatInterpreter}.
+ */
+ public FormatInterpreter(FormOptions options) {
+ Util.checkNotNull(RegionDataConstants.getCountryFormatMap(),
+ "null country name map not allowed");
+ Util.checkNotNull(options);
+ this.FORM_OPTIONS = options;
+ DEFAULT_FORMAT = getJsonValue("ZZ", AddressDataKey.FMT);
+ Util.checkNotNull(DEFAULT_FORMAT, "null default format not allowed");
+ }
+
+ /**
+ * Returns a list of address fields based on the format of {@code regionCode}.
+ * Script type is needed because some countries uses different address
+ * formats for local/Latin scripts.
+ *
+ * @param scriptType if {@link ScriptType#LOCAL}, use local format; else use
+ * Latin format.
+ */
+ public List<AddressField> getAddressFieldOrder(ScriptType scriptType, String regionCode) {
+ Util.checkNotNull(scriptType);
+ Util.checkNotNull(regionCode);
+ List<AddressField> fieldOrder = new ArrayList<AddressField>();
+ for (String substring : getFormatSubStrings(scriptType, regionCode)) {
+ // Skips un-escaped characters and new lines.
+ if (!substring.matches("%.") || substring.equals(NEW_LINE)) {
+ continue;
+ }
+
+ AddressField field = AddressField.of(substring.charAt(1));
+ fieldOrder.add(field);
+ }
+
+ overrideFieldOrder(regionCode, fieldOrder);
+
+ // Uses two address lines instead of street address.
+ List<AddressField> finalFieldOrder = new ArrayList<AddressField>();
+ for (AddressField field : fieldOrder) {
+ if (field == AddressField.STREET_ADDRESS) {
+ finalFieldOrder.add(AddressField.ADDRESS_LINE_1);
+ finalFieldOrder.add(AddressField.ADDRESS_LINE_2);
+ } else {
+ finalFieldOrder.add(field);
+ }
+ }
+ return finalFieldOrder;
+ }
+
+ /**
+ * Returns a list of address fields based on the format of {@code regionCode}
+ * -- assuming script type is {@link ScriptType#LOCAL}.
+ */
+ public List<AddressField> getAddressFieldOrder(String regionCode) {
+ Util.checkNotNull(regionCode);
+ return getAddressFieldOrder(ScriptType.LOCAL, regionCode);
+ }
+
+ private void overrideFieldOrder(String regionCode, List<AddressField> fieldOrder) {
+ if (FORM_OPTIONS.getCustomFieldOrder(regionCode) == null) {
+ return;
+ }
+
+ // Constructs a hash for overridden field order.
+ final Map<AddressField, Integer> fieldPriority = new HashMap<AddressField, Integer>();
+ int i = 0;
+ for (AddressField field : FORM_OPTIONS.getCustomFieldOrder(regionCode)) {
+ fieldPriority.put(field, i);
+ i++;
+ }
+
+ // Finds union of input fields and priority list.
+ List<AddressField> union = new ArrayList<AddressField>();
+ List<Integer> slots = new ArrayList<Integer>();
+ i = 0;
+ for (AddressField field : fieldOrder) {
+ if (fieldPriority.containsKey(field)) {
+ union.add(field);
+ slots.add(i);
+ }
+ i++;
+ }
+
+ // Overrides field order with priority list.
+ Collections.sort(union, new Comparator<AddressField>() {
+ public int compare(AddressField o1, AddressField o2) {
+ return fieldPriority.get(o1) - fieldPriority.get(o2);
+ }
+ });
+
+ // Puts reordered fields in slots.
+ for (int j = 0; j < union.size(); ++j) {
+ fieldOrder.set(slots.get(j), union.get(j));
+ }
+ }
+
+ /**
+ * Gets formatted address. For example,
+ *
+ * <p>
+ * John Doe<br>
+ * Dnar Corp<br>
+ * 5th St<br>
+ * Santa Monica CA 90123
+ * </p>
+ *
+ * This method does not validate addresses. Also, it will "normalize" the result
+ * strings by removing redundant spaces and empty lines.
+ */
+ public List<String> getEnvelopeAddress(AddressData address) {
+ Util.checkNotNull(address, "null input address not allowed");
+ String regionCode = address.getPostalCountry();
+
+ String lc = address.getLanguageCode();
+ ScriptType scriptType = ScriptType.LOCAL;
+ if (lc != null) {
+ scriptType = Util.isExplicitLatinScript(lc) ? ScriptType.LATIN : ScriptType.LOCAL;
+ }
+
+ List<String> lines = new ArrayList<String>();
+ StringBuilder currentLine = new StringBuilder();
+ for (String substr : getFormatSubStrings(scriptType, regionCode)) {
+ if (substr.equals(NEW_LINE)) {
+ String normalizedStr = removeAllRedundantSpaces(currentLine.toString());
+ if (normalizedStr.length() > 0) {
+ lines.add(normalizedStr);
+ currentLine.setLength(0);
+ }
+ } else if (substr.startsWith("%")) {
+ char c = substr.charAt(1);
+ AddressField field = AddressField.of(c);
+ Util.checkNotNull(field, "null address field for character " + c);
+
+ String value = null;
+ switch (field) {
+ case STREET_ADDRESS:
+ value = Util.joinAndSkipNulls("\n",
+ address.getAddressLine1(),
+ address.getAddressLine2());
+ break;
+ case COUNTRY:
+ // Country name is treated separately.
+ break;
+ case ADMIN_AREA:
+ value = address.getAdministrativeArea();
+ break;
+ case LOCALITY:
+ value = address.getLocality();
+ break;
+ case DEPENDENT_LOCALITY:
+ value = address.getDependentLocality();
+ break;
+ case RECIPIENT:
+ value = address.getRecipient();
+ break;
+ case ORGANIZATION:
+ value = address.getOrganization();
+ break;
+ case POSTAL_CODE:
+ value = address.getPostalCode();
+ break;
+ default:
+ break;
+ }
+
+ if (value != null) {
+ currentLine.append(value);
+ }
+ } else {
+ currentLine.append(substr);
+ }
+ }
+ String normalizedStr = removeAllRedundantSpaces(currentLine.toString());
+ if (normalizedStr.length() > 0) {
+ lines.add(normalizedStr);
+ }
+ return lines;
+ }
+
+ /**
+ * Tokenizes the format string and returns the token string list. "%" is
+ * treated as an escape character. So for example "%n%a%nxyz" will be
+ * split into "%n", "%a", "%n", "x", "y", and "z". Escaped tokens correspond
+ * to either new line or address fields.
+ */
+ private List<String> getFormatSubStrings(ScriptType scriptType, String regionCode) {
+ String formatString = getFormatString(scriptType, regionCode);
+ List<String> parts = new ArrayList<String>();
+
+ boolean escaped = false;
+ for (char c : formatString.toCharArray()) {
+ if (escaped) {
+ escaped = false;
+ if (NEW_LINE.equals("%" + c)) {
+ parts.add(NEW_LINE);
+ } else {
+ Util.checkNotNull(AddressField.of(c), "Unrecognized character '" + c
+ + "' in format pattern: " + formatString);
+ parts.add("%" + c);
+ }
+ } else if (c == '%') {
+ escaped = true;
+ } else {
+ parts.add(c + "");
+ }
+ }
+ return parts;
+ }
+
+ private String removeAllRedundantSpaces(String str) {
+ str = str.trim();
+ str = str.replaceAll(" +", " ");
+ return str;
+ }
+
+ private String getFormatString(ScriptType scriptType, String regionCode) {
+ String format = (scriptType == ScriptType.LOCAL)
+ ? getJsonValue(regionCode, AddressDataKey.FMT)
+ : getJsonValue(regionCode, AddressDataKey.LFMT);
+ if (format == null) {
+ format = getJsonValue("ZZ", AddressDataKey.FMT);
+ }
+ return format;
+ }
+
+ private String getJsonValue(String regionCode, AddressDataKey key) {
+ Util.checkNotNull(regionCode);
+ String jsonString = RegionDataConstants.getCountryFormatMap().get(regionCode);
+ Util.checkNotNull(jsonString, "no json data for region code " + regionCode);
+
+ try {
+ JSONObject jsonObj = new JSONObject(new JSONTokener(jsonString));
+ if (jsonObj == null) {
+ return null;
+ }
+ // Gets the string for this key.
+ String parsedJsonString = jsonObj.getString(key.name().toLowerCase());
+ return parsedJsonString;
+ } catch (JSONException e) {
+ throw new RuntimeException("Invalid json for region code " + regionCode
+ + ": " + jsonString);
+ }
+ }
+}
diff --git a/test/com/android/i18n/addressinput/FormatInterpreterTest.java b/test/com/android/i18n/addressinput/FormatInterpreterTest.java
new file mode 100644
index 0000000..a7ade4c
--- /dev/null
+++ b/test/com/android/i18n/addressinput/FormatInterpreterTest.java
@@ -0,0 +1,169 @@
+/*
+ * Copyright (C) 2010 Google Inc.
+ *
+ * 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.android.i18n.addressinput;
+
+import com.android.i18n.addressinput.LookupKey.ScriptType;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+/**
+ * Tests for the FormatInterpreter class.
+ */
+public class FormatInterpreterTest extends TestCase {
+ private static final AddressData US_CA_ADDRESS;
+ private static final AddressData TW_ADDRESS;
+
+ private FormatInterpreter formatInterpreter;
+
+ static {
+ US_CA_ADDRESS = new AddressData.Builder().setCountry("US")
+ .setAdminArea("CA")
+ .setLocality("Mt View")
+ .setAddressLine1("1098 Alta Ave")
+ .setPostalCode("94043")
+ .build();
+
+ TW_ADDRESS = new AddressData.Builder().setCountry("TW")
+ .setAdminArea("\u53F0\u5317\u5E02") // Taipei city
+ .setLocality("\u5927\u5B89\u5340") // Da-an district
+ .setAddressLine1("Sec. 3 Hsin-yi Rd.")
+ .setPostalCode("106")
+ .setOrganization("Giant Bike Store")
+ .setRecipient("Mr. Liu")
+ .build();
+ }
+
+ public void setUp() {
+ formatInterpreter = new FormatInterpreter(new FormOptions.Builder().build());
+ }
+
+ public void testIterateUsAddressFields() {
+ AddressField[] format = {
+ AddressField.RECIPIENT,
+ AddressField.ORGANIZATION,
+ AddressField.ADDRESS_LINE_1,
+ AddressField.ADDRESS_LINE_2,
+ AddressField.LOCALITY,
+ AddressField.ADMIN_AREA,
+ AddressField.POSTAL_CODE
+ };
+
+ int currIndex = 0;
+ for (AddressField field : formatInterpreter.getAddressFieldOrder(ScriptType.LOCAL, "US")) {
+ assertEquals("index " + currIndex + " should have matched",
+ format[currIndex].getChar(), field.getChar());
+ currIndex++;
+ }
+ }
+
+ public void testOverrideFieldOrder() {
+ AddressField[] expectedOrder = {
+ AddressField.ADMIN_AREA,
+ AddressField.ORGANIZATION,
+ AddressField.ADDRESS_LINE_1,
+ AddressField.ADDRESS_LINE_2,
+ AddressField.LOCALITY,
+ AddressField.RECIPIENT,
+ AddressField.POSTAL_CODE
+ };
+
+ FormatInterpreter myInterpreter = new FormatInterpreter(
+ new FormOptions.Builder().customizeFieldOrder("US",
+ AddressField.ADMIN_AREA, AddressField.RECIPIENT,
+ AddressField.SORTING_CODE, AddressField.POSTAL_CODE).build());
+
+ int currIndex = 0;
+ for (AddressField field : myInterpreter.getAddressFieldOrder(ScriptType.LOCAL, "US")) {
+ assertEquals("Wrong field order for US on index "
+ + currIndex + " of address fields.", expectedOrder[currIndex], field);
+
+ // Sorting code (CEDEX) is not in US address format and should be
+ // neglected even if it is specified in customizeFieldOrder().
+ assertNotSame(AddressField.SORTING_CODE, field);
+ currIndex++;
+ }
+ }
+
+ public void testIterateTwLatinAddressFields() {
+ AddressField[] format = {
+ AddressField.RECIPIENT,
+ AddressField.ORGANIZATION,
+ AddressField.ADDRESS_LINE_1,
+ AddressField.ADDRESS_LINE_2,
+ AddressField.LOCALITY,
+ AddressField.ADMIN_AREA,
+ AddressField.POSTAL_CODE
+ };
+
+ int currIndex = 0;
+ for (AddressField field : formatInterpreter.getAddressFieldOrder(ScriptType.LATIN, "TW")) {
+ assertEquals("Unexpected field order -- mismatched on index " + currIndex,
+ format[currIndex].getChar(), field.getChar());
+ currIndex++;
+ }
+ }
+
+ public void testUsEnvelopeAddress() {
+ List<String> expected = new ArrayList<String>();
+ expected.add("1098 Alta Ave");
+ expected.add("Mt View CA 94043");
+
+ List<String> real = formatInterpreter.getEnvelopeAddress(US_CA_ADDRESS);
+
+ assertEquals(expected, real);
+ }
+
+ public void testTwEnvelopeAddress() {
+ // To be in this order, the whole address should really be in Traditional Chinese - for
+ // readability, only the neighbourhood and city are.
+ List<String> expected = new ArrayList<String>();
+ expected.add("106");
+ expected.add("\u53F0\u5317\u5E02\u5927\u5B89\u5340"); // Taipei city, Da-ain district
+ expected.add("Sec. 3 Hsin-yi Rd.");
+ expected.add("Giant Bike Store");
+ expected.add("Mr. Liu");
+
+ List<String> real = formatInterpreter.getEnvelopeAddress(TW_ADDRESS);
+
+ assertEquals(expected, real);
+ }
+
+ public void testEnvelopeAddressIncompleteAddress() {
+ List<String> expected = new ArrayList<String>();
+ expected.add("1098 Alta Ave");
+ expected.add("CA 94043");
+
+ AddressData address = new AddressData.Builder().set(US_CA_ADDRESS)
+ .set(AddressField.LOCALITY, null)
+ .build();
+
+ List<String> real = formatInterpreter.getEnvelopeAddress(address);
+
+ assertEquals(expected, real);
+ }
+
+ public void testEnvelopeAddressEmptyAddress() {
+ List<String> expected = new ArrayList<String>();
+ AddressData address = new AddressData.Builder().setCountry("US").build();
+
+ List<String> real = formatInterpreter.getEnvelopeAddress(address);
+ assertEquals(expected, real);
+ }
+}
