Create io package

cboehme · cboehme · commit ca7c607ddfa1 · 2016-12-25T08:36:14.000+01:00
The `io` package contains modules for reading and writing data.
diff --git a/src/main/java/org/culturegraph/mf/flux/parser/Flow.java b/src/main/java/org/culturegraph/mf/flux/parser/Flow.java
@@ -26,7 +26,7 @@
 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;
+import org.culturegraph.mf.io.StdInOpener;
 
 
 /**
diff --git a/src/main/java/org/culturegraph/mf/io/AbstractObjectWriter.java b/src/main/java/org/culturegraph/mf/io/AbstractObjectWriter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Christoph Böhme
+ * 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.stream.sink;
+package org.culturegraph.mf.io;
 
 /**
  * Common functions for object writers.
diff --git a/src/main/java/org/culturegraph/mf/io/ConfigurableObjectWriter.java b/src/main/java/org/culturegraph/mf/io/ConfigurableObjectWriter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Christoph Böhme
+ * 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,10 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import org.culturegraph.mf.framework.ObjectReceiver;
-import org.culturegraph.mf.util.FileCompression;
 
 /**
  * Back end implementations for {@link ObjectWriter} should offer
diff --git a/src/main/java/org/culturegraph/mf/io/FileCompression.java b/src/main/java/org/culturegraph/mf/io/FileCompression.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.util;
+package org.culturegraph.mf.io;
 
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
diff --git a/src/main/java/org/culturegraph/mf/io/FileOpener.java b/src/main/java/org/culturegraph/mf/io/FileOpener.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.source;
+package org.culturegraph.mf.io;
 
 import java.io.FileInputStream;
 import java.io.IOException;
@@ -29,7 +29,6 @@
 import org.culturegraph.mf.framework.annotations.In;
 import org.culturegraph.mf.framework.annotations.Out;
 import org.culturegraph.mf.framework.helpers.DefaultObjectPipe;
-import org.culturegraph.mf.util.FileCompression;
 
 
 /**
diff --git a/src/main/java/org/culturegraph/mf/io/HttpOpener.java b/src/main/java/org/culturegraph/mf/io/HttpOpener.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.source;
+package org.culturegraph.mf.io;
 
 import java.io.IOException;
 import java.io.InputStreamReader;
diff --git a/src/main/java/org/culturegraph/mf/io/IoWriterFactory.java b/src/main/java/org/culturegraph/mf/io/IoWriterFactory.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import java.io.Writer;
 
diff --git a/src/main/java/org/culturegraph/mf/io/LineReader.java b/src/main/java/org/culturegraph/mf/io/LineReader.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.converter;
+package org.culturegraph.mf.io;
 
 import java.io.BufferedReader;
 import java.io.IOException;
diff --git a/src/main/java/org/culturegraph/mf/io/ObjectFileWriter.java b/src/main/java/org/culturegraph/mf/io/ObjectFileWriter.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -26,7 +26,6 @@
 import org.culturegraph.mf.framework.FluxCommand;
 import org.culturegraph.mf.framework.MetafactureException;
 import org.culturegraph.mf.framework.annotations.In;
-import org.culturegraph.mf.util.FileCompression;
 
 /**
  * @param <T>
diff --git a/src/main/java/org/culturegraph/mf/io/ObjectJavaIoWriter.java b/src/main/java/org/culturegraph/mf/io/ObjectJavaIoWriter.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import java.io.IOException;
 import java.io.Writer;
diff --git a/src/main/java/org/culturegraph/mf/io/ObjectStdoutWriter.java b/src/main/java/org/culturegraph/mf/io/ObjectStdoutWriter.java
@@ -13,14 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import java.nio.charset.Charset;
 
 import org.culturegraph.mf.framework.FluxCommand;
 import org.culturegraph.mf.framework.annotations.Description;
 import org.culturegraph.mf.framework.annotations.In;
-import org.culturegraph.mf.util.FileCompression;
 
 /**
  * @param <T> object type
diff --git a/src/main/java/org/culturegraph/mf/io/ObjectWriter.java b/src/main/java/org/culturegraph/mf/io/ObjectWriter.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import java.util.Arrays;
 import java.util.Collection;
@@ -25,7 +25,6 @@
 import org.culturegraph.mf.framework.annotations.In;
 import org.culturegraph.mf.framework.annotations.Out;
 import org.culturegraph.mf.framework.annotations.ReturnsAvailableArguments;
-import org.culturegraph.mf.util.FileCompression;
 
 
 /**
diff --git a/src/main/java/org/culturegraph/mf/io/RecordReader.java b/src/main/java/org/culturegraph/mf/io/RecordReader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Christoph Böhme
+ * 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.stream.converter;
+package org.culturegraph.mf.io;
 
 import java.io.IOException;
 import java.io.Reader;
diff --git a/src/main/java/org/culturegraph/mf/io/ResourceOpener.java b/src/main/java/org/culturegraph/mf/io/ResourceOpener.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.source;
+package org.culturegraph.mf.io;
 
 import java.io.Reader;
 
diff --git a/src/main/java/org/culturegraph/mf/io/StdInOpener.java b/src/main/java/org/culturegraph/mf/io/StdInOpener.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.source;
+package org.culturegraph.mf.io;
 
 import java.io.BufferedReader;
 import java.io.InputStreamReader;
diff --git a/src/main/java/org/culturegraph/mf/io/TarReader.java b/src/main/java/org/culturegraph/mf/io/TarReader.java
@@ -1,20 +1,19 @@
 /*
- * Copyright 2013 hbz, Pascal Christoph
- * Copyright 3016 Christoph Böhme
+ * 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.
- *  You may obtain a copy of the License at
+ * 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
+ *     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.
+ * 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.stream.source;
+package org.culturegraph.mf.io;
 
 import java.io.IOException;
 import java.io.InputStream;
diff --git a/src/main/java/org/culturegraph/mf/test/reader/PicaReader.java b/src/main/java/org/culturegraph/mf/test/reader/PicaReader.java
@@ -15,7 +15,7 @@
  */
 package org.culturegraph.mf.test.reader;
 
