Index: lams_common/src/java/org/lamsfoundation/lams/learningdesign/service/ToolContentVersionFilter.java =================================================================== diff -u -r859ed64687ae5058206794c706bdc4daa0e9f721 -r571a3efcd7c9416c7d2486d1b43ba7eefac433ee --- lams_common/src/java/org/lamsfoundation/lams/learningdesign/service/ToolContentVersionFilter.java (.../ToolContentVersionFilter.java) (revision 859ed64687ae5058206794c706bdc4daa0e9f721) +++ lams_common/src/java/org/lamsfoundation/lams/learningdesign/service/ToolContentVersionFilter.java (.../ToolContentVersionFilter.java) (revision 571a3efcd7c9416c7d2486d1b43ba7eefac433ee) @@ -27,7 +27,8 @@ * * * The XXX must be integer format, which is Tool version number. - * + *
+ * For more detail, in wiki. * @author Dapeng.Ni * */ @@ -63,14 +64,34 @@ } } + /** + * When a field is removed to tool Hibernate POJO class, this method must be call in + * upXXXToYYY()/downXXXToYYY() methods. + * + * @param ownerClass + * @param fieldname + */ public void removeField(Class ownerClass, String fieldname){ removedFieldList.add(new RemovedField(ownerClass,fieldname)); } + /** + * When a field is added to tool Hibernate POJO class, this method is optional in + * upXXXToYYY()/downXXXToYYY() methods. It could set default value for this added fields. + * + * @param ownerClass + * @param fieldname + */ public void addField(Class ownerClass, String fieldname, Object defaultValue){ addedFieldList.add(new AddedField(ownerClass, fieldname, defaultValue)); } + /** + * Call by lams import tool service core. Do not use it in tool version filter class. + * @param toolFilePath + * @throws JDOMException + * @throws IOException + */ public void transformXML(String toolFilePath) throws JDOMException, IOException{ File toolFile = new File(toolFilePath);