Update of
/var/cvs/contributions/CMSContainer_Portlets/portlets-newsletter/src/java/com/finalist/newsletter/util
In directory james.mmbase.org:/tmp/cvs-serv18364/util
Modified Files:
DateUtil.java NewsletterTermUtil.java
Log Message:
CMSC-899,Check and improve all lists according to guideline
See also:
http://cvs.mmbase.org/viewcvs/contributions/CMSContainer_Portlets/portlets-newsletter/src/java/com/finalist/newsletter/util
See also: http://www.mmbase.org/jira/browse/CMSC-899
Index: DateUtil.java
===================================================================
RCS file:
/var/cvs/contributions/CMSContainer_Portlets/portlets-newsletter/src/java/com/finalist/newsletter/util/DateUtil.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- DateUtil.java 21 Jul 2008 12:52:40 -0000 1.4
+++ DateUtil.java 22 Sep 2008 07:53:42 -0000 1.5
@@ -8,9 +8,20 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+/**
+ * date Util class
+ *
+ */
public class DateUtil {
private static Log log = LogFactory.getLog(DateUtil.class);
+ /**
+ * parser string("yyyy-MM-dd") to date object
+ *
+ * @param raw string object
+ * @return Date object
+ *
+ */
public static Date parser(String raw) {
Date date = null;
@@ -25,33 +36,52 @@
return date;
}
+ /**
+ * parser date object to string ojbect("yyyy-MM-dd"),
+ *
+ * @param date Date ojbect
+ * @return a String object
+ *
+ */
public static String parser(Date date) {
SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
return format.format(date);
}
-
- public static Date calculateDateByDuration(Date date,int value, String
mode) {
+ /**
+ * calculate date ,
+ *
+ * @param date Date ojbect
+ * @param value the value used to operate at
+ * @param mode m = month;w=week of year;d=date;
+ * @return a Date object
+ *
+ */
+ public static Date calculateDateByDuration(Date date, int value, String
mode) {
Calendar calender = new GregorianCalendar();
calender.setTime(date);
- if("m".equals(mode)){
- calender.add(Calendar.MONTH,value);
+ if ("m".equals(mode)) {
+ calender.add(Calendar.MONTH, value);
}
- if("w".equals(mode)){
- calender.add(Calendar.WEEK_OF_YEAR,value);
+ if ("w".equals(mode)) {
+ calender.add(Calendar.WEEK_OF_YEAR, value);
}
- if("d".equals(mode)){
- calender.add(Calendar.DATE,value);
+ if ("d".equals(mode)) {
+ calender.add(Calendar.DATE, value);
}
return calender.getTime();
}
-
- public static Date getCurrent(){
+ /**
+ *
+ * get current datetime by millins type
+ *
+ */
+ public static Date getCurrent() {
return new Date(System.currentTimeMillis());
}
}
Index: NewsletterTermUtil.java
===================================================================
RCS file:
/var/cvs/contributions/CMSContainer_Portlets/portlets-newsletter/src/java/com/finalist/newsletter/util/NewsletterTermUtil.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- NewsletterTermUtil.java 17 Jul 2008 03:39:01 -0000 1.2
+++ NewsletterTermUtil.java 22 Sep 2008 07:53:42 -0000 1.3
@@ -13,30 +13,54 @@
import org.mmbase.bridge.RelationList;
import org.mmbase.bridge.util.SearchUtil;
+/**
+ * term util class.
+ *
+ * @author kevin
+ */
public abstract class NewsletterTermUtil {
private static Log log = LogFactory.getLog(NewsletterTermUtil.class);
- public static void deleteTerm(int termNumber){
- if(!getCloud().hasNode(termNumber)) {
+ /**
+ * delete a term by it's number.
+ *
+ * @param termNumber term number
+ *
+ */
+ public static void deleteTerm(int termNumber) {
+ if (!getCloud().hasNode(termNumber)) {
return;
}
Node termNode = getCloud().getNode(termNumber);
RelationList relations = termNode.getRelations();
- if(relations != null){
+ if (relations != null) {
termNode.deleteRelations();
}
termNode.delete();
}
- public static void addTerm(String name){
+ /**
+ * add a new term
+ *
+ * @param name new term name
+ *
+ */
+ public static void addTerm(String name) {
NodeManager termNodeManager = getCloud().getNodeManager("term");
Node termNode = termNodeManager.createNode();
termNode.setStringValue("name", name);
termNode.commit();
}
+ /**
+ * be sure that the them has existed or not.
+ *
+ * @param name term name
+ * @return <code>true</code> if the term has been in the application
+ * <code>false</code> no term
+ */
public static boolean hasTerm(String name) {
NodeManager termNodeManager = getCloud().getNodeManager("term");
NodeQuery query = termNodeManager.createQuery();
@@ -45,24 +69,42 @@
return terms != null && terms.size() > 0;
}
- public static void updateTerm(int termNumber,String name){
+ /**
+ * update term name by it's number
+ *
+ * @param termNumber term number
+ * @param name the new name of the term
+ */
+ public static void updateTerm(int termNumber, String name) {
Node termNode = getTermNodeById(termNumber);
termNode.setStringValue("name", name);
termNode.commit();
}
-
+ /**
+ * get a term node by it's number.
+ *
+ * @param termNumber term number.
+ * @return term node ojbect
+ */
public static Node getTermNodeById(int termNumber) {
- if(!getCloud().hasNode(termNumber)) {
+ if (!getCloud().hasNode(termNumber)) {
return null;
}
return getCloud().getNode(termNumber);
}
-
- public static NodeList searchTerms(String name,int offset,int pageSize){
+ /**
+ * get results of term paging list
+ *
+ * @param name the name of a term
+ * @param offset the position where get results from.
+ * @param pageSize max size for per page.
+ * @return Nodelist object ,contains terms objects
+ */
+ public static NodeList searchTerms(String name, int offset, int pageSize) {
NodeManager termNodeManager = getCloud().getNodeManager("term");
NodeQuery query = termNodeManager.createQuery();
- if(StringUtils.isNotBlank(name)){
+ if (StringUtils.isNotBlank(name)) {
SearchUtil.addLikeConstraint(query, termNodeManager.getField("name"),
name);
}
SearchUtil.addSortOrder(query, termNodeManager, "number", "down");
@@ -70,21 +112,32 @@
query.setOffset(offset);
return query.getList();
}
-
+ /**
+ *
+ * calculate the count of terms by term's name.
+ * @param name term name
+ * @return the terms's count
+ *
+ */
public static int countTotalTerms(String name) {
int size = 0;
NodeManager termNodeManager = getCloud().getNodeManager("term");
NodeQuery query = termNodeManager.createQuery();
- if(StringUtils.isNotBlank(name)){
+ if (StringUtils.isNotBlank(name)) {
SearchUtil.addLikeConstraint(query, termNodeManager.getField("name"),
name);
}
int count = query.getMaxNumber();
- if(query.getList() != null) {
+ if (query.getList() != null) {
size = query.getList().size();
}
return size;
}
-
+ /**
+ * get cloud object
+ * @param no
+ * @return cloud object
+ *
+ */
public static Cloud getCloud() {
return CloudProviderFactory.getCloudProvider().getCloud();
}
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
