Framework: Move standard exceptions into framework

Metafacture should provide a basic exception hierarchy for modules that
covers common errors. For a start the existing exceptions are added to
the framework. These are `MetafactureException`, `FormatException` and
`MissingIdException`.

src/main/java/org/culturegraph/mf/exceptions/FluxParseException.java

@@ -15,6 +15,8 @@
  */
 package org.culturegraph.mf.exceptions;
 
+import org.culturegraph.mf.framework.MetafactureException;
+
 /**
  * @author Markus Michael Geipel
  *

src/main/java/org/culturegraph/mf/exceptions/MorphDefException.java

@@ -15,6 +15,7 @@
  */
 package org.culturegraph.mf.exceptions;
 
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.morph.MorphBuilder;
 
 

src/main/java/org/culturegraph/mf/exceptions/MorphException.java

@@ -15,6 +15,7 @@
  */
 package org.culturegraph.mf.exceptions;
 
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.morph.Metamorph;
 
 

src/main/java/org/culturegraph/mf/formeta/parser/FormetaParser.java

@@ -15,7 +15,7 @@
  */
 package org.culturegraph.mf.formeta.parser;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.util.StringUtil;
 
 /**

src/main/java/org/culturegraph/mf/formeta/parser/FullRecordEmitter.java

@@ -15,7 +15,7 @@
  */
 package org.culturegraph.mf.formeta.parser;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.framework.StreamReceiver;
 
 /**

src/main/java/org/culturegraph/mf/formeta/parser/StructureParserState.java

@@ -15,7 +15,7 @@
  */
 package org.culturegraph.mf.formeta.parser;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.formeta.Formeta;
 
 /**

src/main/java/org/culturegraph/mf/formeta/parser/TextParserContext.java

@@ -15,7 +15,7 @@
  */
 package org.culturegraph.mf.formeta.parser;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.formeta.Formeta;
 
 /**

src/main/java/org/culturegraph/mf/formeta/parser/TextParserState.java

@@ -15,7 +15,7 @@
  */
 package org.culturegraph.mf.formeta.parser;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.formeta.Formeta;
 
 /**

src/main/java/org/culturegraph/mf/exceptions/FormatException.java → src/main/java/org/culturegraph/mf/framework/FormatException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Deutsche Nationalbibliothek
+ * Copyright 2016 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.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.exceptions;
+package org.culturegraph.mf.framework;
 
 /**
  * Thrown if data processing fails due to a format error in the data.

src/main/java/org/culturegraph/mf/exceptions/MetafactureException.java → src/main/java/org/culturegraph/mf/framework/MetafactureException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Deutsche Nationalbibliothek
+ * Copyright 2016 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.
@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.exceptions;
+package org.culturegraph.mf.framework;
 
 /**
- * Base class for exceptions thrown by Metastream.
+ * Base class for exceptions thrown by Metafacture.
  *
- * @author Christoph Böhme <c.boehme@dnb.de>
+ * @author Christoph Böhme
  */
 public class MetafactureException extends RuntimeException {
 

src/main/java/org/culturegraph/mf/stream/converter/bib/MissingIdException.java → src/main/java/org/culturegraph/mf/framework/MissingIdException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Deutsche Nationalbibliothek
+ * Copyright 2016 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.
@@ -13,12 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.converter.bib;
-
-import org.culturegraph.mf.exceptions.MetafactureException;
+package org.culturegraph.mf.framework;
 
 /**
- * Thrown by {@link Reader}s if a record has no ID
+ * Thrown if a record has no id.
  *
  * @author Markus Michael Geipel
  *

src/main/java/org/culturegraph/mf/iso2709/DirectoryBuilder.java

@@ -19,7 +19,7 @@
 import static org.culturegraph.mf.iso2709.Iso2709Constants.MAX_PAYLOAD_LENGTH;
 import static org.culturegraph.mf.iso2709.Iso2709Constants.TAG_LENGTH;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 
 /**
  * Builds a directory in ISO2709:2008 format. For fields whose length is greater

src/main/java/org/culturegraph/mf/iso2709/FieldsBuilder.java

@@ -22,7 +22,7 @@
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 
 /**
  * Builds a list of fields in ISO 2709:2008 format.

src/main/java/org/culturegraph/mf/iso2709/Iso646ByteBuffer.java

@@ -17,7 +17,7 @@
 
 import java.nio.charset.Charset;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 
 /**
  * Provides methods for reading and writing strings and integers in a byte

src/main/java/org/culturegraph/mf/iso2709/Record.java

@@ -23,7 +23,7 @@
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.util.Require;
 
 /**

src/main/java/org/culturegraph/mf/iso2709/RecordBuilder.java

@@ -25,7 +25,7 @@
 import java.util.Arrays;
 import java.util.regex.Pattern;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.util.Require;
 
 /**

src/main/java/org/culturegraph/mf/morph/functions/Occurrence.java

@@ -18,7 +18,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.util.StringUtil;
 
 /**

src/main/java/org/culturegraph/mf/stream/converter/BeaconReader.java

@@ -23,7 +23,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/converter/FormetaRecordsReader.java

@@ -18,7 +18,7 @@
 import java.io.IOException;
 import java.io.Reader;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.formeta.Formeta;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;

src/main/java/org/culturegraph/mf/stream/converter/IllegalEncodingException.java

@@ -15,7 +15,7 @@
  */
 package org.culturegraph.mf.stream.converter;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 
 /**
  * Thrown by {@link Reader}s if a record indicates unsupported encoding.

src/main/java/org/culturegraph/mf/stream/converter/JsonEncoder.java

@@ -19,7 +19,7 @@
 import java.io.StringWriter;
 
 import org.apache.commons.lang.StringEscapeUtils;
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultStreamPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.StreamReceiver;

src/main/java/org/culturegraph/mf/stream/converter/LineReader.java

@@ -19,7 +19,7 @@
 import java.io.IOException;
 import java.io.Reader;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/converter/PojoDecoder.java

@@ -27,7 +27,7 @@
 import java.util.Map;
 import java.util.Map.Entry;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/converter/PojoEncoder.java

@@ -16,7 +16,7 @@
 import java.util.List;
 import java.util.Map;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultStreamPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.StreamReceiver;

src/main/java/org/culturegraph/mf/stream/converter/RecordReader.java

@@ -18,7 +18,7 @@
 import java.io.IOException;
 import java.io.Reader;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/converter/bib/MabDecoder.java

@@ -17,7 +17,8 @@
 
 import java.util.regex.Pattern;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
+import org.culturegraph.mf.framework.MissingIdException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/converter/bib/Marc21Decoder.java

@@ -34,7 +34,8 @@
 import static org.culturegraph.mf.stream.converter.bib.Marc21Constants.TYPE_OF_CONTROL_INDEX;
 import static org.culturegraph.mf.stream.converter.bib.Marc21EventNames.TYPE_OF_CONTROL_LITERAL;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
+import org.culturegraph.mf.framework.MissingIdException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/converter/bib/Marc21Encoder.java

@@ -46,7 +46,7 @@
 
 import java.util.Arrays;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.framework.helpers.DefaultStreamPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.StreamReceiver;

src/main/java/org/culturegraph/mf/stream/converter/bib/PicaDecoder.java

@@ -23,6 +23,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.culturegraph.mf.framework.MissingIdException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/converter/bib/PicaEncoder.java

@@ -20,7 +20,8 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
+import org.culturegraph.mf.framework.MissingIdException;
 import org.culturegraph.mf.framework.helpers.DefaultStreamPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.StreamReceiver;

src/main/java/org/culturegraph/mf/stream/converter/xml/CGXmlHandler.java

@@ -16,7 +16,7 @@
  */
 package org.culturegraph.mf.stream.converter.xml;
 
-import org.culturegraph.mf.exceptions.FormatException;
+import org.culturegraph.mf.framework.FormatException;
 import org.culturegraph.mf.framework.helpers.DefaultXmlPipe;
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.framework.XmlReceiver;

src/main/java/org/culturegraph/mf/stream/converter/xml/GenericXmlHandler.java

@@ -17,7 +17,7 @@
 
 import java.util.regex.Pattern;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultXmlPipe;
 import org.culturegraph.mf.framework.StreamReceiver;
 import org.culturegraph.mf.framework.XmlReceiver;

src/main/java/org/culturegraph/mf/stream/converter/xml/XmlDecoder.java

@@ -18,7 +18,7 @@
 import java.io.IOException;
 import java.io.Reader;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.XmlReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/pipe/FileDigestCalculator.java

@@ -21,7 +21,7 @@
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/pipe/JScriptObjectPipe.java

@@ -22,7 +22,7 @@
 import javax.script.ScriptEngineManager;
 import javax.script.ScriptException;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/pipe/TripleObjectRetriever.java

@@ -23,7 +23,7 @@
 import java.nio.charset.StandardCharsets;
 
 import org.apache.commons.io.IOUtils;
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.annotations.Description;

src/main/java/org/culturegraph/mf/stream/pipe/sort/AbstractTripleSort.java

@@ -25,7 +25,7 @@
 import java.util.List;
 import java.util.PriorityQueue;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
 import org.culturegraph.mf.framework.ObjectReceiver;
 import org.culturegraph.mf.framework.objects.Triple;

src/main/java/org/culturegraph/mf/stream/pipe/sort/SortedTripleFileFacade.java

@@ -22,7 +22,7 @@
 import java.io.IOException;
 import java.io.ObjectInputStream;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.objects.Triple;
 
 

src/main/java/org/culturegraph/mf/stream/sink/ObjectFileWriter.java

@@ -23,7 +23,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.FluxCommand;
 import org.culturegraph.mf.framework.annotations.In;
 import org.culturegraph.mf.util.FileCompression;

src/main/java/org/culturegraph/mf/stream/sink/ObjectJavaIoWriter.java

@@ -18,7 +18,7 @@
 import java.io.IOException;
 import java.io.Writer;
 
-import org.culturegraph.mf.exceptions.MetafactureException;
+import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.ObjectReceiver;
 
 /**