Thread: [Openutils-svn] SF.net SVN: openutils:[3576] trunk/openutils-mgnlmedia/src/main (Page 4)

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

Revision: 3576
          http://openutils.svn.sourceforge.net/openutils/?rev=3576&view=rev
Author:   fgiust
Date:     2011-07-03 15:51:05 +0000 (Sun, 03 Jul 2011)

Log Message:
-----------
cleanup docs and deprecated functions

Modified Paths:
--------------
    trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/tags/el/MediaEl.java
    trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld

Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/tags/el/MediaEl.java
===================================================================

--- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/tags/el/MediaEl.java	2011-07-03 15:41:48 UTC (rev 3575)
+++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/tags/el/MediaEl.java	2011-07-03 15:51:05 UTC (rev 3576)
@@ -166,147 +166,6 @@
     }
 
     /**
-     * Get localized description for a media. If the locale is "it", it searches for a nodedata called description-it,
-     * or (if not found) description-en or (if not found) description.
-     * @param media media
-     * @param locale language
-     * @return description
-     * @deprecated use the standard Magnolia i18nContentSupport for this. Please note that versions < 4.2 of the media
-     * module used PROPERTY-language instead of PROPERTY_languaga which is now the magnolia standard so you may need to
-     * adapt existing repositories
-     */
-    @Deprecated
-    public static String descLoc(Content media, Locale locale)
-    {
-        log.warn("\"descLoc()\" has been deprecated, please check javadocs");
-
-        if (media == null)
-        {
-            return null;
-        }
-        if (locale != null)
-        {
-            MgnlContext.setLocale(locale);
-        }
-        MediaTypeConfiguration mtc = mcm.getMediaTypeConfigurationFromMedia(media);
-        if (mtc == null || mtc.getHandler() == null)
-        {
-            return null;
-        }
-        return mtc.getHandler().getDescription(media);
-    }
-
-    /**
-     * Get localized title for a media. If the locale is "it", it searches for a nodedata called title-it, or (if not
-     * found) title-en or (if not found) title.
-     * @param media media
-     * @param locale language
-     * @return title
-     * @deprecated use the standard Magnolia i18nContentSupport for this. Please note that versions < 4.2 of the media
-     * module used PROPERTY-language instead of PROPERTY_languaga which is now the magnolia standard so you may need to
-     * adapt existing repositories
-     */
-    @Deprecated
-    public static String titleLoc(Content media, Locale locale)
-    {
-        log.warn("\"titleLoc()\" has been deprecated, please check javadocs");
-
-        if (media == null)
-        {
-            return null;
-        }
-        if (locale != null)
-        {
-            MgnlContext.setLocale(locale);
-        }
-        MediaTypeConfiguration mtc = mcm.getMediaTypeConfigurationFromMedia(media);
-        if (mtc == null || mtc.getHandler() == null)
-        {
-            return null;
-        }
-        return mtc.getHandler().getTitle(media);
-    }
-
-    /**
-     * Get localized tags for a media. If the locale is "it", it searches for a nodedata called tags-it, or (if not
-     * found) tags-en or (if not found) tags.
-     * @param media media
-     * @param locale language
-     * @return tags
-     * @deprecated use the standard Magnolia i18nContentSupport for this. Please note that versions < 4.2 of the media
-     * module used PROPERTY-language instead of PROPERTY_languaga which is now the magnolia standard so you may need to
-     * adapt existing repositories
-     */
-    @Deprecated
-    public static String[] tagsLoc(Content media, Locale locale)
-    {
-        log.warn("\"tagsLoc()\" has been deprecated, please check javadocs");
-
-        if (media == null)
-        {
-            return null;
-        }
-        if (locale != null)
-        {
-            MgnlContext.setLocale(locale);
-        }
-        MediaTypeConfiguration mtc = mcm.getMediaTypeConfigurationFromMedia(media);
-        if (mtc == null || mtc.getHandler() == null)
-        {
-            return null;
-        }
-        String tags = mtc.getHandler().getTags(media);
-        if (tags == null)
-        {
-            return null;
-
-        }
-        return StringUtils.split(tags, ",");
-    }
-
-    /**
-     * Get description for a media for the current locale.
-     * @param media media
-     * @return description
-     * @deprecated use media.getNodeData("description") or ${media.description}
-     */
-    @Deprecated
-    public static String desc(Content media)
-    {
-        log.warn("\"desc()\" has been deprecated, please check javadocs");
-
-        return descLoc(media, null);
-    }
-
-    /**
-     * Get title for a media for the current locale.
-     * @param media media
-     * @return title
-     * @deprecated use media.getNodeData("title") or ${media.title}
-     */
-    @Deprecated
-    public static String title(Content media)
-    {
-        log.warn("\"title()\" has been deprecated, please check javadocs");
-
-        return titleLoc(media, null);
-    }
-
-    /**
-     * Get tags for a media
-     * @param media media
-     * @return tags
-     * @deprecated use media.getNodeData("tags") or ${media.tags}
-     */
-    @Deprecated
-    public static String[] tags(Content media)
-    {
-        log.warn("\"tags()\" has been deprecated, please check javadocs");
-
-        return tagsLoc(media, null);
-    }
-
-    /**
      * Get url for a media
      * @param media media
      * @return url
@@ -318,7 +177,7 @@
 
     /**
      * Get url for a media, passing some parameters
-     * @param media media
+     * @param mediaref media node or UUID
      * @param options optional parameters
      * @return url
      */
