From: <mol...@us...> - 2009-10-16 09:47:07
|
Revision: 1489 http://openutils.svn.sourceforge.net/openutils/?rev=1489&view=rev Author: molaschi Date: 2009-10-16 09:46:56 +0000 (Fri, 16 Oct 2009) Log Message: ----------- fix broken javadocs, clean some code and update tld docs Modified Paths: -------------- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/commands/MediaActivationCommand.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/dialog/DialogSelectMedia.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/lifecycle/MediaModule.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/pages/MediaSearchPage.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImagePostProcessor.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImageResolutionProcessor.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/RoundedCornersProcessor.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RemoveResolutionsNodeTask.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RenameThumbToImageTask.java 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/types/MediaTypeHandler.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/BaseTypeHandler.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/ImageTypeHandler.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtils.java trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/JpegUtils.java trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/FileNodeData.java trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtilsTest.java Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/commands/MediaActivationCommand.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/commands/MediaActivationCommand.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/commands/MediaActivationCommand.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -116,6 +116,13 @@ } } + /** + * Activate recursive one level + * @param parentPath parent node + * @param node node to activate + * @throws RepositoryException exception + * @throws ExchangeException exception exchanging node + */ @SuppressWarnings("unchecked") public void activateRecursiveOneLevel(String parentPath, Content node) throws RepositoryException, ExchangeException Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/dialog/DialogSelectMedia.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/dialog/DialogSelectMedia.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/dialog/DialogSelectMedia.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -222,9 +222,6 @@ return MessagesUtil.chain("net.sourceforge.openutils.mgnlmedia.media.lang.messages", super.getMessages()); } - /** - * {@inheritDoc} - */ protected String getPath() { return "dialog/selectMedia.ftl"; Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/lifecycle/MediaModule.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/lifecycle/MediaModule.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/lifecycle/MediaModule.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -52,11 +52,18 @@ private static MediaModule instance; + /** + * Constructor + */ public MediaModule() { instance = this; } + /** + * Get instance + * @return media module instance + */ public static MediaModule getInstance() { return instance; Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/pages/MediaSearchPage.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/pages/MediaSearchPage.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/pages/MediaSearchPage.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -159,11 +159,6 @@ return super.show(); } - public String search() - { - return null; - } - /** * Returns the mtc. * @return the mtc Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImagePostProcessor.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImagePostProcessor.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImagePostProcessor.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -38,5 +38,13 @@ public interface ImagePostProcessor { + /** + * Process image + * @param image image to process + * @param x width + * @param y height + * @param parameters parameters map + * @return processed image + */ BufferedImage processImage(BufferedImage image, int x, int y, Map<String, String> parameters); } Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImageResolutionProcessor.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImageResolutionProcessor.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/ImageResolutionProcessor.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -40,6 +40,14 @@ public interface ImageResolutionProcessor { + /** + * Process image + * @param original original image + * @param x required width + * @param y required height + * @param parameters parameters + * @return resized image + */ BufferedImage getImageForResolution(BufferedImage original, int x, int y, Map<String, String> parameters); } Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/RoundedCornersProcessor.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/RoundedCornersProcessor.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/processors/RoundedCornersProcessor.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -13,6 +13,14 @@ /** + * Generate rounded corners on images.<br/> + * Activated by declaring the parameter <strong>roundcorners</strong>; its value can be: + * <ul> + * <li>no value or true: processor draws roundcorners with 5px radius</li> + * <li>int value: processor draws roundcorners with passed radius</li> + * </ul> + * If the "background" parameter is specified (hex color), it will be applied when rounding corners.<br/> + * If no "background" parameter is found, if the image format is png a transparent background is applied else a white background is applied. * @author molaschi * @version $Id: $ */ Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RemoveResolutionsNodeTask.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RemoveResolutionsNodeTask.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RemoveResolutionsNodeTask.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -50,8 +50,7 @@ { /** - * @param taskName - * @param taskDescription + * Constructor */ public RemoveResolutionsNodeTask() { @@ -61,6 +60,7 @@ /** * {@inheritDoc} */ + @SuppressWarnings("unchecked") public void execute(InstallContext installContext) throws TaskExecutionException { HierarchyManager hm = installContext.getHierarchyManager(MediaModule.REPO); Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RenameThumbToImageTask.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RenameThumbToImageTask.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/setup/RenameThumbToImageTask.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -53,8 +53,7 @@ { /** - * @param taskName - * @param taskDescription + * Constructor */ public RenameThumbToImageTask() { @@ -64,6 +63,7 @@ /** * {@inheritDoc} */ + @SuppressWarnings("unchecked") public void execute(InstallContext installContext) throws TaskExecutionException { HierarchyManager hm = installContext.getHierarchyManager(MediaModule.REPO); 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 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/tags/el/MediaEl.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -42,7 +42,6 @@ import javax.jcr.RepositoryException; import javax.jcr.query.InvalidQueryException; -import javax.servlet.jsp.JspTagException; import net.sourceforge.openutils.mgnlmedia.media.configuration.MediaConfigurationManager; import net.sourceforge.openutils.mgnlmedia.media.configuration.MediaTypeConfiguration; @@ -77,7 +76,7 @@ /** * Get content node for media - * @param uuid media uuid + * @param obj content node or node UUID * @return content node */ public static Content getNode(Object obj) Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/MediaTypeHandler.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/MediaTypeHandler.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/MediaTypeHandler.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -67,7 +67,8 @@ /** * @param media * @param options - * @return + * @param aaaa + * @return url */ String getUrl(Content media, Map<String, String> options); @@ -175,6 +176,8 @@ * @param f file input stream * @param cleanFileName file name without extension * @param extension file extension + * @exception RepositoryException exception working on repository + * @exception AccessDeniedException exception accessing node */ void saveFromZipFile(Content media, File f, String cleanFileName, String extension) throws AccessDeniedException, RepositoryException; Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/BaseTypeHandler.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/BaseTypeHandler.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/BaseTypeHandler.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -60,6 +60,9 @@ public abstract class BaseTypeHandler implements MediaTypeHandler { + /** + * Nodedata name where original media content is saved + */ public static final String ORGINAL_NODEDATA_NAME = "original"; /** @@ -82,7 +85,7 @@ */ public String getNewNodeName(MultipartForm form, HttpServletRequest request) { - return form.getParameter(ORGINAL_NODEDATA_NAME + "_" + FileProperties.PROPERTY_FILENAME); + return request.getParameter(ORGINAL_NODEDATA_NAME + "_" + FileProperties.PROPERTY_FILENAME); } /** Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/ImageTypeHandler.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/ImageTypeHandler.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/types/impl/ImageTypeHandler.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -30,8 +30,6 @@ import net.sourceforge.openutils.mgnlmedia.media.utils.ImageUtils; import org.apache.commons.lang.StringUtils; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; /** @@ -43,11 +41,6 @@ { /** - * Logger. - */ - private final Logger log = LoggerFactory.getLogger(ImageTypeHandler.class); - - /** * {@inheritDoc} */ public String getThumbnailUrl(Content media) Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtils.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtils.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtils.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -92,6 +92,9 @@ private static SimpleDateFormat sdf; + /** + * Nodedata name where resolution is saved + */ public static String RESOLUTION_PROPERTY = "resolution"; private static final String[] extensions = new String[]{"jpg", "gif", "png" }; @@ -157,6 +160,7 @@ * @param y new height * @param canvasX canvas width * @param canvasY canvas height + * @param background background color * @return resized image */ public static BufferedImage resizeImage(BufferedImage original, int x, int y, int canvasX, int canvasY, @@ -248,49 +252,13 @@ return resizedImage; } - private static int[] convertHexToRGB(String hexColor) - { - String hex = hexColor.trim(); - if (hex.startsWith("#")) - { - hex = hex.substring(1); - } - if (hex.equals("transparent")) - { - return new int[]{0, 0, 0, 0 }; - } - if (hex.length() == 3) - { - // allow three digit codes like for css - hex = String.valueOf(hex.charAt(0)) - + String.valueOf(hex.charAt(0)) - + String.valueOf(hex.charAt(1)) - + String.valueOf(hex.charAt(1)) - + String.valueOf(hex.charAt(2)) - + String.valueOf(hex.charAt(2)); - } - - int[] rgb = new int[4]; - try - { - // Convert rrggbb string to hex ints - rgb[0] = Integer.parseInt(hex.substring(0, 2), 16); - rgb[1] = Integer.parseInt(hex.substring(2, 4), 16); - rgb[2] = Integer.parseInt(hex.substring(4), 16); - rgb[3] = 255; - } - catch (NumberFormatException e) - { - log.error("NumberFormatException occured during text-to-image conversion: " - + "Attempting to convert Hex [" - + hex - + "] color to RGB color: " - + e.getMessage(), e); - rgb = new int[]{255, 0, 0, 255 }; // red - } - return rgb; - } - + /** + * Create rounded corners on image + * @param original original image + * @param backgroundColor optional background color + * @param radius corners radius + * @return image with rounded corners + */ public static BufferedImage addRoundedCorners(BufferedImage original, Color backgroundColor, int radius) { int originalImageType = getType(original.getColorModel()); @@ -450,6 +418,8 @@ * Get an inputstream for an image and the target file extension * @param image image to get the inputstream from * @param extension target file extension + * @param quality image quality + * @param forceProgressive true if image has to be saved as progressive mode * @return inputstream * @throws IOException */ @@ -462,7 +432,7 @@ try { - Iterator writers; + Iterator<ImageWriter> writers; ImageOutputStream imageOutputStream; ImageWriteParam params; ImageWriter imageWriter; @@ -472,7 +442,7 @@ if (writers != null && writers.hasNext()) { // Fetch the first writer in the list - imageWriter = (ImageWriter) writers.next(); + imageWriter = writers.next(); // Specify the parameters according to those the output file will be written @@ -752,6 +722,7 @@ * Get image for a resolution * @param original original image * @param resolution resolution + * @param params parameters * @return new image */ public static BufferedImage getImageForResolution(BufferedImage original, String resolution, Modified: trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/JpegUtils.java =================================================================== --- trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/JpegUtils.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/java/net/sourceforge/openutils/mgnlmedia/media/utils/JpegUtils.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -70,6 +70,9 @@ * raster data to RGB. Technique due to MArk Stephens. Free for any use. See * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4799903 or * http://www.mail-archive.com/jav...@ca.../msg03247.html + * @param raster raster image + * @param ycckProfile true for YCCK color profile (else CMYK) + * @return image */ public static BufferedImage createJPEG4(Raster raster, boolean ycckProfile) { @@ -144,7 +147,9 @@ } /** + * process image * @param image + * @return image */ public static BufferedImage processNonStandardImage(NodeData image) { @@ -153,13 +158,13 @@ { // Get an ImageReader. ImageInputStream input = ImageIO.createImageInputStream(is2); - Iterator readers = ImageIO.getImageReaders(input); + Iterator<ImageReader> readers = ImageIO.getImageReaders(input); if (readers == null || !readers.hasNext()) { throw new RuntimeException("No ImageReaders found"); } - ImageReader reader = (ImageReader) readers.next(); + ImageReader reader = readers.next(); reader.setInput(input); String format = reader.getFormatName(); Modified: trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld =================================================================== --- trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/main/resources/META-INF/media.tld 2009-10-16 09:46:56 UTC (rev 1489) @@ -180,6 +180,28 @@ set player skin </td> </tr> + <tr> + <td> + useEm + </td> + <td> + false + </td> + <td> + if true, and ignoreDimensions is not true it will apply style attribute on img tags with sidth and height in "em". the em values will be computed using as width in pixel * emRatio (see next attribute) + </td> + </tr> + <tr> + <td> + emRatio + </td> + <td> + false + </td> + <td> + float value to convert dimensions from px to em + </td> + </tr> </table> For videos or mp3s it needs the following scripts loaded in page: Modified: trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/FileNodeData.java =================================================================== --- trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/FileNodeData.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/FileNodeData.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -54,6 +54,10 @@ private byte[] content; + /** + * @param classpathLocation + * @throws IOException + */ public FileNodeData(String classpathLocation) throws IOException { InputStream is = getClass().getResourceAsStream(classpathLocation); @@ -92,6 +96,7 @@ /** * {@inheritDoc} */ + @SuppressWarnings("unchecked") public Collection getAttributeNames() throws RepositoryException { // TODO Auto-generated method stub Modified: trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtilsTest.java =================================================================== --- trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtilsTest.java 2009-10-14 15:07:43 UTC (rev 1488) +++ trunk/openutils-mgnlmedia/src/test/java/net/sourceforge/openutils/mgnlmedia/media/utils/ImageUtilsTest.java 2009-10-16 09:46:56 UTC (rev 1489) @@ -52,6 +52,9 @@ public class ImageUtilsTest { + /** + * + */ @BeforeMethod public void setup() { @@ -65,6 +68,9 @@ }); } + /** + * @throws Exception + */ @Test public void testYcck() throws Exception { @@ -88,6 +94,9 @@ } + /** + * @throws Exception + */ @Test public void testBorders() throws Exception { @@ -113,6 +122,9 @@ } + /** + * @throws Exception + */ @Test public void testBadImageTxt() throws Exception { @@ -122,6 +134,9 @@ Assert.assertNull(bufferedImage); } + /** + * @throws Exception + */ @Test public void testBadImageJpg() throws Exception { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |