Merge pull request #94 from yumaoka/cust-filter-example

Custom filter example with GP maven

Author: yumaoka

examples/custom-res-filter/README.md

@@ -0,0 +1,25 @@
+<!--
+/*  
+ * Copyright IBM Corp. 2018
+ *
+ * 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.
+ */
+-->
+# Globalization Pipeline Custom Resource Filter Example
+
+This folder contains an example custom resource filter implementation code
+and the usage example with Globalization Pipeline Maven Plugin.
+
+- csv-filter : A custom resource filter processing resource strings stored in CSV
+(comma separated version) files.
+- maven : An example Maven project using the CSV filter.

examples/custom-res-filter/.classpath …/custom-res-filter/csv-filter/.classpathexamples/custom-res-filter/.classpath renamed to examples/custom-res-filter/csv-filter/.classpath examples/custom-res-filter/.classpath renamed to examples/custom-res-filter/csv-filter/.classpath

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
-	<name>custom-res-filter</name>
+	<name>csv-filter</name>
 	<comment></comment>
 	<projects>
 	</projects>

examples/custom-res-filter/.gitignore …/custom-res-filter/csv-filter/.gitignoreexamples/custom-res-filter/.gitignore renamed to examples/custom-res-filter/csv-filter/.gitignore examples/custom-res-filter/.gitignore renamed to examples/custom-res-filter/csv-filter/.gitignore

@@ -0,0 +1,52 @@
+<!--
+/*  
+ * Copyright IBM Corp. 2018
+ *
+ * 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.
+ */
+-->
+# Custom Resource Filter Example - CSV Filter
+
+[Globalization Pipeline Resource Filter](https://github.com/IBM-Cloud/gp-java-tools/tree/master/gp-res-filter) provides
+a mechanism to implement your own custom filter, that can be used through
+Globalization Pipeline Maven Plugin/Ant Task and other tools.
+
+This example filter implementation read and write resource strings in CSV (Comman Separated Version) format.
+
+There are two types of resource filters.
+
+- [ResourceFilter](https://github.com/IBM-Cloud/gp-java-tools/blob/master/gp-res-filter/src/main/java/com/ibm/g11n/pipeline/resfilter/ResourceFilter.java) :
+This filter type parses a single resource data and produce a single Globalization
+Pipeline bundle. It also writes out a single Globalization Pipeline bundle into a
+single resource data.
+- [MultiBundleResourceFilter](https://github.com/IBM-Cloud/gp-java-tools/blob/master/gp-res-filter/src/main/java/com/ibm/g11n/pipeline/resfilter/MultiBundleResourceFilter.java) :
+This filter type parses a single resource data and produces one ore more Globalization
+Pipeline bundles. It also writes out one or more Globalization Pipeline bundles
+into a single resource data.
+
+A custom resource filter must extends one of above abstract class. Once you have
+one or more filter implementations ready, you need to impelment a concrete subclass
+of [ResourceFilterProvider](https://github.com/IBM-Cloud/gp-java-tools/blob/master/gp-res-filter/src/main/java/com/ibm/g11n/pipeline/resfilter/ResourceFilterProvider.java).
+
+In this example, [CSVFilter](https://github.com/IBM-Cloud/gp-java-tools/blob/master/examples/custom-res-filter/csv-filter/src/main/java/com/ibm/g11n/pipeline/example/CSVFilter.java)
+extends `ResourceFilter` and [MultiBundleCSVFilter](https://github.com/IBM-Cloud/gp-java-tools/blob/master/examples/custom-res-filter/csv-filter/src/main/java/com/ibm/g11n/pipeline/example/MultiBundleCSVFilter.java) extends `MultiBundleResourceFilter`.
+
+To integrate your custom filter implementation, you must create a text file
+`com.ibm.g11n.pipeline.resfilter.ResourceFilterProvider` specifying your
+`ResourceFilterProvider` implementation class, then place the file under
+`META-INF/services` in a jar file. In this CSV filter example, the service
+description file is found [here](https://github.com/IBM-Cloud/gp-java-tools/blob/master/examples/custom-res-filter/csv-filter/src/main/resources/META-INF/services/com.ibm.g11n.pipeline.resfilter.ResourceFilterProvider).
+
+Once your custom filter jar file is ready, you just need to put the file in
+your runtime class path of Globalization Pipeline tools integrated with
+`gp-res-filter`.

examples/custom-res-filter/.project …es/custom-res-filter/csv-filter/.projectexamples/custom-res-filter/.project renamed to examples/custom-res-filter/csv-filter/.project examples/custom-res-filter/.project renamed to examples/custom-res-filter/csv-filter/.project

@@ -2,9 +2,9 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.ibm.g11n.pipeline</groupId>
-	<artifactId>custom-res-filter</artifactId>
-	<version>1.2.0-SNAPSHOT</version>
-	<name>Custom resource filter example</name>
+	<artifactId>csv-filter</artifactId>
+	<version>1.0.0</version>
+	<name>Custom resource filter example - CSV filter</name>
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -21,7 +21,7 @@
 		<dependency>
 			<groupId>com.ibm.g11n.pipeline</groupId>
 			<artifactId>gp-res-filter</artifactId>
-			<version>1.2.0-SNAPSHOT</version>
+			<version>1.2.0</version>
 		</dependency>
 		<!-- JUnit -->
 		<dependency>