Improved code formatting and added documentation.

Brought the formatting of the code in the metamorph package in line with
the rest of metafacture-core. Additionally, the javadoc comments were
improved and misleading comments removed.

Author: cboehme

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

@@ -37,7 +37,7 @@
 
 /**
  * Builds a {@link Metamorph} from an xml description
- * 
+ *
  * @author Markus Michael Geipel
  */
 public abstract class AbstractMetamorphDomWalker {
@@ -124,7 +124,7 @@ public final void walk(final Reader reader) {
 		}
 		walk(DomLoader.parse(SCHEMA_FILE, new InputSource(reader)));
 	}
-	
+
 	public final void walk(final Reader morphDefReader, final Map<String, String> vars) {
 		this.vars.putAll(vars);
 		walk(morphDefReader);
@@ -135,7 +135,7 @@ public final void walk(final String morphDef, final Map<String, String> vars) {
 		this.vars.putAll(vars);
 		walk(morphDef);
 	}
-	
+
 	public final void walk(final InputStream inputStream, final Map<String, String> vars) {
 		this.vars.putAll(vars);
 		walk(inputStream);
@@ -163,24 +163,24 @@ protected static Map<String, String> attributeMap(final Node node) {
 		}
 		return attributes;
 	}
-	
+
 	protected  final String resolveVars(final String string){
 		return StringUtil.format(string, Metamorph.VAR_START, Metamorph.VAR_END, ignoreMissingVars, vars);
 	}
-	
+
 	protected final void setIgnoreMissingVars(final boolean ignoreMissingVars) {
 		this.ignoreMissingVars = ignoreMissingVars;
 	}
-	
+
 	protected final String resolvedAttribute(final Node node, final ATTRITBUTE attr){
 		final String value = attribute(node, attr);
 		if(null==value){
 			return null;
 		}
 		return resolveVars(value);
-		
+
 	}
-	
+
 	protected  final Map<String, String> resolvedAttributeMap(final Node node){
 		final Map<String, String> attributes = new HashMap<String, String>();
 		final NamedNodeMap attrNode = node.getAttributes();
@@ -191,15 +191,6 @@ protected  final Map<String, String> resolvedAttributeMap(final Node node){
 		}
 		return attributes;
 	}
-	
-	private void handleVars(final Node varsNode) {
-		for (Node varNode = varsNode.getFirstChild(); varNode != null; varNode = varNode.getNextSibling()) {
-			final String varName = attribute(varNode, ATTRITBUTE.NAME);
-			final String varValue = attribute(varNode, ATTRITBUTE.VALUE);
-			vars.put(varName, varValue);
-		}
-		vars = new ScopedHashMap<String, String>(vars);
-	}
 
 	protected final void walk(final Document doc) {
 		functionFactory = new FunctionFactory();
@@ -242,44 +233,26 @@ protected final void walk(final Document doc) {
 		finish();
 	}
 
-	private void handleMacros(final Node node) {
-		for (Node macroNode = node.getFirstChild(); macroNode != null; macroNode = macroNode.getNextSibling()) {
-			final String name = attribute(macroNode, ATTRITBUTE.NAME);
-			macros.put(name, macroNode);
+	private void handleMeta(final Node node) {
+		for (Node metaEntryNode = node.getFirstChild(); metaEntryNode != null; metaEntryNode = metaEntryNode
+				.getNextSibling()) {
+
+			handleMetaEntry(metaEntryNode.getLocalName(), metaEntryNode.getTextContent());
 		}
 	}
 
-	protected abstract void init();
-
-	protected abstract void finish();
-
-	protected abstract void setEntityMarker(final String entityMarker);
-
-	protected abstract void handleInternalMap(final Node mapNode);
-
-	protected abstract void handleMapClass(final Node mapNode);
-
-	protected abstract void handleMetaEntry(final String name, final String value);
-
-	protected abstract void handleFunctionDefinition(final Node functionDefNode);
-
-	protected abstract void enterData(Node node);
-
-	protected abstract void exitData(Node node);
-
-	protected abstract void enterCollect(Node node);
-
-	protected abstract void exitCollect(Node node);
-
-	protected abstract void enterName(Node node);
-	
-	protected abstract void exitName(Node node);
-
-	protected abstract void enterIf(Node node);
-	
-	protected abstract void exitIf(Node node);
+	private void handleFunctionDefinitions(final Node node) {
+		for (Node functionDefNode = node.getFirstChild(); functionDefNode != null; functionDefNode = functionDefNode
+				.getNextSibling()) {
+			handleFunctionDefinition(functionDefNode);
+		}
+	}
 
-	protected abstract void handleFunction(Node functionNode);
+	private void handleRules(final Node node) {
+		for (Node ruleNode = node.getFirstChild(); ruleNode != null; ruleNode = ruleNode.getNextSibling()) {
+			handleRule(ruleNode);
+		}
+	}
 
 	private void handleRule(final Node node) {
 		final String nodeName = node.getLocalName();
@@ -320,10 +293,6 @@ private void handleRule(final Node node) {
 		}
 	}
 
-	private void handleIf(final Node node) {
-		
-	}
-	
 	private void handlePostprocess(final Node node) {
 		for (Node functionNode = node.getFirstChild(); functionNode != null; functionNode = functionNode
 				.getNextSibling()) {
@@ -341,9 +310,19 @@ private void handleMaps(final Node node) {
 		}
 	}
 
-	private void handleRules(final Node node) {
-		for (Node ruleNode = node.getFirstChild(); ruleNode != null; ruleNode = ruleNode.getNextSibling()) {
-			handleRule(ruleNode);
+	private void handleVars(final Node varsNode) {
+		for (Node varNode = varsNode.getFirstChild(); varNode != null; varNode = varNode.getNextSibling()) {
+			final String varName = attribute(varNode, ATTRITBUTE.NAME);
+			final String varValue = attribute(varNode, ATTRITBUTE.VALUE);
+			vars.put(varName, varValue);
+		}
+		vars = new ScopedHashMap<String, String>(vars);
+	}
+
+	private void handleMacros(final Node node) {
+		for (Node macroNode = node.getFirstChild(); macroNode != null; macroNode = macroNode.getNextSibling()) {
+			final String name = attribute(macroNode, ATTRITBUTE.NAME);
+			macros.put(name, macroNode);
 		}
 	}
 
@@ -359,18 +338,36 @@ protected final void illegalChild(final Node child) {
 				+ child.getParentNode().getLocalName());
 	}
 
-	private void handleFunctionDefinitions(final Node node) {
-		for (Node functionDefNode = node.getFirstChild(); functionDefNode != null; functionDefNode = functionDefNode
-				.getNextSibling()) {
-			handleFunctionDefinition(functionDefNode);
-		}
-	}
+	protected abstract void init();
 
-	private void handleMeta(final Node node) {
-		for (Node metaEntryNode = node.getFirstChild(); metaEntryNode != null; metaEntryNode = metaEntryNode
-				.getNextSibling()) {
+	protected abstract void finish();
+
+	protected abstract void setEntityMarker(final String entityMarker);
+
+	protected abstract void handleInternalMap(final Node mapNode);
+
+	protected abstract void handleMapClass(final Node mapNode);
+
+	protected abstract void handleMetaEntry(final String name, final String value);
+
+	protected abstract void handleFunctionDefinition(final Node functionDefNode);
+
+	protected abstract void enterData(Node node);
+
+	protected abstract void exitData(Node node);
+
+	protected abstract void enterCollect(Node node);
+
+	protected abstract void exitCollect(Node node);
+
+	protected abstract void enterName(Node node);
+
+	protected abstract void exitName(Node node);
+
+	protected abstract void enterIf(Node node);
+
+	protected abstract void exitIf(Node node);
+
+	protected abstract void handleFunction(Node functionNode);
 
-			handleMetaEntry(metaEntryNode.getLocalName(), metaEntryNode.getTextContent());
-		}
-	}
 }

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

@@ -20,10 +20,11 @@
  * @author Markus Michael Geipel
  *
  */
-public abstract class AbstractNamedValuePipeHead implements NamedValuePipeHead{
+public abstract class AbstractNamedValuePipeHead implements NamedValuePipeHead {
+
 	private NamedValueReceiver namedValueReceiver;
 	private NamedValuePipe last = this;
-	
+
 	protected final NamedValueReceiver getNamedValueReceiver() {
 		return namedValueReceiver;
 	}
@@ -33,18 +34,19 @@ public final <R extends NamedValueReceiver> R setNamedValueReceiver(final R rece
 		this.namedValueReceiver = receiver;
 		return receiver;
 	}
-	
+
 	@Override
 	public final void appendPipe(final NamedValuePipe namedValuePipe) {
 		if(last==null){
 			throw new IllegalStateException("NamedValuePipe already finalyzed.");
 		}
 		last = last.setNamedValueReceiver(namedValuePipe);
 	}
-	
+
 	@Override
 	public final void endPipe(final NamedValueReceiver lastReceiver) {
 		last.setNamedValueReceiver(lastReceiver);
 		last = null;
 	}
+
 }

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

@@ -17,26 +17,23 @@
 
 import org.culturegraph.mf.util.StringUtil;
 
-
 /**
  * Implementation of the <code>&lt;data&gt;</code> tag.
- * 
+ *
  * @author Markus Michael Geipel
  */
-final class Data  extends AbstractNamedValuePipeHead{
+final class Data extends AbstractNamedValuePipeHead {
 
 	private String name;
 
-
 	@Override
-	public void receive(final String recName, final String recValue, final NamedValueSource source, final int recordCount, final int entityCount) {
-		getNamedValueReceiver().receive(StringUtil.fallback(name, recName), recValue, this, recordCount, entityCount);
-	}
+	public void receive(final String recName, final String recValue,
+			final NamedValueSource source, final int recordCount,
+			final int entityCount) {
 
-	/**
-	 * @param name
-	 *            the defaultName to set
-	 */
+		getNamedValueReceiver().receive(StringUtil.fallback(name, recName),
+				recValue, this, recordCount, entityCount);
+	}
 
 	public void setName(final String name) {
 		this.name = name;
@@ -46,4 +43,5 @@ public void setName(final String name) {
 	public String toString() {
 		return name;
 	}
+
 }

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

@@ -19,8 +19,13 @@
 
 
 /**
+<<<<<<< HEAD
  * Default error handler used by {@link Metamorph}. Just repackages
  * exceptions as {@link MorphException}s.
+=======
+ * Default error handler used by {@link Metamorph}. Just
+ * repackages exceptions as {@link MorphException}s.
+>>>>>>> Improved code formatting and added documentation.
  *
  * @author Markus Michael Geipel
  *