Merge pull request #307 from aerfus/feat/304-regular-expression-support

Regular expressions support documentation

README.adoc

@@ -271,24 +271,31 @@ public class Person {
     @ExcelCellName("Email")
     protected String email;
 
+    @ExcelCellName(value = "", expression = "Surname|Second name")  <2>
+    private String surname;
+
 }
 ----
 1. We need to specify the `name` of the column for which the corresponding value is looked. By default, `@ExcelCellName` is case-sensitive and the excel file should't contain duplicated column names. However, you can manipulate this feature using `PoijiOptionsBuilder#caseInsensitive(boolean)` and you can ignore white spaces using `PoijiOptionsBuilder#ignoreWhitespaces(boolean)`.
+2. In rare situations a column can have synonyms, especially when the column was renamed and backward compatibility is needed.
+Here we specify the `expression` leaving the column `name` empty.
 
 For example, here is the excel (`person.xls`) file we want to use:
 
 |===
-| Name |Address |Age |Email
+| Name |Address |Age |Email |Surname
 
 |Joe
 |San Francisco, CA
 |30
 |[email protected]
+|Doe
 
 |Sophie
 |Costa Mesa, CA
 |20
 |[email protected]
+|Doe
 
 |===
 
@@ -302,6 +309,7 @@ Person person = people.get(0);
 // San Francisco, CA
 // 30
 // [email protected]
+// Doe
 ----
 
 Given that the first column always stands for the names of people, you're able to combine the `ExcelCell` annotation with `ExcelCellName` in your object model:
@@ -374,6 +382,82 @@ Car car = cars.get(0);
 // 4
 ----
 
+=== Annotation ExcelCellsJoinedByName
+
+Using `ExcelCellsJoinedByName` we can read columns which name meets same regular expression. Values will be combined as a multi valued map.
+
+Please pay attention the variable must be initialized explicitly.
+
+[source,java]
+----
+public class Album {
+
+    @ExcelCellsJoinedByName(expression = "Artist")  <1>
+    private MultiValuedMap<String, String> artists = new ArrayListValuedHashMap<>();
+
+    @ExcelCellsJoinedByName(expression = "Track[0-9]+")  <2>
+    private MultiValuedMap<String, String> tracks = new ArrayListValuedHashMap<>();
+
+}
+----
+1. Here we map multiple columns with `name` _Artist_.
+2. Here we map multiple columns with `name` _Track1_, _Track2_, _Track3_, etc.
+
+For example, here is the excel (`album.xls`) file we want to use:
+
+|===
+| Artist |Artist |Artist |Track1 |Track2
+
+|Michael Jackson
+|Lionel Richie
+|Stevie Wonder
+|We are the World
+|We are the World (instrumental)
+
+|artist 1
+|artist 1
+|artist 1
+|track 1
+|track 1
+
+|===
+
+[source,java]
+----
+List<Album> albums = Poiji.fromExcel(new File("album.xls"), Album.class);
+albums.size();
+// 2
+Album album1 = albums.get(0);
+// artists = { Artist = [Michael Jackson, Lionel Richie, Stevie Wonder] }
+// tracks = { Track1 = [We are the World], Track2 = [We are the World (instrumental)] }
+Album album2 = albums.get(1);
+// artists = {Artist = [artist 1, artist 1, artist 1] }
+// tracks = {Track2 = [track 1], Track1=[track 1] }
+----
+
+Json presentation for `album1` will be as follows
+
+[source,json]
+----
+{
+  "artists": {
+    "Artist": [
+      "Michael Jackson",
+      "Lionel Richie",
+      "Stevie Wonder"
+    ]
+  },
+  "tracks": {
+    "Track1": [
+      "We are the World"
+    ],
+    "Track2": [
+      "We are the World (instrumental)"
+    ]
+  }
+}
+----
+
 === ExcelCellRange Annotation
 
 Consider you have a table like below: