Bugzilla #42956

Second attempt at AFP NOP Extension
Submitted by Adrian Cumiskey <dev.at.cumiskey.com>

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@561757 13f79535-47bb-0310-9956-ffa450edef68

src/java/META-INF/services/org.apache.fop.util.ContentHandlerFactory

@@ -1,2 +1,3 @@
+org.apache.fop.render.afp.extensions.AFPExtensionHandlerFactory
 org.apache.fop.render.ps.extensions.PSExtensionHandlerFactory
-org.apache.fop.fo.extensions.xmp.XMPContentHandlerFactory
+org.apache.fop.fo.extensions.xmp.XMPContentHandlerFactory

src/java/org/apache/fop/render/afp/extensions/AFPExtensionHandler.java

@@ -0,0 +1,115 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+
+/* $Id: $ */
+
+package org.apache.fop.render.afp.extensions;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.fop.util.ContentHandlerFactory;
+import org.apache.fop.util.ContentHandlerFactory.ObjectBuiltListener;
+import org.xml.sax.Attributes;
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
+
+/**
+ * ContentHandler (parser) for restoring AFPExtension objects from XML.
+ */
+public class AFPExtensionHandler extends DefaultHandler 
+            implements ContentHandlerFactory.ObjectSource {
+
+    /** Logger instance */
+    protected static Log log = LogFactory.getLog(AFPExtensionHandler.class);
+
+    private StringBuffer content = new StringBuffer();
+    private Attributes lastAttributes;
+    
+    private AFPPageSetup returnedObject;
+    private ObjectBuiltListener listener;
+    
+    /** {@inheritDoc} */
+    public void startElement(String uri, String localName, String qName, Attributes attributes) 
+                throws SAXException {
+        boolean handled = false;
+        if (AFPPageSetup.CATEGORY.equals(uri)) {
+            lastAttributes = attributes;
+            handled = true;
+            if (localName.equals(AFPElementMapping.NO_OPERATION)
+                    || localName.equals(AFPElementMapping.TAG_LOGICAL_ELEMENT)
+                    || localName.equals(AFPElementMapping.INCLUDE_PAGE_OVERLAY)
+                    || localName.equals(AFPElementMapping.INCLUDE_PAGE_SEGMENT)
+                    || localName.equals(AFPElementMapping.PAGE)
+                    || localName.equals(AFPElementMapping.PAGE_GROUP)) {
+                //handled in endElement
+            } else {
+                handled = false;
+            }
+        }
+        if (!handled) {
+            if (AFPPageSetup.CATEGORY.equals(uri)) {
+                throw new SAXException("Unhandled element " + localName 
+                        + " in namespace: " + uri);
+            } else {
+                log.warn("Unhandled element " + localName 
+                        + " in namespace: " + uri);
+            }
+        }
+    }
+
+    /** {@inheritDoc} */
+    public void endElement(String uri, String localName, String qName) throws SAXException {
+        if (AFPPageSetup.CATEGORY.equals(uri)) {
+            String name = lastAttributes.getValue("name");
+            this.returnedObject = new AFPPageSetup(localName);
+            returnedObject.setName(name);
+            if (content.length() > 0) {
+                returnedObject.setContent(content.toString());
+                content.setLength(0); //Reset text buffer (see characters())
+            }
+        }    
+    }
+
+    /** {@inheritDoc} */
+    public void characters(char[] ch, int start, int length) throws SAXException {
+        content.append(ch, start, length);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public void endDocument() throws SAXException {
+        if (listener != null) {
+            listener.notifyObjectBuilt(getObject());
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public Object getObject() {
+        return returnedObject;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public void setObjectBuiltListener(ObjectBuiltListener listener) {
+        this.listener = listener;
+    }
+
+}

src/java/org/apache/fop/render/afp/extensions/AFPExtensionHandlerFactory.java

@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+
+/* $Id: $ */
+
+package org.apache.fop.render.afp.extensions;
+
+import org.apache.fop.util.ContentHandlerFactory;
+import org.xml.sax.ContentHandler;
+
+/**
+ * Factory for the ContentHandler that handles serialized AFPPageSetup instances.
+ */
+public class AFPExtensionHandlerFactory implements ContentHandlerFactory {
+
+    private static final String[] NAMESPACES = new String[] {AFPPageSetup.CATEGORY};
+    
+    /** {@inheritDoc} */
+    public String[] getSupportedNamespaces() {
+        return NAMESPACES;
+    }
+
+    /** {@inheritDoc} */
+    public ContentHandler createContentHandler() {
+        return new AFPExtensionHandler();
+    }
+}