-import org.culturegraph.mf.stream.converter.LineReader;
+import org.culturegraph.mf.io.LineReader;
 import org.culturegraph.mf.stream.converter.bib.pica.PicaDecoder;
 
 /**
diff --git a/src/main/resources/flux-commands.properties b/src/main/resources/flux-commands.properties
@@ -15,10 +15,10 @@
 #
 
 # Sources:
-open-file org.culturegraph.mf.stream.source.FileOpener
-open-http org.culturegraph.mf.stream.source.HttpOpener
-open-resource org.culturegraph.mf.stream.source.ResourceOpener
-open-tar org.culturegraph.mf.stream.source.TarReader
+open-file org.culturegraph.mf.io.FileOpener
+open-http org.culturegraph.mf.io.HttpOpener
+open-resource org.culturegraph.mf.io.ResourceOpener
+open-tar org.culturegraph.mf.io.TarReader
 
 read-string org.culturegraph.mf.strings.StringReader
 read-dir	org.culturegraph.mf.files.DirReader
@@ -36,8 +36,8 @@ calculate-metrics org.culturegraph.mf.stream.pipe.stat.CooccurrenceMetricCalcula
 
 jscript org.culturegraph.mf.scripting.JScriptObjectPipe
 
-as-lines	org.culturegraph.mf.stream.converter.LineReader
-as-records	org.culturegraph.mf.stream.converter.RecordReader
+as-lines	org.culturegraph.mf.io.LineReader
+as-records	org.culturegraph.mf.io.RecordReader
 as-formeta-records	org.culturegraph.mf.formeta.FormetaRecordsReader
 # Decoders:
 decode-aseq org.culturegraph.mf.stream.converter.bib.AseqDecoder
@@ -69,12 +69,12 @@ encode-marc21 org.culturegraph.mf.stream.converter.bib.Marc21Encoder
 to-jdom-document org.culturegraph.mf.stream.converter.StreamToJDomDocument
 from-jdom-document org.culturegraph.mf.stream.converter.JDomDocumentToStream
 
-write	org.culturegraph.mf.stream.sink.ObjectWriter
+write	org.culturegraph.mf.io.ObjectWriter
 write-triples	org.culturegraph.mf.stream.sink.TripleWriter
 write-triple-objects org.culturegraph.mf.stream.sink.TripleObjectWriter
 write-xml-files org.culturegraph.mf.stream.sink.XmlFilenameWriter
-write-files org.culturegraph.mf.stream.sink.ObjectFileWriter
-print org.culturegraph.mf.stream.sink.ObjectStdoutWriter
+write-files org.culturegraph.mf.io.ObjectFileWriter
+print org.culturegraph.mf.io.ObjectStdoutWriter
 
 log-stream	org.culturegraph.mf.stream.pipe.StreamLogger
 log-object	org.culturegraph.mf.stream.pipe.ObjectLogger
diff --git a/src/test/java/org/culturegraph/mf/io/AbstractConfigurableObjectWriterTest.java b/src/test/java/org/culturegraph/mf/io/AbstractConfigurableObjectWriterTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Christoph Böhme
+ * 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.stream.sink;
+package org.culturegraph.mf.io;
 
 import static org.junit.Assert.assertEquals;
 
diff --git a/src/test/java/org/culturegraph/mf/io/FileOpenerCompressionTest.java b/src/test/java/org/culturegraph/mf/io/FileOpenerCompressionTest.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.source;
+package org.culturegraph.mf.io;
 
 import static org.junit.Assert.assertEquals;
 import static org.mockito.Mockito.verify;
@@ -28,7 +28,6 @@
 
 import org.culturegraph.mf.commons.ResourceUtil;
 import org.culturegraph.mf.framework.ObjectReceiver;
-import org.culturegraph.mf.util.FileCompression;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
diff --git a/src/test/java/org/culturegraph/mf/io/FileOpenerTest.java b/src/test/java/org/culturegraph/mf/io/FileOpenerTest.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.source;
+package org.culturegraph.mf.io;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assume.assumeFalse;
diff --git a/src/test/java/org/culturegraph/mf/io/ObjectFileWriterCompressionTest.java b/src/test/java/org/culturegraph/mf/io/ObjectFileWriterCompressionTest.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import static org.junit.Assert.assertArrayEquals;
 
@@ -22,7 +22,6 @@
 import java.nio.file.Files;
 import java.util.Arrays;
 
-import org.culturegraph.mf.util.FileCompression;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.TemporaryFolder;
diff --git a/src/test/java/org/culturegraph/mf/io/ObjectFileWriterTest.java b/src/test/java/org/culturegraph/mf/io/ObjectFileWriterTest.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.culturegraph.mf.stream.sink;
+package org.culturegraph.mf.io;
 
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assume.assumeFalse;
diff --git a/src/test/java/org/culturegraph/mf/io/ObjectStdoutWriterTest.java b/src/test/java/org/culturegraph/mf/io/ObjectStdoutWriterTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Christoph Böhme
+ * 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.stream.sink;
+package org.culturegraph.mf.io;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
diff --git a/src/test/java/org/culturegraph/mf/io/RecordReaderTest.java b/src/test/java/org/culturegraph/mf/io/RecordReaderTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Christoph Böhme
+ * 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.stream.converter;
+package org.culturegraph.mf.io;
 
 import static org.mockito.Mockito.inOrder;
 import static org.mockito.Mockito.times;
@@ -23,6 +23,7 @@
 import java.io.StringReader;
 
 import org.culturegraph.mf.framework.ObjectReceiver;
+import org.culturegraph.mf.io.RecordReader;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
diff --git a/src/test/resources/org/culturegraph/mf/io/compressed.txt b/src/test/resources/org/culturegraph/mf/io/compressed.txt
diff --git a/src/test/resources/org/culturegraph/mf/io/compressed.txt.bz2 b/src/test/resources/org/culturegraph/mf/io/compressed.txt.bz2
diff --git a/src/test/resources/org/culturegraph/mf/io/compressed.txt.bzip2 b/src/test/resources/org/culturegraph/mf/io/compressed.txt.bzip2
diff --git a/src/test/resources/org/culturegraph/mf/io/compressed.txt.gz b/src/test/resources/org/culturegraph/mf/io/compressed.txt.gz
diff --git a/src/test/resources/org/culturegraph/mf/io/compressed.txt.gzip b/src/test/resources/org/culturegraph/mf/io/compressed.txt.gzip
diff --git a/src/test/resources/org/culturegraph/mf/io/compressed.txt.xz b/src/test/resources/org/culturegraph/mf/io/compressed.txt.xz
