Added Receiver interface

Added an interface to group all receiver interfaces used in Metafacture.
This allows to make the template argument to Sender more specific.

Author: cboehme

src/main/java/org/culturegraph/mf/flux/parser/Flow.java

@@ -23,6 +23,7 @@
 import org.culturegraph.mf.exceptions.FluxParseException;
 import org.culturegraph.mf.framework.LifeCycle;
 import org.culturegraph.mf.framework.ObjectReceiver;
+import org.culturegraph.mf.framework.Receiver;
 import org.culturegraph.mf.framework.Sender;
 import org.culturegraph.mf.framework.Tee;
 import org.culturegraph.mf.stream.source.StdInOpener;
@@ -44,7 +45,7 @@ final class Flow {
 	private boolean joinLooseEnds;
 
 	@SuppressWarnings({ "unchecked", "rawtypes" })
-	public void addElement(final LifeCycle nextElement) {
+	public void addElement(final Receiver nextElement) {
 		if(element==null){
 			setStart((ObjectReceiver<? extends Object>) nextElement);
 			return;
@@ -53,7 +54,7 @@ public void addElement(final LifeCycle nextElement) {
 			final Sender sender = (Sender) element;
 			if (joinLooseEnds) {
 				teeStack.pop();
-				for (LifeCycle looseEnd : looseEndsStack.pop()) {
+				for (final LifeCycle looseEnd : looseEndsStack.pop()) {
 					if (looseEnd instanceof Tee) {
 						((Tee) looseEnd).addReceiver(nextElement);
 					} else {
@@ -115,7 +116,7 @@ public void close() {
 		start.closeStream();
 	}
 
-	public LifeCycle getFirst() {
+	public Receiver getFirst() {
 		return start;
 	}
 }

src/main/java/org/culturegraph/mf/flux/parser/FluxProgramm.java

@@ -29,7 +29,7 @@
 
 import org.culturegraph.mf.exceptions.FluxParseException;
 import org.culturegraph.mf.flux.HelpPrinter;
-import org.culturegraph.mf.framework.LifeCycle;
+import org.culturegraph.mf.framework.Receiver;
 import org.culturegraph.mf.util.ResourceUtil;
 import org.culturegraph.mf.util.reflection.ObjectFactory;
 
@@ -39,7 +39,7 @@
  */
 public final class FluxProgramm {
 
-	private static final ObjectFactory<LifeCycle> COMMAND_FACTORY = new ObjectFactory<LifeCycle>();
+	private static final ObjectFactory<Receiver> COMMAND_FACTORY = new ObjectFactory<Receiver>();
 	private static final String PROPERTIES_LOCATION = "flux-commands.properties";
 
 	static {
@@ -48,9 +48,9 @@ public final class FluxProgramm {
 					.getResources(PROPERTIES_LOCATION);
 			while (enumeration.hasMoreElements()) {
 				final URL url = enumeration.nextElement();
-				COMMAND_FACTORY.loadClassesFromMap(ResourceUtil.loadProperties(url), LifeCycle.class);
+				COMMAND_FACTORY.loadClassesFromMap(ResourceUtil.loadProperties(url), Receiver.class);
 			}
-		} catch (IOException e) {
+		} catch (final IOException e) {
 			throw new FluxParseException("unable to load properties.", e);
 		}
 	}
@@ -60,15 +60,15 @@ public final class FluxProgramm {
 	private final Map<String, Wormhole> wormholeNameMapping = new HashMap<String, Wormhole>();
 	private final Map<Flow, Wormhole> wormholeInFlowMapping = new Hashtable<Flow, Wormhole>();
 
-	private static LifeCycle createElement(final String name, final Map<String, String> namedArgs,
+	private static Receiver createElement(final String name, final Map<String, String> namedArgs,
 			final List<Object> cArgs) {
 
-		final LifeCycle newElement;
+		final Receiver newElement;
 		if (COMMAND_FACTORY.containsKey(name)) {
 			newElement = COMMAND_FACTORY.newInstance(name, namedArgs, cArgs.toArray());
 
 		} else {
-			newElement = ObjectFactory.newInstance(ObjectFactory.loadClass(name, LifeCycle.class), cArgs.toArray());
+			newElement = ObjectFactory.newInstance(ObjectFactory.loadClass(name, Receiver.class), cArgs.toArray());
 			ObjectFactory.applySetters(newElement, namedArgs);
 		}
 		return newElement;
@@ -136,20 +136,20 @@ protected void nextFlow() {
 
 	protected void compile() {
 
-		for (Wormhole wormhole : wormholeNameMapping.values()) {
+		for (final Wormhole wormhole : wormholeNameMapping.values()) {
 			if (wormhole.getOut() == null) {
 				throw new FluxParseException("Wormhole " + wormhole.getName() + " is going nowhere");
 			}
 
-			for (Flow flow : wormhole.getIns()) {
+			for (final Flow flow : wormhole.getIns()) {
 
 				flow.addElement(wormhole.getOut().getFirst());
 			}
 		}
 	}
 
 	public void start() {
-		for (Flow flow : initialFlows) {
+		for (final Flow flow : initialFlows) {
 			flow.start();
 			if (!wormholeInFlowMapping.containsKey(flow)) {
 				flow.close();
@@ -197,7 +197,7 @@ public void finished(final Flow flow) {
 			insReady.remove(flow);
 			insFinished.add(flow);
 			if (insReady.isEmpty()) {
-				for (Flow finished : insFinished) {
+				for (final Flow finished : insFinished) {
 					finished.close();
 				}
 			}

src/main/java/org/culturegraph/mf/framework/DefaultObjectPipe.java

@@ -16,7 +16,7 @@
 package org.culturegraph.mf.framework;
 
 /**
- * Default implementation for {@link ObjectPipe}s which simply 
+ * Default implementation for {@link ObjectPipe}s which simply
  * does nothing.
  *
  * @param <T> object type that this module processes
@@ -25,19 +25,19 @@
  * @author Christoph Böhme
  *
  */
-public class DefaultObjectPipe<T, R extends LifeCycle> 
+public class DefaultObjectPipe<T, R extends Receiver>
 		extends DefaultSender<R> implements ObjectPipe<T, R> {
 
 	// CHECKSTYLE OFF: StrictDuplicateCode
 	// Code duplication in DefaultObjectPipe and DefaultObjectReceiver
-	// cannot be avoided. DefaultObjectPipe combines the logic 
+	// cannot be avoided. DefaultObjectPipe combines the logic
 	// from DefaultSender and DefaultObjectReceiver but can only
 	// have one of these classes as its base class. Hence, the
 	// logic from the second one must be duplicated here.
 
 	@Override
 	public void process(final T obj) {
-		// Default implementation does nothing		
+		// Default implementation does nothing
 	}
 
 	// CHECKSTYLE ON: StrictDuplicateCode

src/main/java/org/culturegraph/mf/framework/DefaultSender.java

@@ -30,7 +30,7 @@
  * @author Christoph Böhme
  * 
  */
-public class DefaultSender<T extends LifeCycle> implements Sender<T> {
+public class DefaultSender<T extends Receiver> implements Sender<T> {
 
 	private T receiver;
 	private boolean isClosed;

src/main/java/org/culturegraph/mf/framework/DefaultStreamPipe.java

@@ -16,20 +16,20 @@
 package org.culturegraph.mf.framework;
 
 /**
- * Default implementation for {@link StreamPipe}s which simply 
+ * Default implementation for {@link StreamPipe}s which simply
  * does nothing.
  * 
  * @param <R> receiver type of the downstream receiver
  * 
  * @author Markus Michael Geipel, Christoph Böhme
  * 
  */
-public class DefaultStreamPipe<R extends LifeCycle> 
+public class DefaultStreamPipe<R extends Receiver>
 		extends DefaultSender<R> implements StreamPipe<R> {
 
 	// CHECKSTYLE OFF: StrictDuplicateCode
 	// Code duplication in DefaultStreamPipe and DefaultStreamReceiver
-	// cannot be avoided. DefaultStreamPipe combines the logic 
+	// cannot be avoided. DefaultStreamPipe combines the logic
 	// from DefaultSender and DefaultStreamReceiver but can only
 	// have one of these classes as its base class. Hence, the
 	// logic from the second one must be duplicated here.

src/main/java/org/culturegraph/mf/framework/DefaultTee.java

@@ -27,7 +27,7 @@
  *
  * @author Christoph Böhme
  */
-public class DefaultTee<T extends LifeCycle> implements Tee<T> {
+public class DefaultTee<T extends Receiver> implements Tee<T> {
 
 	private final List<T> receivers = new ArrayList<T>();
 
@@ -72,15 +72,15 @@ public final Tee<T> clearReceivers() {
 	@Override
 	public final void resetStream() {
 		onResetStream();
-		for (T receiver : receivers) {
+		for (final T receiver : receivers) {
 			receiver.resetStream();
 		}
 	}
 
 	@Override
 	public final void closeStream() {
 		onCloseStream();
-		for (T receiver : receivers) {
+		for (final T receiver : receivers) {
 			receiver.closeStream();
 		}
 	}
@@ -92,37 +92,37 @@ public final void closeStream() {
 	 * receivers.
 	 */
 	protected void onChangeReceivers() {
-		// Default implementation does nothing		
+		// Default implementation does nothing
 	}
 
 	/**
 	 * Invoked when the {@code resetStream()} method is called.
-	 * Override this method to perform a reset of the module. 
+	 * Override this method to perform a reset of the module.
 	 * 
-	 * Do not call the {@code resetStream()} method of the next modules downstream. 
-	 * This is handled by the implementation of {@code resetStream()} in 
+	 * Do not call the {@code resetStream()} method of the next modules downstream.
+	 * This is handled by the implementation of {@code resetStream()} in
 	 * {@code DefaultTee}.
 	 * 
 	 * {@code onResetStream()} is called before {@code DefaultTee} calls the
 	 * {@code resetStream()} method of the downstream modules.
 	 */
 	protected void onResetStream() {
-		// Default implementation does nothing		
+		// Default implementation does nothing
 	}
 
 	/**
-	 * Invoked when the {@code closeStream()} method is called. Override 
-	 * this method to close any resources used by the module. 
+	 * Invoked when the {@code closeStream()} method is called. Override
+	 * this method to close any resources used by the module.
 	 * 
-	 * Do not call the {@code closeStream()} method of the next modules 
-	 * downstream. This is handled by the implementation of 
+	 * Do not call the {@code closeStream()} method of the next modules
+	 * downstream. This is handled by the implementation of
 	 * {@code closeStream()} in {@code DefaultTee}.
 	 * 
-	 * {@code onCloseStream()} is called before {@code DefaultTee} calls 
+	 * {@code onCloseStream()} is called before {@code DefaultTee} calls
 	 * the {@code closeStream()} method of the downstream modules.
 	 */
 	protected void onCloseStream() {
-		// Default implementation does nothing		
+		// Default implementation does nothing
 	}
 
 	/**

src/main/java/org/culturegraph/mf/framework/DefaultXmlPipe.java

@@ -24,27 +24,27 @@
 import org.xml.sax.SAXParseException;
 
 /**
- * Default implementation for {@link XmlPipe}s which simply 
+ * Default implementation for {@link XmlPipe}s which simply
  * does nothing.
  *
  * @param <R> receiver type of the downstream module
  * 
  * @author Christoph Böhme
  *
  */
-public class DefaultXmlPipe <R extends LifeCycle>
+public class DefaultXmlPipe <R extends Receiver>
 		extends DefaultSender<R> implements XmlPipe<R> {
 
 	// CHECKSTYLE OFF: StrictDuplicateCode
 	// Code duplication in DefaultXmlPipe and DefaultXmlReceiver
-	// cannot be avoided. DefaultXmlPipe combines the logic 
+	// cannot be avoided. DefaultXmlPipe combines the logic
 	// from DefaultSender and DefaultXmlReceiver but can only
 	// have one of these classes as its base class. Hence, the
 	// logic from the second one must be duplicated here.
 
 	@Override
 	public void setDocumentLocator(final Locator locator) {
-		// Default implementation does nothing		
+		// Default implementation does nothing
 	}
 
 	@Override
@@ -168,7 +168,7 @@ public void endCDATA() throws SAXException {
 	}
 
 	@Override
-	public void comment(final char[] chars, final int start, final int length) 
+	public void comment(final char[] chars, final int start, final int length)
 			throws SAXException {
 		// Default implementation does nothing
 	}

src/main/java/org/culturegraph/mf/framework/ObjectPipe.java

@@ -28,6 +28,6 @@
  * @author Christoph Böhme
  *
  */
-public interface ObjectPipe<T, R extends LifeCycle> extends ObjectReceiver<T>, Sender<R> {
+public interface ObjectPipe<T, R extends Receiver> extends ObjectReceiver<T>, Sender<R> {
 	// Just a combination of sender and receiver
 }

src/main/java/org/culturegraph/mf/framework/ObjectReceiver.java

@@ -26,10 +26,10 @@
  * @author Christoph Böhme
  * 
  */
-public interface ObjectReceiver<T> extends LifeCycle {
+public interface ObjectReceiver<T> extends Receiver {
 
 	/**
-	 * This method is called by upstream modules to trigger the 
+	 * This method is called by upstream modules to trigger the
 	 * processing of {@code obj}.
 	 * 
 	 * @param obj the object to be processed

src/main/java/org/culturegraph/mf/framework/Receiver.java

@@ -0,0 +1,27 @@
+/*
+ *  Copyright 2014 Christoph Böhme
+ *
+ *  Licensed 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.culturegraph.mf.framework;
+
+/**
+ * A common base for all receiver interfaces.
+ * 
+ * @author Christoph Böhme
+ *
+ */
+public interface Receiver extends LifeCycle {
+	// This interface servces only as a common
+	// base for all receiver interfaces.
+}