taverna-renderers-impl/src/main/java/org/apache/taverna/renderers/impl/AbstractRenderer.java

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.apache.taverna.renderers.impl;

import static java.lang.String.format;
import static javax.swing.JOptionPane.YES_NO_OPTION;
import static javax.swing.JOptionPane.YES_OPTION;
import static javax.swing.JOptionPane.showConfirmDialog;
import static org.apache.taverna.renderers.RendererUtils.getSizeInBytes;
import static org.apache.taverna.renderers.impl.RendererConstants.BIG_DATA_MSG;
import static org.apache.taverna.renderers.impl.RendererConstants.CANCELLED_MSG;
import static org.apache.taverna.renderers.impl.RendererConstants.NO_DATA_MSG;
import static org.apache.taverna.renderers.impl.RendererConstants.NO_SIZE_MSG;
import static org.apache.taverna.databundle.DataBundles.isValue;
import static org.apache.taverna.databundle.DataBundles.isReference;

import java.nio.file.Path;

import javax.swing.JComponent;
import javax.swing.JTextArea;

import org.apache.taverna.renderers.Renderer;
import org.apache.taverna.renderers.RendererException;

import org.apache.log4j.Logger;

/**
 * Implements some of the common code across the renderers.
 * 
 * @author Donal Fellows
 */
abstract class AbstractRenderer implements Renderer {
	protected Logger logger = Logger.getLogger(AbstractRenderer.class);
	/** Size of a <s>mibibyte</s> megabyte. */
	private int MEGABYTE = 1024 * 1024;

	/**
	 * Work out size of file in megabytes
	 * 
	 * @param bytes
	 *            Number of bytes
	 * @return Number of megabytes
	 */
	private int bytesToMeg(long bytes) {
		float f = bytes / MEGABYTE;
		return Math.round(f);
	}

	/**
	 * Implements basic checks on the entity to render before delegating to
	 * subclasses to actually do the rendering.
	 * 
	 * @see #getRendererComponent(Path)
	 */
	@Override
	public JComponent getComponent(Path path) throws RendererException {
		if (!isValue(path) && !isReference(path)) {
			logger.error("unrenderable: data is not a value or reference");
			return new JTextArea(NO_DATA_MSG);
		}

		// Get the size
		long sizeInBytes;
		try {
			sizeInBytes = getSizeInBytes(path);
		} catch (Exception ex) {
			logger.error("unrenderable: failed to get data size", ex);
			return new JTextArea(NO_SIZE_MSG + ex.getMessage());
		}

		// over the limit for this renderer?
		if (sizeInBytes > MEGABYTE * getSizeLimit()) {
			JComponent alternative = sizeCheck(path, bytesToMeg(sizeInBytes));
			if (alternative != null)
				return alternative;
		}

		return getRendererComponent(path);
	}

	/**
	 * Implements the user-visible part of the size check. Default version just
	 * does a simple yes/no proceed.
	 * 
	 * @return <tt>null</tt> if the normal flow is to continue, or a component
	 *         to show to the user if it is to be used instead (e.g., to show a
	 *         message that the entity was too large).
	 */
	protected JComponent sizeCheck(Path path, int approximateSizeInMB) {
		int response = showConfirmDialog(null,
				format(BIG_DATA_MSG, getResultType(), approximateSizeInMB),
				getSizeQueryTitle(), YES_NO_OPTION);
		if (response != YES_OPTION) // NO_OPTION or ESCAPE key
			return new JTextArea(CANCELLED_MSG);
		return null;
	}

	/**
	 * How should we describe the data to the user? Should be capitalised.
	 */
	protected String getResultType() {
		return "Result";
	}

	/**
	 * At what size (in megabytes) do we query the user?
	 * 
	 * @see #sizeCheck(Path,log)
	 */
	protected int getSizeLimit() {
		return 1;
	}

	/**
	 * What title do we use on the dialog used to query the user?
	 * 
	 * @see #sizeCheck(Path,log)
	 */
	protected String getSizeQueryTitle() {
		return "Render this image?";
	}

	/** Actually get the renderer; the basic checks have passed. */
	protected abstract JComponent getRendererComponent(Path path)
			throws RendererException;
}