Add contrib sub-package

Moves everything under org.metafacture into org.metafacture.contrib

Author: eberhardtj

src/main/java/org/metafacture/contrib/framework/XdmPipe.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2018 Deutsche Nationalbibliothek
+ *
+ * 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.metafacture.contrib.framework;
+
+import org.metafacture.framework.Receiver;
+import org.metafacture.framework.Sender;
+
+public interface XdmPipe<R extends Receiver> extends XdmReceiver, Sender<R> {
+    // Just a combination of sender and receiver
+}

src/main/java/org/metafacture/contrib/framework/XdmReceiver.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2018 Deutsche Nationalbibliothek
+ *
+ * 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.metafacture.contrib.framework;
+
+import net.sf.saxon.s9api.XdmNode;
+import org.metafacture.framework.ObjectReceiver;
+
+public interface XdmReceiver extends ObjectReceiver<XdmNode> {
+    // Just a combination of LifeCycle and the corresponding ObjectReceiver
+}

src/main/java/org/metafacture/contrib/framework/helpers/DefaultXdmPipe.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2018 Deutsche Nationalbibliothek
+ *
+ * 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.metafacture.contrib.framework.helpers;
+
+import net.sf.saxon.s9api.XdmNode;
+import org.metafacture.contrib.framework.XdmPipe;
+import org.metafacture.framework.Receiver;
+import org.metafacture.framework.helpers.DefaultSender;
+
+public class DefaultXdmPipe<R extends Receiver> extends DefaultSender<R> implements XdmPipe<R> {
+
+    public void process(final XdmNode obj) {
+        // Default implementation does nothing
+    }
+}

src/main/java/org/metafacture/contrib/framework/helpers/DefaultXdmReceiver.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2018 Deutsche Nationalbibliothek
+ *
+ * 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.metafacture.contrib.framework.helpers;
+
+import net.sf.saxon.s9api.XdmNode;
+import org.metafacture.framework.ObjectReceiver;
+import org.metafacture.framework.helpers.DefaultLifeCycle;
+
+public class DefaultXdmReceiver extends DefaultLifeCycle implements ObjectReceiver<XdmNode> {
+
+    @Override
+    public void process(final XdmNode obj) {
+        // Default implementation does nothing
+    }
+
+}

src/main/java/org/metafacture/contrib/framework/helpers/ForwardingXdmPipe.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018 Deutsche Nationalbibliothek
+ *
+ * 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.metafacture.contrib.framework.helpers;
+
+import net.sf.saxon.s9api.XdmNode;
+import org.metafacture.contrib.framework.XdmReceiver;
+
+public class ForwardingXdmPipe extends DefaultXdmPipe<XdmReceiver> {
+
+    @Override
+    public void process(XdmNode node) {
+        getReceiver().process(node);
+    }
+}

src/main/java/org/metafacture/contrib/xdm/SaxToXdm.java

