Merge pull request #103 from scijava/usage-statistics

Usage statistics service

Author: dscho

src/main/java/org/scijava/Context.java

@@ -117,7 +117,9 @@ public Context(final boolean empty) {
 	 * </p>
 	 * 
 	 * @param serviceClasses A list of types that implement the {@link Service}
-	 *          interface (e.g., {@code DisplayService.class}).
+	 *          interface (e.g., {@code DisplayService.class}). Compatible
+	 *          services will be loaded in the order given,
+	 *          <em>regardless of their relative priorities</em>.
 	 * @see #Context(Collection, PluginIndex, boolean)
 	 * @throws ClassCastException If any of the given arguments do not implement
 	 *           the {@link Service} interface.
@@ -132,6 +134,8 @@ public Context(@SuppressWarnings("rawtypes") final Class... serviceClasses) {
 	 * 
 	 * @param serviceClasses A collection of types that implement the
 	 *          {@link Service} interface (e.g., {@code DisplayService.class}).
+	 *          Compatible services will be loaded according to the order of the
+	 *          collection, <em>regardless of their relative priorities</em>.
 	 * @see #Context(Collection, PluginIndex, boolean)
 	 */
 	public Context(final Collection<Class<? extends Service>> serviceClasses) {
@@ -144,8 +148,10 @@ public Context(final Collection<Class<? extends Service>> serviceClasses) {
 	 * 
 	 * @param serviceClasses A collection of types that implement the
 	 *          {@link Service} interface (e.g., {@code DisplayService.class}).
+	 *          Compatible services will be loaded according to the order of the
+	 *          collection, <em>regardless of their relative priorities</em>.
 	 * @param strict Whether context creation will fail fast when there is
-	 *          is an error instantiating a required service.
+	 *          an error instantiating a required service.
 	 * @see #Context(Collection, PluginIndex, boolean)
 	 */
 	public Context(final Collection<Class<? extends Service>> serviceClasses,
@@ -155,10 +161,10 @@ public Context(final Collection<Class<? extends Service>> serviceClasses,
 	}
 
 	/**
-	 * Creates a new SciJava application with the specified PluginIndex. This
-	 * allows a base set of available plugins to be defined, and is useful when
-	 * plugins that would not be returned by the {@link PluginIndex}'s
-	 * {@link org.scijava.plugin.PluginFinder} are desired.
+	 * Creates a new SciJava application context with all available services from
+	 * the specified PluginIndex. This allows a base set of available plugins to
+	 * be defined, and is useful when plugins that would not be returned by the
+	 * {@link PluginIndex}'s {@link org.scijava.plugin.PluginFinder} are desired.
 	 * 
 	 * @param pluginIndex The plugin index to use when discovering and indexing
 	 *          plugins. If you wish to completely control how services are
@@ -181,6 +187,8 @@ public Context(final PluginIndex pluginIndex) {
 	 * 
 	 * @param serviceClasses A collection of types that implement the
 	 *          {@link Service} interface (e.g., {@code DisplayService.class}).
+	 *          Compatible services will be loaded according to the order of the
+	 *          collection, <em>regardless of their relative priorities</em>.
 	 * @param pluginIndex The plugin index to use when discovering and indexing
 	 *          plugins. If you wish to completely control how services are
 	 *          discovered (i.e., use your own
@@ -212,14 +220,16 @@ public Context(final Collection<Class<? extends Service>> serviceClasses,
 	 * 
 	 * @param serviceClasses A collection of types that implement the
 	 *          {@link Service} interface (e.g., {@code DisplayService.class}).
+	 *          Compatible services will be loaded according to the order of the
+	 *          collection, <em>regardless of their relative priorities</em>.
 	 * @param pluginIndex The plugin index to use when discovering and indexing
 	 *          plugins. If you wish to completely control how services are
 	 *          discovered (i.e., use your own
 	 *          {@link org.scijava.plugin.PluginFinder} implementation), then you
 	 *          can pass a custom {@link PluginIndex} here. Passing null will
 	 *          result in a default plugin index being constructed and used.
 	 * @param strict Whether context creation will fail fast when there is
-	 *          is an error instantiating a required service.
+	 *          an error instantiating a required service.
 	 */
 	public Context(final Collection<Class<? extends Service>> serviceClasses,
 		final PluginIndex pluginIndex, final boolean strict)

src/main/java/org/scijava/Locatable.java

@@ -0,0 +1,44 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava;
+
+/**
+ * An object whose location is defined by a URL string.
+ * 
+ * @author Curtis Rueden
+ */
+public interface Locatable {
+
+	/** Gets the URL string defining the object's location. */
+	String getLocation();
+
+}

src/main/java/org/scijava/command/CommandInfo.java

@@ -45,6 +45,7 @@
 import org.scijava.Identifiable;
 import org.scijava.InstantiableException;
 import org.scijava.ItemVisibility;
+import org.scijava.Locatable;
 import org.scijava.ValidityProblem;
 import org.scijava.event.EventService;
 import org.scijava.module.Module;
@@ -76,7 +77,7 @@
  *      commands and the rich {@link Module} interface.
  */
 public class CommandInfo extends PluginInfo<Command> implements ModuleInfo,
-	Identifiable
+	Identifiable, Locatable
 {
 
 	/** Wrapped {@link PluginInfo}, if any. */
@@ -422,6 +423,18 @@ public String getIdentifier() {
 		return sb.toString();
 	}
 
+	// -- Locatable methods --
+
+	@Override
+	public String getLocation() {
+		try {
+			return ClassUtils.getLocation(loadDelegateClass()).toExternalForm();
+		}
+		catch (final ClassNotFoundException exc) {
+			return null;
+		}
+	}
+
 	// -- Helper methods --
 
 	/**

src/main/java/org/scijava/event/DefaultEventService.java

@@ -48,6 +48,7 @@
 import org.scijava.service.AbstractService;
 import org.scijava.service.Service;
 import org.scijava.thread.ThreadService;
+import org.scijava.util.ClassUtils;
 
 /**
  * Default service for publishing and subscribing to SciJava events.
@@ -63,11 +64,6 @@ public class DefaultEventService extends AbstractService implements
 	/**
 	 * The default event service's priority.
 	 * <p>
-	 * It is paramount that the event service be created and initialized before
-	 * other services. Any service created before the event service may not have
-	 * its event handling methods registered correctly.
-	 * </p>
-	 * <p>
 	 * Alternative event service implementations that wish to prioritize
 	 * themselves above this one can still ensure preferential usage via
 	 * {@code priority = DefaultEventService.PRIORITY + 1} or similar.
@@ -101,7 +97,16 @@ public <E extends SciJavaEvent> void publishLater(final E e) {
 	public List<EventSubscriber<?>> subscribe(final Object o) {
 		final List<EventSubscriber<?>> subscribers =
 			new ArrayList<EventSubscriber<?>>();
-		subscribeRecursively(subscribers, o.getClass(), o);
+		final List<Method> eventHandlers =
+			ClassUtils.getAnnotatedMethods(o.getClass(), EventHandler.class);
+		for (final Method m : eventHandlers) {
+			final Class<? extends SciJavaEvent> eventClass = getEventClass(m);
+			if (eventClass == null) {
+				log.warn("Invalid EventHandler method: " + m);
+				continue;
+			}
+			subscribers.add(subscribe(eventClass, o, m));
+		}
 		return subscribers;
 	}
 
@@ -144,30 +149,6 @@ public void dispose() {
 
 	// -- Helper methods --
 
-	/**
-	 * Recursively scans for @{@link EventHandler} annotated methods, and
-	 * subscribes them to the event service.
-	 */
-	private void subscribeRecursively(
-		final List<EventSubscriber<?>> subscribers, final Class<?> type,
-		final Object o)
-	{
-		if (type == null || type == Object.class) return;
-		for (final Method m : type.getDeclaredMethods()) {
-			final EventHandler ann = m.getAnnotation(EventHandler.class);
-			if (ann == null) continue; // not an event handler method
-
-			final Class<? extends SciJavaEvent> eventClass = getEventClass(m);
-			if (eventClass == null) {
-				log.warn("Invalid EventHandler method: " + m);
-				continue;
-			}
-
-			subscribers.add(subscribe(eventClass, o, m));
-		}
-		subscribeRecursively(subscribers, type.getSuperclass(), o);
-	}
-
 	private <E extends SciJavaEvent> void subscribe(final Class<E> c,
 		final EventSubscriber<E> subscriber)
 	{

src/main/java/org/scijava/module/AbstractModuleInfo.java

@@ -39,9 +39,11 @@
 
 import org.scijava.AbstractUIDetails;
 import org.scijava.Identifiable;
+import org.scijava.Locatable;
 import org.scijava.ValidityProblem;
 import org.scijava.event.EventService;
 import org.scijava.module.event.ModulesUpdatedEvent;
+import org.scijava.util.ClassUtils;
 import org.scijava.util.ConversionUtils;
 
 /**
@@ -54,7 +56,7 @@
  * @author Curtis Rueden
  */
 public abstract class AbstractModuleInfo extends AbstractUIDetails implements
-	ModuleInfo, Identifiable
+	ModuleInfo, Identifiable, Locatable
 {
 
 	/** Table of inputs, keyed on name. */
@@ -170,6 +172,21 @@ public String getIdentifier() {
 		return "module:" + getDelegateClassName();
 	}
 
+	// -- Locatable methods --
+
+	@Override
+	public String getLocation() {
+		// NB: By default, we use the location of the delegate class.
+		// If the same delegate class is used for more than one module, though,
+		// it may need to override this method to indicate a different location.
+		try {
+			return ClassUtils.getLocation(loadDelegateClass()).toExternalForm();
+		}
+		catch (final ClassNotFoundException exc) {
+			return null;
+		}
+	}
+
 	// -- Internal methods --
 
 	/**

src/main/java/org/scijava/module/DefaultModuleService.java

@@ -152,7 +152,7 @@ public Module createModule(final ModuleInfo info) {
 			return module;
 		}
 		catch (final ModuleException exc) {
-			log.error("Cannot create module: " + info.getDelegateClassName());
+			log.error("Cannot create module: " + info.getDelegateClassName(), exc);
 		}
 		return null;
 	}

src/main/java/org/scijava/object/DefaultObjectService.java

@@ -31,7 +31,6 @@
 
 package org.scijava.object;
 
-
 import java.util.List;
 
 import org.scijava.event.EventHandler;

src/main/java/org/scijava/script/ScriptInfo.java

@@ -278,6 +278,13 @@ public String getIdentifier() {
 		return "script:" + path;
 	}
 
+	// -- Locatable methods --
+
+	@Override
+	public String getLocation() {
+		return new File(path).toURI().normalize().toString();
+	}
+
 	// -- Helper methods --
 
 	private void parseParam(final String param) throws ScriptException {

src/main/java/org/scijava/service/ServiceHelper.java

@@ -41,6 +41,7 @@
 import org.scijava.AbstractContextual;
 import org.scijava.Context;
 import org.scijava.Optional;
+import org.scijava.event.EventHandler;
 import org.scijava.event.EventService;
 import org.scijava.log.LogService;
 import org.scijava.log.StderrLogService;
@@ -305,6 +306,11 @@ private <S extends Service> S createServiceRecursively(final Class<S> c)
 		final Double priority = classPoolMap.get(c);
 		if (priority != null) service.setPriority(priority);
 
+		// NB: If there are any @EventHandler annotated methods, we treat the
+		// EventService as a required dependency, _unless_ there is also an
+		// EventService field annotated with @Parameter(required = false).
+		boolean eventServiceRequired = true;
+
 		// populate service parameters
 		final List<Field> fields =
 			ClassUtils.getAnnotatedFields(c, Parameter.class);
@@ -332,10 +338,18 @@ private <S extends Service> S createServiceRecursively(final Class<S> c)
 				// recursively obtain needed service
 				final boolean required = f.getAnnotation(Parameter.class).required();
 				s = loadService(serviceType, required);
+				// NB: Remember when there is an optional EventService parameter.
+				if (s instanceof EventService) eventServiceRequired = required;
 			}
 			ClassUtils.setValue(f, service, s);
 		}
 
+		// check for event handlers
+		if (!ClassUtils.getAnnotatedMethods(c, EventHandler.class).isEmpty()) {
+			// NB: There are @EventHandler methods; we need an EventService.
+			loadService(EventService.class, eventServiceRequired);
+		}
+
 		service.initialize();
 		service.registerEventHandlers();
 		return service;