@@ -339,7 +198,7 @@
 
     /**
      * Get url to thumbnail
-     * @param media media to get the url for
+     * @param mediaref media node or UUID
      * @return the thumbnail url for this media, null otherwise
      */
     public static String thumbnail(Object mediaref)
@@ -375,7 +234,7 @@
 
     /**
      * Get all resolution strings (i.e. 'o200x350;background=45A97B') that generates cached resolutions
-     * @param media media to get the resolutions
+     * @param mediaref media node or UUID
      * @return all resolution strings
      */
     public static String[] resolutions(Object mediaref)
@@ -410,7 +269,7 @@
 
     /**
      * Get url for a resolution
-     * @param media media
+     * @param mediaref media node or UUID
      * @param resolution resolution
      * @return url
      */
@@ -464,7 +323,7 @@
 
     /**
      * Get size of an image
-     * @param media media
+     * @param mediaref media node or UUID
      * @param resolution resolution for witch calculate size
      * @return size of an image
      */
@@ -525,7 +384,7 @@
 
     /**
      * Get url to media preview
-     * @param media media
+     * @param mediaref media node or UUID
      * @return the preview url for this media if existing, null otherwise
      */
     public static String preview(Object mediaref)
@@ -547,7 +406,7 @@
 
     /**
      * Get an array of String(s) containing a list of web pages where this media is used, an empty array otherwise
-     * @param media media to search in web pages
+     * @param mediaref media node or UUID
      * @return an array of String(s) containing a list of web pages where this media is used, an empty array otherwise
      */
     public static String[] usedInWebPages(Object mediaref)
@@ -580,7 +439,7 @@
 
     /**
      * Returns a property (nodeData) of the media Content.
-     * @param media media Content
+     * @param mediaref media node or UUID
      * @param property property name
      * @return the value of the given nodedata or null if not found
      */
@@ -668,6 +527,135 @@
     }
 
     /**
+     * Returns the "resolutions" node, checking for existence
+     * @param media
+     * @return
+     */
+    protected static Content getResolutionsNode(final Content media)
+    {
+        Content resolutions = null;
+
+        try
+        {
+            if (media.hasContent("resolutions"))
+            {
+                resolutions = media.getContent("resolutions");
+            }
+        }
+        catch (RepositoryException e)
+        {
+            // ignore, try to create it
+        }
+        return resolutions;
+    }
+
+    /**
+     * Returns an interator on the playlist content, given the playlist node or UUID. Support both static and dynamic
+     * (search based) playlists
+     * @param obj playlist node or UUID
+     * @return Iterator of media nodes
+     */
+    public static Iterator<Content> mediaNodesInPlaylist(Object obj)
+    {
+        // TODO use openutils-mgnlutils 1.0.8:
+        // Content playlistNode = it.openutils.mgnlutils.el.MgnlUtilsElFunctions.node(obj, PlaylistConstants.REPO);
+        Content playlistNode = null;
+        if (obj == null)
+        {
+            return null;
+        }
+
+        if (obj instanceof String)
+        {
+            String identifier = (String) obj;
+
+            if (StringUtils.isBlank(identifier))
+            {
+                return null;
+            }
+
+            HierarchyManager hm = MgnlContext.getHierarchyManager(PlaylistConstants.REPO);
+            try
+            {
+                if (identifier.startsWith("/"))
+                {
+                    if (hm.isExist(identifier))
+                    {
+                        playlistNode = hm.getContent(identifier);
+                    }
+                }
+                else
+                {
+                    playlistNode = hm.getContentByUUID(StringUtils.trim(identifier));
+                }
+            }
+            catch (ItemNotFoundException e)
+            {
+                log.debug("Node \"" + identifier + "\" not found");
+            }
+            catch (RepositoryException e)
+            {
+                log.error(e.getClass().getName() + " getting node \"" + identifier + "\"", e);
+            }
+        }
+        else if (obj instanceof Content)
+        {
+            playlistNode = (Content) obj;
+        }
+
+        Iterator<Content> iter = Iterators.transform(
+            PlaylistIterateUtils.iterate(playlistNode),
+            new Function<MediaNodeAndEntryPath, Content>()
+            {
+
+                /**
+                 * {@inheritDoc}
+                 */
+                public Content apply(MediaNodeAndEntryPath from)
+                {
+                    return from.getMediaNode();
+                }
+            });
+        return Iterators.filter(iter, Predicates.notNull());
+    }
+
+    /**
+     * Utility functions used to replace a param in the current URL, Used internally by the crop tag.
+     * @param param parm key
+     * @param newValue new value
+     * @return new URL
+     */
+    public static String replaceParam(String param, String newValue)
+    {
+        HttpServletRequest req = MgnlContext.getWebContext().getRequest();
+        String url = "?"
+            + (StringUtils.isNotBlank(req.getQueryString())
+                ? MgnlContext.getWebContext().getRequest().getQueryString()
+                : StringUtils.EMPTY);
+        if (url.indexOf("?" + param + "=") >= 0 || url.indexOf("&" + param + "=") >= 0)
+        {
+            int index = 1;
+            if (url.indexOf("&" + param + "=") >= 0)
+            {
+                index = url.indexOf("&" + param + "=");
+            }
+            url = StringUtils.substring(url, 0, index)
+                + StringUtils.substringAfter(StringUtils.substring(url, index + 1), "&");
+        }
+        if (StringUtils.isNotBlank(newValue))
+        {
+            url += (url.endsWith("?") ? StringUtils.EMPTY : "&") + param + "=" + newValue;
+        }
+        return url;
+    }
+
+    //
+    //
+    // DEPRECATED FUNCTION
+    //
+    //
+
+    /**
      * @deprecated, use node(Object)
      */
     @Deprecated