@@ -0,0 +1,135 @@
+/*
+ * Copyright 2018 Deutsche Nationalbibliothek
+ *
+ * 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.metafacture.contrib.xdm;
+
+import net.sf.saxon.s9api.*;
+import org.metafacture.contrib.framework.XdmReceiver;
+import org.metafacture.framework.FluxCommand;
+import org.metafacture.framework.MetafactureException;
+import org.metafacture.framework.XmlReceiver;
+import org.metafacture.framework.annotations.Description;
+import org.metafacture.framework.annotations.In;
+import org.metafacture.framework.annotations.Out;
+import org.metafacture.framework.helpers.DefaultXmlPipe;
+import org.xml.sax.Attributes;
+import org.xml.sax.Locator;
+import org.xml.sax.SAXException;
+
+@In(XmlReceiver.class)
+@Out(XdmReceiver.class)
+@Description("Transforms sax documents into xdm nodes.")
+@FluxCommand("sax-to-xdm")
+public class SaxToXdm extends DefaultXmlPipe<XdmReceiver> {
+    private Processor processor;
+    private DocumentBuilder documentBuilder;
+    private BuildingContentHandler buildingContentHandler;
+
+    public SaxToXdm() {
+        this.processor = new Processor(false);
+        this.documentBuilder = processor.newDocumentBuilder();
+        this.buildingContentHandler = newBuildingContentHandler();
+    }
+
+    private BuildingContentHandler newBuildingContentHandler() {
+        try {
+            return documentBuilder.newBuildingContentHandler();
+        } catch (SaxonApiException e) {
+            throw new MetafactureException(e);
+        }
+    }
+
+    @Override
+    public void startDocument() {
+        buildingContentHandler = newBuildingContentHandler();
+
+        try {
+            buildingContentHandler.startDocument();
+        } catch (SAXException e) {
+            throw new MetafactureException(e);
+        }
+    }
+
+    @Override
+    public void endDocument() {
+        try {
+            buildingContentHandler.endDocument();
+            XdmNode node = buildingContentHandler.getDocumentNode();
+            getReceiver().process(node);
+        } catch (SAXException | SaxonApiException e) {
+            throw new MetafactureException(e);
+        }
+    }
+
+    @Override
+    public void startElement(final String uri, final String localName,
+                             final String qName, final Attributes attributes) {
+        try {
+            buildingContentHandler.startElement(uri, localName, qName, attributes);
+        } catch (SAXException e) {
+            throw new MetafactureException(e);
+        }
+    }
+
+    @Override
+    public void endElement(String uri, String localName, String qName) {
+        try {
+            buildingContentHandler.endElement(uri, localName, qName);
+        } catch (SAXException e) {
+            throw new MetafactureException(e);
+        }
+    }
+
+    @Override
+    public void characters(char[] ch, int start, int length) {
+        try {
+            buildingContentHandler.characters(ch, start, length);
+        } catch (SAXException e) {
+            throw new MetafactureException(e);
+        }
+    }
+
+    @Override
+    public void ignorableWhitespace(final char[] ch, final int start, final int length) throws SAXException {
+        buildingContentHandler.ignorableWhitespace(ch, start, length);
+    }
+
+    @Override
+    public void processingInstruction(final String target, final String data) throws SAXException {
+        buildingContentHandler.processingInstruction(target, data);
+    }
+
+    @Override
+    public void skippedEntity(String name) throws SAXException {
+        buildingContentHandler.skippedEntity(name);
+    }
+
+    @Override
+    public void setDocumentLocator(final Locator locator) {
+        buildingContentHandler.setDocumentLocator(locator);
+    }
+
+    @Override
+    public void startPrefixMapping(final String prefix, final String uri) throws SAXException {
+        buildingContentHandler.startPrefixMapping(prefix, uri);
+    }
+
+    @Override
+    public void endPrefixMapping(final String prefix) throws SAXException {
+        buildingContentHandler.endPrefixMapping(prefix);
+    }
+
+
+}

src/main/java/org/metafacture/contrib/xdm/XdmToSax.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2018 Deutsche Nationalbibliothek
+ *
+ * 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.metafacture.contrib.xdm;
+
+import net.sf.saxon.s9api.Processor;
+import net.sf.saxon.s9api.SAXDestination;
+import net.sf.saxon.s9api.SaxonApiException;
+import net.sf.saxon.s9api.XdmNode;
+import org.metafacture.contrib.framework.XdmReceiver;
+import org.metafacture.contrib.framework.helpers.DefaultXdmPipe;
+import org.metafacture.contrib.xdm.helper.XmlFilterAdapter;
+import org.metafacture.framework.FluxCommand;
+import org.metafacture.framework.MetafactureException;
+import org.metafacture.framework.XmlReceiver;
+import org.metafacture.framework.annotations.Description;
+import org.metafacture.framework.annotations.In;
+import org.metafacture.framework.annotations.Out;
+
+@In(XdmReceiver.class)
+@Out(XmlReceiver.class)
+@Description("Transforms xdm nodes into sax documents.")
+@FluxCommand("xdm-to-sax")
+public class XdmToSax extends DefaultXdmPipe<XmlReceiver> {
+    private Processor processor;
+    private SAXDestination destination;
+
+    public XdmToSax() {
+        this.processor = new Processor(false);
+    }
+
+    @Override
+    public void process(XdmNode node) {
+        try {
+            processor.writeXdmValue(node, destination);
+        } catch (SaxonApiException e) {
+            throw new MetafactureException(e);
+        }
+    }
+
+    @Override
+    public void onSetReceiver() {
+        this.destination = new SAXDestination(new XmlFilterAdapter(getReceiver()));
+    }
+}