/*
* org.openmicroscopy.shoola.agents.util.browser.TreeImageSet
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2010 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.agents.util.browser;
import java.util.Iterator;
/**
* Represents a container in the composite structure used to visualize an
* image hierarchy.
* A <code>TreeImageSet</code> may contain either {@link TreeImageNode}s or
* other {@link TreeImageSet}s, but not both.
*
* @see TreeImageDisplay
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @version 2.2
* <small>
* (<b>Internal version:</b> $Revision: 6430 $ $Date: 2009-06-09 12:09:23 +0100 (Tue, 09 Jun 2009) $)
* </small>
* @since OME2.2
*/
public class TreeImageSet
extends TreeImageDisplay
{
/**
* Tells if the children of this node are {@link TreeImageNode}s.
* This field will be <code>null</code> until the first call to
* {@link #addChildDisplay(TreeImageDisplay)}. In fact, until then
* we can't tell if this node is meant to contain {@link TreeImageNode}s
* or other {@link TreeImageSet}s.
*/
//private Boolean containsImages;
/** Flag to indicate if the children were loaded for that node. */
private Boolean childrenLoaded;
/** Flag indicating that the node hosting the folder is marked. */
private boolean system;
/**
* Implemented as specified by superclass.
* @see TreeImageDisplay#doAccept(TreeImageDisplayVisitor)
*/
protected void doAccept(TreeImageDisplayVisitor visitor)
{
visitor.visit(this);
}
/**
* Marks the node.
*
* @param system Pass <code>true</code> to mark the node,
* <code>false</code> otherwise.
*/
void setSystem(boolean system) { this.system = system; }
/**
* Returns <code>true</code> if the node is marked, <code>false</code>
* otherwise.
*
* @return See above.
*/
public boolean isSystem() { return system; }
/**
* Creates a new container node.
*
* @param hierarchyObject The original object in the image hierarchy which
* is visualized by this node. It has to be an image
* object in this case.
* Never pass <code>null</code>.
*/
public TreeImageSet(Object hierarchyObject)
{
super(hierarchyObject);
childrenLoaded = null;
system = false;
}
/**
* Adds a node to the visualization tree as a child of this node.
* Note that an <code>TreeImageSet</code> may contain either
* {@link TreeImageNode}s or other <code>TreeImageSet</code>s,
* but not both. So if the first node you
* add is an {@link TreeImageNode}, you're constrained to add
* {@link TreeImageNode}s thereafter.
* Failure to comply will buy you a runtime exception.
* The same considerations apply to adding <code>TreeImageSet</code>s.
*
* @param child The node to add. Mustn't be <code>null</code>.
* @see TreeImageDisplay#addChildDisplay(TreeImageDisplay)
*/
public void addChildDisplay(TreeImageDisplay child)
{
if (child == null) throw new NullPointerException("No child.");
super.addChildDisplay(child);
}
/**
* Tells if the children of this node are {@link TreeImageNode}s.
* Note that this method will return <code>false</code> if this is
* an <code>TreeImageSet</code> meant to contain {@link TreeImageNode}s, but
* no node has been added yet.
*
* @return <code>true</code> if there's at least one {@link TreeImageNode}
* child, <code>false</code> otherwise.
* @see TreeImageDisplay#containsImages()
*/
public boolean containsImages()
{
if (childrenDisplay == null || childrenDisplay.size() == 0)
return false;
Iterator<TreeImageDisplay> i = childrenDisplay.iterator();
while (i.hasNext()) {
if (i.next() instanceof TreeImageNode) return true;
}
return false;
}
/**
* Sets the number of items contained in the container hosted
* by this class.
*
* @param value The number of items.
* @see #getNumberItems()
*/
public void setNumberItems(long value) { numberItems = value; }
/**
* Returns the number of items. Should only be called when children aren't
* loaded.
*
* @return See above.
* @see #setNumberItems(long)
*/
public long getNumberItems() { return numberItems; }
/**
* Tells if the children of this node have been loaded.
* The node may not contain children but the children were requested.
* Note that this method will return <code>false</code> if the value of the
* {@link #childrenLoaded} is <code>null</code>.
*
* @return <code>true</code> if the children have been loaded,
* <code>false</code> otherwise.
*/
public boolean isChildrenLoaded()
{
if (childrenLoaded == null) return false;
return childrenLoaded.booleanValue();
}
/**
* Indicates if the children were requested for this node.
*
* @param childrenLoaded The value to set.
*/
public void setChildrenLoaded(Boolean childrenLoaded)
{
this.childrenLoaded = childrenLoaded;
}
/**
* Makes a copy of the node.
* @see TreeImageDisplay#copy()
*/
public TreeImageDisplay copy()
{
TreeImageSet copy = new TreeImageSet(this.getUserObject());
copy.setChildrenLoaded(Boolean.valueOf(this.isChildrenLoaded()));
copy.setNumberItems(this.getNumberItems());
copy.setHighLight(this.getHighLight());
copy.setToolTip(this.getToolTip());
copy.setExpanded(this.isExpanded());
Iterator i = this.getChildrenDisplay().iterator();
while (i.hasNext()) {
copy.addChildDisplay(((TreeImageDisplay) i.next()).copy());
}
return copy;
}
/**
* Returns <code>false</code> b/c an image node cannot have children.
* @see TreeImageDisplay#contains(TreeImageDisplay)
*/
public boolean contains(TreeImageDisplay node)
{
if (node == null) return false;
Iterator i = this.getChildrenDisplay().iterator();
TreeImageDisplay child;
while (i.hasNext()) {
child = (TreeImageDisplay) i.next();
if (child == node) return true;
}
return false;
}
}