[4932] | 1 | /**
|
---|
| 2 | *#########################################################################
|
---|
| 3 | *
|
---|
| 4 | * A component of the Gatherer application, part of the Greenstone digital
|
---|
| 5 | * library suite from the New Zealand Digital Library Project at the
|
---|
| 6 | * University of Waikato, New Zealand.
|
---|
| 7 | *
|
---|
| 8 | * Author: John Thompson, Greenstone Digital Library, University of Waikato
|
---|
| 9 | *
|
---|
| 10 | * Copyright (C) 1999 New Zealand Digital Library Project
|
---|
| 11 | *
|
---|
| 12 | * This program is free software; you can redistribute it and/or modify
|
---|
| 13 | * it under the terms of the GNU General Public License as published by
|
---|
| 14 | * the Free Software Foundation; either version 2 of the License, or
|
---|
| 15 | * (at your option) any later version.
|
---|
| 16 | *
|
---|
| 17 | * This program is distributed in the hope that it will be useful,
|
---|
| 18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 20 | * GNU General Public License for more details.
|
---|
| 21 | *
|
---|
| 22 | * You should have received a copy of the GNU General Public License
|
---|
| 23 | * along with this program; if not, write to the Free Software
|
---|
| 24 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
| 25 | *########################################################################
|
---|
| 26 | */
|
---|
| 27 | package org.greenstone.gatherer.cdm;
|
---|
| 28 |
|
---|
| 29 | import java.util.*;
|
---|
| 30 | import javax.swing.*;
|
---|
[8845] | 31 | import org.greenstone.gatherer.DebugStream;
|
---|
[4932] | 32 | import org.w3c.dom.*;
|
---|
| 33 |
|
---|
| 34 | /** This class provides ListModel like access to a list of nodes within a DOM model.
|
---|
| 35 | * @author John Thompson, Greenstone Digital Library, University of Waikato
|
---|
| 36 | * @version 2.3d
|
---|
| 37 | */
|
---|
| 38 | public class DOMProxyListModel
|
---|
| 39 | extends AbstractListModel {
|
---|
| 40 | protected Element root;
|
---|
| 41 | private DOMProxyListEntry class_type;
|
---|
| 42 | private HashMap cache = new HashMap();
|
---|
| 43 | private NodeList children = null;
|
---|
| 44 | private String tag_name;
|
---|
| 45 |
|
---|
| 46 | /** Constructor.
|
---|
| 47 | * @param root the Element at the root of the subtree to be searched for appropriate child elements
|
---|
| 48 | * @param tag_name the name of appropriate elements as a String
|
---|
| 49 | * @param class_type the type of object to wrap the elements returned in, as a DOMProxyListEntry
|
---|
| 50 | */
|
---|
| 51 | public DOMProxyListModel(Element root, String tag_name, DOMProxyListEntry class_type) {
|
---|
| 52 | this.class_type = class_type;
|
---|
| 53 | this.root = root;
|
---|
| 54 | this.tag_name = tag_name;
|
---|
[8380] | 55 | this.children = this.root.getElementsByTagName(this.tag_name);
|
---|
[4932] | 56 | }
|
---|
| 57 |
|
---|
| 58 | /** Used to add an element into the underlying dom, and fire the appropriate repaint events. This version always adds the new element at the very head of the DOM. */
|
---|
| 59 | public synchronized void add(DOMProxyListEntry entry) {
|
---|
| 60 | Element element = entry.getElement();
|
---|
| 61 | if(root.hasChildNodes()) {
|
---|
| 62 | Node sibling = root.getFirstChild();
|
---|
| 63 | root.insertBefore(element, sibling);
|
---|
| 64 | sibling = null;
|
---|
| 65 | }
|
---|
| 66 | else {
|
---|
| 67 | root.appendChild(element);
|
---|
| 68 | }
|
---|
| 69 | element = null;
|
---|
| 70 | // Regardless fire update event
|
---|
| 71 | cache.clear();
|
---|
| 72 | fireIntervalAdded(this, 0, 0);
|
---|
| 73 | }
|
---|
| 74 |
|
---|
| 75 | /** Used to add an element into the underlying dom, and fire the appropriate repaint events.
|
---|
| 76 | * @param index the index where the element should be inserted (relative of the other elements in this proxy list)
|
---|
[6770] | 77 | * @param entry the <strong>DOMProxyListEntry</strong> to be inserted
|
---|
[4932] | 78 | */
|
---|
| 79 | public synchronized void add(int index, DOMProxyListEntry entry) {
|
---|
| 80 | ///atherer.println("Add entry at " + index + " where size = " + getSize());
|
---|
| 81 | Element element = entry.getElement();
|
---|
| 82 | // retrieve the node where we want to insert
|
---|
| 83 | if(index < children.getLength()) {
|
---|
| 84 | Node sibling = children.item(index);
|
---|
| 85 | // Find the parent node
|
---|
| 86 | Node parent_node = sibling.getParentNode();
|
---|
| 87 | parent_node.insertBefore(element, sibling);
|
---|
| 88 | sibling = null;
|
---|
| 89 | }
|
---|
| 90 | // If the index is too large, we are adding to the end of our list of entries. However you have to remember that this list is only a viewport on the entire DOM so there might be entries following this group that we actually want to insert before (not append at the very end!)
|
---|
| 91 | else {
|
---|
| 92 | // Retrieve the currently last entry
|
---|
[5037] | 93 | index = children.getLength() - 1;
|
---|
| 94 | Node sibling = null;
|
---|
| 95 | Node parent_node = null;
|
---|
| 96 | if(index >= 0) {
|
---|
| 97 | sibling = children.item(index);
|
---|
| 98 | parent_node = sibling.getParentNode();
|
---|
| 99 | sibling = sibling.getNextSibling();
|
---|
| 100 | }
|
---|
| 101 | if(sibling != null && parent_node != null) {
|
---|
[4932] | 102 | parent_node.insertBefore(element, sibling);
|
---|
| 103 | }
|
---|
| 104 | // Add to the root node
|
---|
| 105 | else {
|
---|
[5037] | 106 | index = 0;
|
---|
[4932] | 107 | root.appendChild(element);
|
---|
| 108 | }
|
---|
| 109 | }
|
---|
| 110 | // Regardless fire update event
|
---|
| 111 | cache.clear();
|
---|
| 112 | fireIntervalAdded(this, index, index);
|
---|
| 113 | }
|
---|
| 114 |
|
---|
| 115 | /** Used to add an element into the underlying dom, and fire the appropriate repaint events. This version inserts the new entry immediately -after- the given entry in the DOM.
|
---|
| 116 | * @param entry the DOMProxyListEntry to be inserted
|
---|
[9158] | 117 | * @param preceeding_entry the DOMProxyListEntry immediately before where we want the new entry
|
---|
[4932] | 118 | */
|
---|
[9158] | 119 | public synchronized void addAfter(DOMProxyListEntry entry, DOMProxyListEntry preceeding_entry) {
|
---|
[4932] | 120 | Element element = entry.getElement();
|
---|
[9158] | 121 | Element preceeding_sibling = preceeding_entry.getElement();
|
---|
| 122 | Node parent_node = preceeding_sibling.getParentNode();
|
---|
| 123 | Node following_sibling = preceeding_sibling.getNextSibling();
|
---|
[4932] | 124 | if(following_sibling != null) {
|
---|
| 125 | parent_node.insertBefore(element, following_sibling);
|
---|
| 126 | }
|
---|
| 127 | else {
|
---|
| 128 | parent_node.appendChild(element);
|
---|
| 129 | }
|
---|
| 130 | // Regardless fire update event
|
---|
| 131 | cache.clear();
|
---|
[9158] | 132 | int index = indexOf(entry);
|
---|
[4932] | 133 | fireIntervalAdded(this, index, index);
|
---|
| 134 | }
|
---|
| 135 |
|
---|
| 136 | /** Used to add an element into the underlying dom, and fire the appropriate repaint events. This version inserts the new entry immediately -before- the given entry in the DOM.
|
---|
| 137 | * @param entry the DOMProxyListEntry to be inserted
|
---|
| 138 | * @param following_entry the DOMProxyListEntry immediately after where we want the new entry
|
---|
| 139 | */
|
---|
| 140 | public synchronized void addBefore(DOMProxyListEntry entry, DOMProxyListEntry following_entry) {
|
---|
| 141 | Element element = entry.getElement();
|
---|
| 142 | Element following_sibling = following_entry.getElement();
|
---|
| 143 | Node parent_node = following_sibling.getParentNode();
|
---|
| 144 | parent_node.insertBefore(element, following_sibling);
|
---|
| 145 | // Regardless fire update event
|
---|
| 146 | cache.clear();
|
---|
| 147 | int index = indexOf(entry);
|
---|
| 148 | fireIntervalAdded(this, index, index);
|
---|
| 149 | }
|
---|
| 150 |
|
---|
| 151 | public synchronized void add(Node parent, DOMProxyListEntry entry, Node sibling) {
|
---|
| 152 | Element child = entry.getElement();
|
---|
| 153 | if(sibling != null) {
|
---|
| 154 | parent.insertBefore(child, sibling);
|
---|
| 155 | }
|
---|
| 156 | else {
|
---|
| 157 | parent.appendChild(child);
|
---|
| 158 | }
|
---|
| 159 | cache.clear();
|
---|
| 160 | int index = indexOf(entry);
|
---|
| 161 | fireIntervalAdded(this, index, index);
|
---|
| 162 | }
|
---|
| 163 |
|
---|
[5756] | 164 | /** Used to add an element into the underlying dom, and fire the appropriate repaint events. This version always adds the new element at the end of the children. */
|
---|
| 165 | public synchronized void append(DOMProxyListEntry entry) {
|
---|
| 166 | Element element = entry.getElement();
|
---|
| 167 | root.appendChild(element);
|
---|
| 168 | element = null;
|
---|
| 169 | // Regardless fire update event
|
---|
| 170 | cache.clear();
|
---|
| 171 | fireIntervalAdded(this, 0, 0);
|
---|
| 172 | }
|
---|
| 173 |
|
---|
[4932] | 174 | public synchronized ArrayList children() {
|
---|
| 175 | ArrayList child_list = new ArrayList();
|
---|
| 176 | int child_count = children.getLength();
|
---|
| 177 | for(int i = 0; i < child_count; i++) {
|
---|
[5207] | 178 | child_list.add(getElementAt(i));
|
---|
[4932] | 179 | }
|
---|
| 180 | return child_list;
|
---|
| 181 | }
|
---|
| 182 |
|
---|
[4967] | 183 | public synchronized boolean contains(Object entry) {
|
---|
[4932] | 184 | boolean found = false;
|
---|
| 185 | int size = getSize();
|
---|
| 186 | for(int i = 0; !found && i < size; i++) {
|
---|
| 187 | DOMProxyListEntry sibling = (DOMProxyListEntry) getElementAt(i);
|
---|
| 188 | if(sibling.equals(entry)) {
|
---|
| 189 | found = true;
|
---|
| 190 | }
|
---|
| 191 | }
|
---|
| 192 | return found;
|
---|
| 193 | }
|
---|
| 194 |
|
---|
[8844] | 195 | public synchronized Object getElementAt(int index)
|
---|
| 196 | {
|
---|
[4932] | 197 | Object object = cache.get(new Integer(index));
|
---|
[8844] | 198 | if (object != null) {
|
---|
| 199 | return object;
|
---|
[4932] | 200 | }
|
---|
[8844] | 201 |
|
---|
| 202 | // Retrieve the required element
|
---|
| 203 | Element element = (Element) children.item(index);
|
---|
| 204 | DebugStream.println("Element at index " + index + " not in cache: " + element);
|
---|
| 205 |
|
---|
| 206 | // Now wrap it in the object of the users choice
|
---|
| 207 | object = class_type.create(element);
|
---|
| 208 | cache.put(new Integer(index), object);
|
---|
[4932] | 209 | return object;
|
---|
| 210 | }
|
---|
| 211 |
|
---|
| 212 | public synchronized int indexOf(DOMProxyListEntry entry) {
|
---|
| 213 | Element element = entry.getElement();
|
---|
| 214 | int children_length = children.getLength();
|
---|
| 215 | for(int i = 0; i < children_length; i++) {
|
---|
| 216 | Node node = children.item(i);
|
---|
| 217 | if(element == node) {
|
---|
| 218 | return i;
|
---|
| 219 | }
|
---|
| 220 | }
|
---|
| 221 | return -1;
|
---|
| 222 | }
|
---|
| 223 |
|
---|
| 224 | public synchronized int getSize() {
|
---|
| 225 | if(children == null) {
|
---|
| 226 | children = root.getElementsByTagName(tag_name);
|
---|
| 227 | }
|
---|
| 228 | return children.getLength();
|
---|
| 229 | }
|
---|
| 230 |
|
---|
| 231 | public synchronized void refresh() {
|
---|
| 232 | fireContentsChanged(this, 0, getSize());
|
---|
| 233 | }
|
---|
| 234 |
|
---|
| 235 | public synchronized void refresh(DOMProxyListEntry entry) {
|
---|
| 236 | int index = indexOf(entry);
|
---|
| 237 | fireContentsChanged(this, index, index);
|
---|
| 238 | }
|
---|
| 239 |
|
---|
| 240 | public synchronized void remove(DOMProxyListEntry entry) {
|
---|
| 241 | remove(indexOf(entry));
|
---|
| 242 | }
|
---|
| 243 |
|
---|
| 244 | public synchronized void remove(int index) {
|
---|
| 245 | // Retrieve the required element
|
---|
| 246 | Node node = children.item(index);
|
---|
| 247 | // Find its parent
|
---|
| 248 | Node parent_node = node.getParentNode();
|
---|
| 249 | // Now remove it
|
---|
| 250 | parent_node.removeChild(node);
|
---|
| 251 | // Refresh model
|
---|
| 252 | cache.clear();
|
---|
| 253 | fireIntervalRemoved(this, index, index);
|
---|
| 254 | }
|
---|
[4967] | 255 |
|
---|
| 256 | /** Changes the 'root' element that this list sources its information from.
|
---|
| 257 | * @param root the new root Element
|
---|
| 258 | */
|
---|
| 259 | public synchronized void setRoot(Element root) {
|
---|
| 260 | this.children = null;
|
---|
[5080] | 261 | cache.clear();
|
---|
[4967] | 262 | this.root = root;
|
---|
[8380] | 263 | this.children = this.root.getElementsByTagName(this.tag_name);
|
---|
[4967] | 264 | }
|
---|
[12084] | 265 |
|
---|
| 266 | public synchronized void setAssigned(boolean assigned) {
|
---|
| 267 | if (assigned) {
|
---|
| 268 | root.setAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE, CollectionConfiguration.TRUE_STR);
|
---|
| 269 | }
|
---|
| 270 | else {
|
---|
| 271 | root.setAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE, CollectionConfiguration.FALSE_STR);
|
---|
| 272 | }
|
---|
| 273 | }
|
---|
| 274 |
|
---|
| 275 | public boolean isAssigned() {
|
---|
| 276 | return (root.getAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE).equals("") || root.getAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE).equals(CollectionConfiguration.TRUE_STR));
|
---|
| 277 | }
|
---|
[4932] | 278 | }
|
---|