summaryrefslogtreecommitdiff
path: root/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/ParaNodeIterator.java
diff options
context:
space:
mode:
Diffstat (limited to 'xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/ParaNodeIterator.java')
-rw-r--r--xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/ParaNodeIterator.java90
1 files changed, 90 insertions, 0 deletions
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/ParaNodeIterator.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/ParaNodeIterator.java
new file mode 100644
index 000000000000..2e16275e0e44
--- /dev/null
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/ParaNodeIterator.java
@@ -0,0 +1,90 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+package org.openoffice.xmerge.merger.diff;
+
+import org.w3c.dom.Node;
+
+import org.openoffice.xmerge.ConverterCapabilities;
+import org.openoffice.xmerge.converter.xml.OfficeConstants;
+
+
+/**
+ * <p>This is an implementation of the <code>Iterator</code> interface.
+ * It will traverse the tree and find the Paragraph/Heading <code>Node</code>
+ * sequences.</p>
+ *
+ * <p>Note: Once the XML Tree is parsed, then the <code>Iterator</code> will
+ * be a snap shot of that tree. That means even the tree is modified later,
+ * than the cached paragraph <code>Node</code> list will not be updated
+ * accordingly. For this reason and for performance reasons this
+ * <code>Iterator</code> does not support any operation methods such as
+ * insert, remove or replace. The main purpose of this
+ * <code>Iterator</code> is to be used with difference, not with merge.</p>
+ *
+ * @author smak
+ */
+public final class ParaNodeIterator extends NodeIterator {
+
+ // can be expanded to an array in the future, not necessary right now
+ private static final String SUPPORTED_TAG1 = OfficeConstants.TAG_PARAGRAPH;
+ private static final String SUPPORTED_TAG2 = OfficeConstants.TAG_HEADING;
+
+ /**
+ * Standard constructor.
+ *
+ * @param cc The <code>ConverterCapabilities</code>.
+ * @param node The initial root <code>Node</code>.
+ */
+ public ParaNodeIterator(ConverterCapabilities cc, Node node) {
+ // not using convertercapabilities unless it's needed in future.
+ super(cc, node);
+ }
+
+
+ /**
+ * Overwrite the parent <code>nodeSupported</code> method.
+ *
+ * @param node <code>Node</code> to check.
+ *
+ * @return true if the <code>Node</code> is supported, false
+ * otherwise.
+ */
+ protected boolean nodeSupported(Node node) {
+
+ // can use an array later to check all possible tags for
+ // future expansion
+ if (node.getNodeType() == Node.ELEMENT_NODE &&
+ (node.getNodeName().equals(SUPPORTED_TAG1) ||
+ node.getNodeName().equals(SUPPORTED_TAG2))) {
+ return true;
+ } else {
+ return false;
+ }
+ }
+}
+