/* ======================================================================
The Bodington System Software License, Version 1.0
  
Copyright (c) 2001 The University of Leeds.  All rights reserved.
  
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1.  Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES 
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO 
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR 
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
=========================================================

This software was originally created by the University of Leeds and may contain voluntary 
contributions from others.  For more information on the Bodington Open Source Project, please 
see http://bodington.org/

====================================================================== */

package org.bodington.server.ims;

import org.apache.log4j.Logger;

import javax.swing.tree.*;
import java.awt.datatransfer.*;
import java.io.*;
import org.w3c.dom.*;


// instatiated for "unknown" types of node in an IMS package
// but mainly used as subclass for the interesting ones.
public class 
PackageNode extends javax.swing.tree.DefaultMutableTreeNode
	implements Transferable
	{
    private static Logger log = Logger.getLogger(PackageNode.class);
   org.w3c.dom.Node dom_node;
	Package ims_package;
	
	public static final DataFlavor packageNodeFlavor
		= new DataFlavor( 
			DataFlavor.javaJVMLocalObjectMimeType, 
			"Reference to a node in a DOM representation of an IMS package" );
		
		
	public PackageNode( Package p, org.w3c.dom.Node n )
		throws ImsException
		{
		ims_package = p;
		setDomNode( n );
		}

	public void insert( MutableTreeNode child, int index )
		{
		canAdd( child );
		
		TreeNode old_parent = child.getParent();
		int old_index=0;
		if ( old_parent!=null )
			old_index = old_parent.getIndex( child );
			
		PackageNode node = (PackageNode)child;
		int[] n = new int[1];
		n[0] = index;
		
		super.insert( node, index );
		if ( node.dom_node.getParentNode() == null )
			{
			log.debug( "Call to insert in " + this.toString() );
			log.debug( "Inserting node as child of " + this.dom_node );
			log.debug( "Inserting node at index " + index );
			
			Node sibling=null;
			Element element;
			int i=0;
			for ( sibling = this.dom_node.getFirstChild(); sibling!=null; sibling = sibling.getNextSibling() )
				{
				if ( sibling instanceof Element )
					{
					element = (Element)sibling;
					if ( element.getTagName().equals( "item" ) )
						{
						if ( i==index )
							break;
						i++;
						}
					}
				}
				
			if ( sibling == null )
				this.dom_node.appendChild( node.dom_node );
			else
				{
				log.debug( "Inserting node before " + sibling.toString() );
				this.dom_node.insertBefore( node.dom_node, sibling );
				}
			}
			
		ims_package.nodesWereInserted( this, n );
		
		if ( old_parent != null )
			{
			//ims_package.nodeStructureChanged( old_parent );
			n[0] = old_index;
			Object[] o = new Object[1];
			o[0] = child;
			ims_package.nodesWereRemoved( old_parent, n, o );
			}
		}
		
	public void remove(MutableTreeNode aChild)
		{
		log.debug( "removing node" );
		super.remove( aChild );
		if ( aChild instanceof PackageNode )
			{
			PackageNode node = (PackageNode)aChild;
			dom_node.removeChild( node.dom_node );
			}
		}
    
	public void canAdd( MutableTreeNode child )
		{
		throw new IllegalStateException( "This node cannot accept additional nodes." );
		}


	public boolean canDrop( PackageNode other )
		{
		return false;
		}
		
	public void drop( PackageNode other, int index )
		throws ImsException
		{
		// do nothing by default
		}

	public org.w3c.dom.Node getDomNode()
		throws ImsException
		{
		return dom_node;
		}

	public void setDomNode( org.w3c.dom.Node n )
		throws ImsException
		{
		if ( dom_node!=null )
			throw new ImsException( "This PackageNode already has a document node assigned." );
		dom_node = n;
		}

	public String toString()
		{
		if ( dom_node instanceof Element )
			return ((Element)dom_node).getTagName();
			
		return dom_node.toString();
		}
		
	public Object getTransferData( DataFlavor flavor )
		throws UnsupportedFlavorException, IOException
		{
		if ( flavor != packageNodeFlavor )
			throw new UnsupportedFlavorException( flavor );
		return this;
		}
		
	public DataFlavor[] getTransferDataFlavors()
		{
		DataFlavor[] list = new DataFlavor[1];
		list[0] = packageNodeFlavor;
		return list;
		}
	
	public boolean isDataFlavorSupported( DataFlavor flavor )
		{
		return flavor == packageNodeFlavor;
		}
	}