aplaws-commit Mailing List for APLAWS (Page 17)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Author: apevec
Date: 2006-08-25 19:59:39 +0200 (Fri, 25 Aug 2006)
New Revision: 1292

Modified:
   trunk/ccm-core/src/com/arsdigita/categorization/Category.java
Log:
add getPreferredQualifiedName which resolves the synonym to their preferred category


Modified: trunk/ccm-core/src/com/arsdigita/categorization/Category.java
===================================================================

--- trunk/ccm-core/src/com/arsdigita/categorization/Category.java	2006-08-25 17:57:34 UTC (rev 1291)
+++ trunk/ccm-core/src/com/arsdigita/categorization/Category.java	2006-08-25 17:59:39 UTC (rev 1292)
@@ -332,8 +332,8 @@
             }
             setEnabled(true);
             setAbstract(false);
-	    //by default do not ignore the parent index item
-	    setIgnoreParentIndexItem(false);
+            //by default do not ignore the parent index item
+            setIgnoreParentIndexItem(false);
         }
 
         m_hierarchy = new HierarchyDenormalization
@@ -368,7 +368,7 @@
      * Events". </p>
      *
      * @see #getDefaultAscendants()
-     * @param delimeter The string to use to seperate the parents from the
+     * @param delimiter The string to use to seperate the parents from the
      * children.  For example, to obtain the above-mentioned result, you need to
      * pass in <code>" >> "</code> as the delimiter.
      *
@@ -379,7 +379,7 @@
      * <code>null</code> this is the root category, and <code>includeRoot</code>
      * is false.
      */
-    public String getQualifiedName(String delimeter, boolean includeRoot) {
+    public String getQualifiedName(String delimiter, boolean includeRoot) {
         // If the collection only contains the root and the root is not desired
         // then we return null
         if (!includeRoot && getDefaultAscendants().size() < 2) {
@@ -399,21 +399,43 @@
             names.add(ancestors.getCategory().getName());
         }
 
-        return StringUtils.join(names, delimeter);
+        return StringUtils.join(names, delimiter);
     }
 
     /**
-     *  Returns the url of the category along with its default ancestors
+     * Returns the name of the <b>preferred</b> category along with its default ancestors.
+     * Equivalent to #getQualifiedName(String,boolean) if this Category is not a synonym.
+     * Synonym name is appended in parentheses.
+     *    
+     * @param delimiter string to separate category names
+     * @param includeRoot should root category be shown
+     * @return category path
+     */
+    public String getPreferredQualifiedName(String delimiter, boolean includeRoot) {
+        // is this a synonym?
+        CategoryCollection cc = new CategoryCollection (getRelatedCategories(PREFERRED));
+        if (cc.next()) {
+            Category preferred = cc.getCategory();
+            cc.close();
+            String preferredPath = preferred.getQualifiedName(delimiter, includeRoot);
+            return preferredPath + " (" + getName() + ")";
+        } else {
+            return getQualifiedName(delimiter, includeRoot);
+        }
+    }
+    
+    /**
+     * Returns the url of the category along with its default ancestors
      *
      * @see #getDefaultAscendants()
      *
-     * @param delimeter The string to use to seperate the parents from
+     * @param delimiter The string to use to seperate the parents from
      * the children.
 
      * @param includeRoot This indicates whether or not the root category should
      * be included in the URL.
      */
-    public String getQualifiedURL(String delimeter, boolean includeRoot) {
+    public String getQualifiedURL(String delimiter, boolean includeRoot) {
         // If the collection only contains the root and the root is not desired
         // then we return null
         if (!includeRoot && getDefaultAscendants().size() < 2) {
@@ -432,7 +454,7 @@
             names.add(ancestors.getCategory().getURL());
         }
 
-        return StringUtils.join(names, delimeter);
+        return StringUtils.join(names, delimiter);
     }
 
     /**
@@ -535,7 +557,7 @@
      * <code>false</code> otherwise.
      */
     public boolean ignoreParentIndexItem(){
-	return ((Boolean) get(IGNORE_PARENT_INDEX_ITEM)).booleanValue();
+        return ((Boolean) get(IGNORE_PARENT_INDEX_ITEM)).booleanValue();
     }
 
     /**
@@ -546,7 +568,7 @@
      * <code>false</code> otherwise
      */
     public void setIgnoreParentIndexItem(boolean ignoreParentIndexItem){
-	set(IGNORE_PARENT_INDEX_ITEM, new Boolean(ignoreParentIndexItem));
+        set(IGNORE_PARENT_INDEX_ITEM, new Boolean(ignoreParentIndexItem));
     }
 
 
@@ -1005,17 +1027,17 @@
         ACSObject item = getDirectIndexObject();
 
         if (item == null) {
-	    if(!ignoreParentIndexItem()){
-		try {
-		    item = getDefaultParentCategory().getIndexObject();
-            } catch (CategoryNotFoundException ex) {
-                // this will rarely happen and when it does we just want to
-                // return null which is done below.  it would be much nicer if
-                // the Categorization API just returned null instead of throwing
-                // the exception
-                s_log.debug("not found", ex);
+            if (!ignoreParentIndexItem()) {
+                try {
+                    item = getDefaultParentCategory().getIndexObject();
+                } catch (CategoryNotFoundException ex) {
+                    // this will rarely happen and when it does we just want to
+                    // return null which is done below.  it would be much nicer if
+                    // the Categorization API just returned null instead of throwing
+                    // the exception
+                    s_log.debug("not found", ex);
+                }
             }
-	    }
         }
 
         return item;
@@ -1407,10 +1429,11 @@
      * filter, if desired.
      *
      * @param relation The type of relation to retrieve.
-     * @pre relation == Category.CHILD || relation == Category.RELATED
+     * @pre relation == Category.CHILD || relation == Category.RELATED || relation == Category.PREFERRED
      */
     public DataAssociationCursor getRelatedCategories(String relation) {
-        Assert.truth(relation.equals(CHILD) || relation.equals(RELATED),
+        Assert.truth(relation.equals(CHILD) || relation.equals(RELATED)
+                || relation.equals(PREFERRED),
                      " invalid relation {" + relation + "}");
         DataAssociationCursor cursor =
             ((DataAssociation) get(RELATED_CATEGORIES)).cursor();





2004	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov (48)	Dec (31)
2005	Jan (22)	Feb (68)	Mar (185)	Apr (11)	May (21)	Jun (23)	Jul (46)	Aug (69)	Sep (211)	Oct (26)	Nov (51)	Dec (52)
2006	Jan (13)	Feb (13)	Mar (8)	Apr (21)	May (17)	Jun (100)	Jul (34)	Aug (23)	Sep (26)	Oct (16)	Nov	Dec
2007	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep (66)	Oct (10)	Nov (1)	Dec
2008	Jan	Feb	Mar (1)	Apr (3)	May (8)	Jun (5)	Jul (31)	Aug (8)	Sep (11)	Oct (6)	Nov	Dec
2012	Jan (13)	Feb (2)	Mar (9)	Apr (6)	May (24)	Jun	Jul	Aug	Sep	Oct	Nov	Dec (120)
2013	Jan (6)	Feb (35)	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec

aplaws-commit Mailing List for APLAWS (Page 17)

aplaws-commit — Automatic mailing when changes are committed to CVS.