@@ -808,117 +796,123 @@
     }
 
     /**
-     * Returns the "resolutions" node, checking for existence
-     * @param media
-     * @return
+     * @deprecated, use ${media.description} in templates
      */
-    protected static Content getResolutionsNode(final Content media)
+    @Deprecated
+    public static String descLoc(Content media, Locale locale)
     {
-        Content resolutions = null;
+        log.warn("\"descLoc()\" has been deprecated, please check javadocs");
 
-        try
+        if (media == null)
         {
-            if (media.hasContent("resolutions"))
-            {
-                resolutions = media.getContent("resolutions");
-            }
+            return null;
         }
-        catch (RepositoryException e)
+        if (locale != null)
         {
-            // ignore, try to create it
+            MgnlContext.setLocale(locale);
         }
-        return resolutions;
+        MediaTypeConfiguration mtc = mcm.getMediaTypeConfigurationFromMedia(media);
+        if (mtc == null || mtc.getHandler() == null)
+        {
+            return null;
+        }
+        return mtc.getHandler().getDescription(media);
     }
 
     /**
-     * @param obj
-     * @return
+     * @deprecated, use ${media.title} in templates
      */
-    public static Iterator<Content> mediaNodesInPlaylist(Object obj)
+    @Deprecated
+    public static String titleLoc(Content media, Locale locale)
     {
-        // TODO use openutils-mgnlutils 1.0.8:
-        // Content playlistNode = it.openutils.mgnlutils.el.MgnlUtilsElFunctions.node(obj, PlaylistConstants.REPO);
-        Content playlistNode = null;
-        if (obj == null)
+        log.warn("\"titleLoc()\" has been deprecated, please check javadocs");
+
+        if (media == null)
         {
             return null;
         }
-
-        if (obj instanceof String)
+        if (locale != null)
         {
-            String identifier = (String) obj;
-
-            if (StringUtils.isBlank(identifier))
-            {
-                return null;
-            }
-
-            HierarchyManager hm = MgnlContext.getHierarchyManager(PlaylistConstants.REPO);
-            try
-            {
-                if (identifier.startsWith("/"))
-                {
-                    if (hm.isExist(identifier))
-                    {
-                        playlistNode = hm.getContent(identifier);
-                    }
-                }
-                else
-                {
-                    playlistNode = hm.getContentByUUID(StringUtils.trim(identifier));
-                }
-            }
-            catch (ItemNotFoundException e)
-            {
-                log.debug("Node \"" + identifier + "\" not found");
-            }
-            catch (RepositoryException e)
-            {
-                log.error(e.getClass().getName() + " getting node \"" + identifier + "\"", e);
-            }
+            MgnlContext.setLocale(locale);
         }
-        else if (obj instanceof Content)
+        MediaTypeConfiguration mtc = mcm.getMediaTypeConfigurationFromMedia(media);
+        if (mtc == null || mtc.getHandler() == null)
         {
-            playlistNode = (Content) obj;
+            return null;
         }
-
-        Iterator<Content> iter = Iterators.transform(
-            PlaylistIterateUtils.iterate(playlistNode),
-            new Function<MediaNodeAndEntryPath, Content>()
-            {
-
-                /**
-                 * {@inheritDoc}
-                 */
-                public Content apply(MediaNodeAndEntryPath from)
-                {
-                    return from.getMediaNode();
-                }
-            });
-        return Iterators.filter(iter, Predicates.notNull());
+        return mtc.getHandler().getTitle(media);
     }
 
