updating documentation

Author: dcendents

README.md

@@ -9,39 +9,20 @@ MyBatis Generator Plugins
 Set of plugins for the mybatis-generator to further tweak the generated code.
 
 
-## AddClassAnnotationsPlugin
-
-Plugin that will add the specified annotation to every generated class. There are 2 mandatory parameters to set:
-  - **annotationClass**: The class of the annotation, this will be added as an import statement.
-  - **annotationString**: The literal string that will be added, complete will all values
-
-If you need to add multiple annotations, configure this plugin many times, one per annotation to add.
-
-e.g.:
-```xml
-<plugin type="com.github.dcendents.mybatis.generator.plugin.annotation.AddClassAnnotationsPlugin">
-	<property name="annotationClass" value="lombok.ToString" />
-	<property name="annotationString" value="@ToString(callSuper = true)" />
-</plugin>
-<plugin type="com.github.dcendents.mybatis.generator.plugin.annotation.AddClassAnnotationsPlugin">
-	<property name="annotationClass" value="lombok.EqualsAndHashCode" />
-	<property name="annotationString" value="@EqualsAndHashCode(callSuper = true)" />
-</plugin>
-```
-
 ## CreateSubPackagePlugin
 
 Powerful plugin that will rename the generated model, mappers and examples by moving them in a sub-package and/or append a suffix. This is intended to keep generated code apart from the final classes to allow the geneator plugin to overwrite them every time.
 
 e.g.: some.package.Actor will now be generated as some.package.sub.ActorSuffix and will be abstract.
 some.package.ActorMapper will now be generated as some.package.sub.ActorMapperSuffix but methods will still expect and object of type some.package.Actor (to be created manually).
 
-  - **modelSubPackage**: The sub package to create for model classes.
-  - **modelClassSuffix**: The suffix to add to model classes.
-  - **mapperSubPackage**: The sub package to create for mapper interfaces.
-  - **mapperClassSuffix**: The suffix to add to mapper interfaces.
-  - **exampleSubPackage**: The sub package to create for example classes.
-  - **exampleClassSuffix**: The suffix to add to example classes.
+There are 6 optional parameters to set:
+  - *modelSubPackage*: The sub package to create for model classes.
+  - *modelClassSuffix*: The suffix to add to model classes.
+  - *mapperSubPackage*: The sub package to create for mapper interfaces.
+  - *mapperClassSuffix*: The suffix to add to mapper interfaces.
+  - *exampleSubPackage*: The sub package to create for example classes.
+  - *exampleClassSuffix*: The suffix to add to example classes.
 
 e.g.:
 ```xml
@@ -56,8 +37,7 @@ e.g.:
 
 ## RenameExampleClassAndMethodsPlugin
 
-Plugin that will rename the example classes and parameters to give them a more suitable name for a production environment. Also this plugin will fix the update statements and remove the id column(s).
-
+Plugin that will rename the example classes and parameters to give them a more suitable name for a production environment. Also this plugin will fix the update statements and remove the id column(s). There are 4 mandatory parameters to set:
   - **classMethodSearchString**: The string to search in class names.
   - **classMethodReplaceString**: The replace value.
   - **parameterSearchString**: The string to search for parameter names.
@@ -73,6 +53,55 @@ e.g.:
 </plugin>
 ```
 
+## AddClassAnnotationsPlugin
+
+Plugin that will add the specified annotation to every generated class. There are 2 mandatory parameters to set:
+  - **annotationClass**: The class of the annotation, this will be added as an import statement.
+  - **annotationString**: The literal string that will be added, complete will all values
+
+If you need to add multiple annotations, configure this plugin many times, one per annotation to add.
+
+e.g.:
+```xml
+<plugin type="com.github.dcendents.mybatis.generator.plugin.annotation.AddClassAnnotationsPlugin">
+	<property name="annotationClass" value="lombok.ToString" />
+	<property name="annotationString" value="@ToString(callSuper = true)" />
+</plugin>
+<plugin type="com.github.dcendents.mybatis.generator.plugin.annotation.AddClassAnnotationsPlugin">
+	<property name="annotationClass" value="lombok.EqualsAndHashCode" />
+	<property name="annotationString" value="@EqualsAndHashCode(callSuper = true)" />
+</plugin>
+```
+
+## WrapObjectPlugin
+
+Plugin that can be used to make a generated class wrap another java bean. For each property to wrap, the field will not be generated and the getter/setter will simply redirect to the wrapped java bean methods instead. This strategy can be used when you need to persist some third party objects but still want the flexibility to add new properties (like a database id). This pattern is more flexible than trying to extend the class. There are 2 mandatory and 3 optional parameters to set:
+  - **fullyQualifiedTableName**: The name of the database table including the schema.
+  - **objectClass**: The class of the object to be wrapped.
+  - *objectFieldName*: The name of the field to add, will default to the class name starting with a lower case.
+  - *includes*: A coma separated list of fields to delegate to the wrapped object, everything else will be excluded. If left blank all fields are included.
+  - *excludes*: A coma separated list of fields to exclude.
+
+The plugin need to be added for each table as needed.
+
+e.g.:
+```xml
+<plugin type="com.github.dcendents.mybatis.generator.plugin.wrap.WrapObjectPlugin">
+	<property name="fullyQualifiedTableName" value="public.film" />
+	<property name="objectClass" value="com.github.dcendents.mybatis.jaxws.api.Film" />
+	<property name="excludes" value="language" />
+</plugin>
+<plugin type="com.github.dcendents.mybatis.generator.plugin.wrap.WrapObjectPlugin">
+	<property name="fullyQualifiedTableName" value="public.actor" />
+	<property name="objectClass" value="com.github.dcendents.mybatis.jaxws.api.Actor" />
+</plugin>
+```
+
+Demo
+====================
+
+See the following project for a demo of all these plugins: https://github.com/dcendents/mybatis-jaxws
+
 Build Metrics
 ====================