Added source location infos to the morph pipeline.

Commit e10de395592d082596354646e555083e4aa5e1e6 annotated the Metamorph
DOM with information about the location of each element in the source
file. This commit adds this information to the data, collector and
function objects which are created based on the morph pipeline described
by the DOM.

The location information is made available through a new interface
called `KnowsSourceLocation`. It offers methods for setting and getting
location information from an object. `NamedValueReceiver` and
`NamedValueSource` extend this interface. The location information is
set via a setter method instead of via the constructor to avoid having
to add a constructor to every concrete collector or function class.

Author: cboehme

src/main/java/org/culturegraph/mf/morph/AbstractNamedValuePipe.java

@@ -15,8 +15,11 @@
  */
 package org.culturegraph.mf.morph;
 
+import org.culturegraph.mf.util.xml.Location;
+
 /**
- * Base class for {@link NamedValuePipe}s
+ * Base class for {@link NamedValuePipe}s.
+ *
  * @author Markus Michael Geipel
  * @author Chistohp Böhme
  *
@@ -25,6 +28,8 @@ public abstract class AbstractNamedValuePipe implements NamedValuePipe {
 
 	private NamedValueReceiver namedValueReceiver;
 
+	private Location sourceLocation;
+
 	@Override
 	public final <R extends NamedValueReceiver> R setNamedValueReceiver(
 			final R receiver) {
@@ -41,6 +46,16 @@ public final void addNamedValueSource(final NamedValueSource namedValueSource) {
 		onNamedValueSourceAdded(namedValueSource);
 	}
 
+	@Override
+	public void setSourceLocation(final Location sourceLocation) {
+		this.sourceLocation = sourceLocation;
+	}
+
+	@Override
+	public Location getSourceLocation() {
+		return sourceLocation;
+	}
+
 	protected void onNamedValueSourceAdded(final NamedValueSource namedValueSource) {
 		// Default implementation does nothing
 	}

src/main/java/org/culturegraph/mf/morph/Flush.java

@@ -16,17 +16,22 @@
 
 package org.culturegraph.mf.morph;
 
+import org.culturegraph.mf.util.xml.Location;
+
 
 /**
  * Flushes a {@link FlushListener}
  *
- * @author markus geipel
+ * @author Markus Geipel
+ * @author Christoph Böhme
  *
  */
 public final class Flush implements NamedValueReceiver {
 
 	private final FlushListener listener;
 
+	private Location sourceLocation;
+
 	public Flush(final FlushListener listener) {
 		this.listener = listener;
 	}
@@ -41,4 +46,14 @@ public void addNamedValueSource(final NamedValueSource namedValueSource) {
 		// Nothing to do
 	}
 
+	@Override
+	public void setSourceLocation(final Location sourceLocation) {
+		this.sourceLocation = sourceLocation;
+	}
+
+	@Override
+	public Location getSourceLocation() {
+		return sourceLocation;
+	}
+
 }

src/main/java/org/culturegraph/mf/morph/KnowsSourceLocation.java

@@ -0,0 +1,48 @@
+/*
+ *  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.morph;
+
+import org.culturegraph.mf.util.xml.Location;
+
+/**
+ * Metamorph elements which know about their location in the
+ * morph definition file should implement this interface to
+ * make the information about their location available in a
+ * standardised way.
+ *
+ * @author Christoph Böhme
+ *
+ */
+public interface KnowsSourceLocation {
+
+	/**
+	 * Sets the {@link Location} object which describes
+	 * where in the morph definition file the implementing
+	 * object is defined.
+	 *
+	 * @param sourceLocation a source location
+	 */
+	void setSourceLocation(final Location sourceLocation);
+
+	/**
+	 * @return a {@link Location} object for the
+	 * 		location in the morph definition file
+	 * 		where the implementing object instance
+	 * 		is defined.
+	 */
+	Location getSourceLocation();
+
+}

src/main/java/org/culturegraph/mf/morph/Metamorph.java

@@ -347,4 +347,18 @@ public <R extends NamedValueReceiver> R setNamedValueReceiver(final R receiver)
 		throw new UnsupportedOperationException("The Metamorph object cannot act as a NamedValueSender");
 	}
 
+	@Override
+	public void setSourceLocation(final Location sourceLocation) {
+		// Nothing to do
+		// Metamorph does not have a source location (we could
+		// in theory use the location of the module in a flux
+		// script)
+	}
+
+	@Override
+	public Location getSourceLocation() {
+		// Metamorph does not have a source location
+		return null;
+	}
+
 }

src/main/java/org/culturegraph/mf/morph/MorphBuilder.java

@@ -26,6 +26,7 @@
 import org.culturegraph.mf.morph.functions.Function;
 import org.culturegraph.mf.types.MultiMap;
 import org.culturegraph.mf.util.reflection.ObjectFactory;
+import org.culturegraph.mf.util.xml.Location;
 import org.w3c.dom.Node;
 
 /**
@@ -173,6 +174,7 @@ protected void finish() {
 	protected void enterData(final Node dataNode) {
 		final Data data = new Data();
 		data.setName(resolvedAttribute(dataNode, ATTRITBUTE.NAME));
+		data.setSourceLocation((Location) dataNode.getUserData(Location.USER_DATA_ID));
 
 		final String source = resolvedAttribute(dataNode, ATTRITBUTE.SOURCE);
 		metamorph.registerNamedValueReceiver(source, data);
@@ -232,6 +234,7 @@ protected void enterCollect(final Node node) {
 			throw new IllegalArgumentException("Collector " + node.getLocalName() + NOT_FOUND);
 		}
 		final Collect collect = getCollectFactory().newInstance(node.getLocalName(), attributes, metamorph);
+		collect.setSourceLocation((Location) node.getUserData(Location.USER_DATA_ID));
 
 		stack.push(new StackFrame(collect));
 	}
@@ -294,6 +297,8 @@ protected void handleFunction(final Node functionNode) {
 			throw new IllegalArgumentException(functionNode.getLocalName() + NOT_FOUND);
 		}
 
+		function.setSourceLocation((Location) functionNode.getUserData(Location.USER_DATA_ID));
+
 		function.setMultiMap(metamorph);
 
 		// add key value entries...

src/main/java/org/culturegraph/mf/morph/NamedValueReceiver.java

@@ -22,7 +22,7 @@
  * @author Christoph Böhme
  *
  */
-public interface NamedValueReceiver {
+public interface NamedValueReceiver extends KnowsSourceLocation {
 
 	void receive(String name, String value, NamedValueSource source, int recordCount, int entityCount);
 

src/main/java/org/culturegraph/mf/morph/NamedValueSource.java

@@ -23,7 +23,7 @@
  * @author Christoph Böhme
  *
  */
-public interface NamedValueSource {
+public interface NamedValueSource extends KnowsSourceLocation {
 
 	/**
 	 * Connects a source of named values to a receiver of named values.

src/test/java/org/culturegraph/mf/morph/MetamorphBasicTest.java

@@ -22,6 +22,7 @@
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.types.MultiMap;
 import org.culturegraph.mf.types.NamedValue;
+import org.culturegraph.mf.util.xml.Location;
 import org.junit.Assert;
 import org.junit.Test;
 
@@ -175,4 +176,15 @@ public void addNamedValueSource(final NamedValueSource namedValueSource) {
 		namedValueSource.setNamedValueReceiver(this);
 	}
 
+	@Override
+	public void setSourceLocation(final Location sourceLocation) {
+		// Nothing to do
+	}
+
+	@Override
+	public Location getSourceLocation() {
+		// Nothing to do
+		return null;
+	}
+
 }