-    public static String replaceParam(String param, String newValue)
+    /**
+     * @deprecated, use ${media.tags} in templates
+     */
+    @Deprecated
+    public static String[] tagsLoc(Content media, Locale locale)
     {
-        HttpServletRequest req = MgnlContext.getWebContext().getRequest();
-        String url = "?"
-            + (StringUtils.isNotBlank(req.getQueryString())
-                ? MgnlContext.getWebContext().getRequest().getQueryString()
-                : StringUtils.EMPTY);
-        if (url.indexOf("?" + param + "=") >= 0 || url.indexOf("&" + param + "=") >= 0)
+        log.warn("\"tagsLoc()\" has been deprecated, please check javadocs");
+
+        if (media == null)
         {
-            int index = 1;
-            if (url.indexOf("&" + param + "=") >= 0)
-            {
-                index = url.indexOf("&" + param + "=");
-            }
-            url = StringUtils.substring(url, 0, index)
-                + StringUtils.substringAfter(StringUtils.substring(url, index + 1), "&");
+            return null;
         }
-        if (StringUtils.isNotBlank(newValue))
+        if (locale != null)
         {
-            url += (url.endsWith("?") ? StringUtils.EMPTY : "&") + param + "=" + newValue;
+            MgnlContext.setLocale(locale);
         }
-        return url;
+        MediaTypeConfiguration mtc = mcm.getMediaTypeConfigurationFromMedia(media);
+        if (mtc == null || mtc.getHandler() == null)
+        {
+            return null;
+        }
+        String tags = mtc.getHandler().getTags(media);
+        if (tags == null)
+        {
+            return null;
+
+        }
+        return StringUtils.split(tags, ",");
     }
+
+    /**
+     * Get description for a media for the current locale.
+     * @param media media
+     * @return description
+     * @deprecated use media.getNodeData("description") or ${media.description}
+     */
+    @Deprecated
+    public static String desc(Content media)
+    {
+        log.warn("\"desc()\" has been deprecated, please check javadocs");
+
+        return descLoc(media, null);
+    }
+
+    /**
+     * Get title for a media for the current locale.
+     * @param media media
+     * @return title
+     * @deprecated use media.getNodeData("title") or ${media.title}
+     */
+    @Deprecated
+    public static String title(Content media)
+    {
+        log.warn("\"title()\" has been deprecated, please check javadocs");
+
+        return titleLoc(media, null);
+    }
+
+    /**
+     * Get tags for a media
+     * @param media media
+     * @return tags
+     * @deprecated use media.getNodeData("tags") or ${media.tags}
+     */
+    @Deprecated
+    public static String[] tags(Content media)
+    {
+        log.warn("\"tags()\" has been deprecated, please check javadocs");
+
+        return tagsLoc(media, null);
+    }
+
 }

Modified: trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld
===================================================================
--- trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld	2011-07-03 15:41:48 UTC (rev 3575)
+++ trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld	2011-07-03 15:51:05 UTC (rev 3576)
@@ -339,14 +339,14 @@
     <function-signature>java.lang.Object property(java.lang.Object, java.lang.String)</function-signature>
   </function>
   <function>
-    <description></description>
+    <description>Returns an interator on the playlist content, given the playlist node or UUID. Support both static and dynamic (search based) playlists</description>
     <display-name>mediaNodesInPlaylist</display-name>
     <name>mediaNodesInPlaylist</name>
     <function-class>net.sourceforge.openutils.mgnlmedia.media.tags.el.MediaEl</function-class>
     <function-signature>java.util.Iterator mediaNodesInPlaylist(java.lang.Object)</function-signature>
   </function>
   <function>
-    <description></description>
+    <description>Utility functions used to replace a param in the current URL, Used internally by the crop tag.</description>
     <display-name>replaceParam</display-name>
     <name>replaceParam</name>
     <function-class>net.sourceforge.openutils.mgnlmedia.media.tags.el.MediaEl</function-class>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




Thread: [Openutils-svn] SF.net SVN: openutils:[3576] trunk/openutils-mgnlmedia/src/main (Page 4)

openutils-svn