target_explorer/plugins/org.eclipse.tcf.te.tcf.filesystem.core/src/org/eclipse/tcf/te/tcf/filesystem/core/model/AbstractTreeNode.java - tcf/org.eclipse.tcf - Git at Google

 /*******************************************************************************
  * Copyright (c) 2011, 2014 Wind River Systems, Inc. and others. All rights reserved.
  * This program and the accompanying materials are made available under the terms
  * of the Eclipse Public License v1.0 which accompanies this distribution, and is
  * available at http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  * Wind River Systems - initial API and implementation
  *******************************************************************************/
 package org.eclipse.tcf.te.tcf.filesystem.core.model;

 import java.beans.PropertyChangeEvent;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;

 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.PlatformObject;
 import org.eclipse.tcf.te.core.interfaces.IPropertyChangeProvider;
 import org.eclipse.tcf.te.core.interfaces.IViewerInput;
 import org.eclipse.tcf.te.runtime.callback.Callback;
 import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
 import org.eclipse.tcf.te.tcf.core.Tcf;
 import org.eclipse.tcf.te.tcf.core.interfaces.IChannelManager;
 import org.eclipse.tcf.te.tcf.core.interfaces.IChannelManager.DoneOpenChannel;
 import org.eclipse.tcf.te.tcf.filesystem.core.internal.operations.NullOpExecutor;
 import org.eclipse.tcf.te.tcf.filesystem.core.internal.operations.OpUser;
 import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerNode;

 /**
  * The base class of FSTreeNode and ProcessTreeNode which provides base members and methods.
  */
 public abstract class AbstractTreeNode extends PlatformObject {
 	// The unique id of this node.
 	protected final UUID uniqueId = UUID.randomUUID();

 	/**
 	 * The tree node name.
 	 */
 	public String name = null;

 	/**
 	 * The tree node type.
 	 */
 	public String type = null;

 	/**
 	 * The peer node the file system tree node is associated with.
 	 */
 	public IPeerNode peerNode = null;

 	/**
 	 * Flag to mark once the children of the node got queried
 	 */
 	public boolean childrenQueried = false;

 	/**
 	 * Flag to mark once the children query is running
 	 */
 	public boolean childrenQueryRunning = false;

 	/**
 	 * The tree node parent.
 	 */
 	protected AbstractTreeNode parent = null;

 	/**
 	 * The tree node children.
 	 */
 	protected List<AbstractTreeNode> children = Collections.synchronizedList(new ArrayList<AbstractTreeNode>());

 	/*
 	 * (non-Javadoc)
 	 *
 	 * @see java.lang.Object#hashCode()
 	 */
 	@Override
 	public final int hashCode() {
 		return uniqueId.hashCode();
 	}

 	/*
 	 * (non-Javadoc)
 	 *
 	 * @see java.lang.Object#equals(java.lang.Object)
 	 */
 	@Override
 	public final boolean equals(Object obj) {
 		if(this == obj)
 			return true;
 		if (obj instanceof AbstractTreeNode) {
 			return uniqueId.equals(((AbstractTreeNode) obj).uniqueId);
 		}
 		return super.equals(obj);
 	}

 	/*
 	 * (non-Javadoc)
 	 *
 	 * @see java.lang.Object#toString()
 	 */
 	@Override
 	public String toString() {
 		StringBuilder buffer = new StringBuilder(getClass().getSimpleName());
 		buffer.append(": name=" + (name != null ? name : super.toString())); //$NON-NLS-1$
 		buffer.append(", UUID=" + uniqueId.toString()); //$NON-NLS-1$
 		return buffer.toString();
 	}

 	/**
 	 * Called when the children query is done.
 	 */
 	public void queryDone() {
 		childrenQueryRunning = false;
 		childrenQueried = true;
 		PropertyChangeEvent event = new PropertyChangeEvent(this, "query_done", Boolean.FALSE, Boolean.TRUE); //$NON-NLS-1$
 		firePropertyChange(event);
 	}

     /**
      * Called when the children query is started.
      */
     public void queryStarted() {
         childrenQueryRunning = true;
         PropertyChangeEvent event = new PropertyChangeEvent(this, "query_started", Boolean.FALSE, Boolean.TRUE); //$NON-NLS-1$
         firePropertyChange(event);
     }

 	/**
 	 * Get the user account of the specified TCF peer.
 	 *
 	 * @param peerNode The peer node of the TCF agent.
 	 * @return The user account that runs the agent.
 	 */
 	protected UserAccount getUserAccount(IPeerNode peerNode) {
 		OpUser user = new OpUser(peerNode);
 		new NullOpExecutor().execute(user);
 		return user.getUserAccount();
 	}

 	/**
 	 * Fire a property change event to notify one of the node's property has changed.
 	 *
 	 * @param event The property change event.
 	 */
 	public void firePropertyChange(PropertyChangeEvent event) {
 		if(peerNode != null) {
 			IPropertyChangeProvider provider = (IPropertyChangeProvider) peerNode.getAdapter(IPropertyChangeProvider.class);
 			provider.firePropertyChange(event);
 		} else if(parent != null) {
 			parent.firePropertyChange(event);
 		}
     }

 	/**
 	 * Add the specified nodes to the children list.
 	 *
 	 * @param nodes The nodes to be added.
 	 */
 	public void addChidren(List<? extends AbstractTreeNode> nodes) {
 		children.addAll(nodes);
 		PropertyChangeEvent event = new PropertyChangeEvent(this, "addChildren", null, null); //$NON-NLS-1$
 		firePropertyChange(event);
     }

 	/**
 	 * Remove the specified nodes from the children list.
 	 *
 	 * @param nodes The nodes to be removed.
 	 */
 	public void removeChildren(List<? extends AbstractTreeNode> nodes) {
 		children.removeAll(nodes);
 		PropertyChangeEvent event = new PropertyChangeEvent(this, "removeChildren", null, null); //$NON-NLS-1$
 		firePropertyChange(event);
     }

 	/**
 	 * Add the specified the node to the children list.
 	 *
 	 * @param node The child node to be added.
 	 */
 	public void addChild(AbstractTreeNode node) {
 		children.add(node);
 		PropertyChangeEvent event = new PropertyChangeEvent(this, "addChild", null, null); //$NON-NLS-1$
 		firePropertyChange(event);
     }

 	/**
 	 * Remove the specified child node from its children list.
 	 *
 	 * @param node The child node to be removed.
 	 */
 	public void removeChild(AbstractTreeNode node) {
 		children.remove(node);
 		PropertyChangeEvent event = new PropertyChangeEvent(this, "removeChild", null, null); //$NON-NLS-1$
 		firePropertyChange(event);
     }

 	/**
 	 * Clear the children of this folder.
 	 */
 	public void clearChildren() {
 		children.clear();
 		PropertyChangeEvent event = new PropertyChangeEvent(this, "clearChildren", null, null); //$NON-NLS-1$
 		firePropertyChange(event);
     }

 	/**
 	 * If this node is ancestor of the specified node.
 	 * @return true if it is.
 	 */
 	public boolean isAncestorOf(AbstractTreeNode node) {
 		if (node == null) return false;
 		if (node.parent == this) return true;
 		return isAncestorOf(node.parent);
 	}

 	/**
 	 * Get the parent node of this node.
 	 *
 	 * @return The parent node.
 	 */
 	public AbstractTreeNode getParent() {
 		return parent;
 	}

 	/**
 	 * Set the parent node of this node.
 	 *
 	 * @param parent The parent node.
 	 */
 	public void setParent(AbstractTreeNode parent) {
 		this.parent = parent;
 	}

 	/**
 	 * Recursively refresh the children of the given process context.
 	 *
 	 * @param parentNode The process context node. Must not be <code>null</code>.
 	 */
 	public void refresh() {
 		refresh(null);
 	}

 	/*
 	 * (non-Javadoc)
 	 * @see org.eclipse.core.runtime.PlatformObject#getAdapter(java.lang.Class)
 	 */
 	@SuppressWarnings("rawtypes")
     @Override
     public Object getAdapter(Class adapter) {
 		if(IViewerInput.class.equals(adapter)) {
 			return peerNode.getAdapter(IViewerInput.class);
 		}
 		if(IPropertyChangeProvider.class.equals(adapter)) {
 			return peerNode.getAdapter(adapter);
 		}
 	    return super.getAdapter(adapter);
     }

 	/**
 	 * Recursively refresh the children of the given process context with a callback, which is
 	 * called when whole process is finished.
 	 *
 	 * @param callback The callback object, or <code>null</code> when callback is not needed.
 	 */
 	public void refresh(final ICallback callback) {
 		Map<String, Boolean> flags = new HashMap<String, Boolean>();
 		flags.put(IChannelManager.FLAG_NO_PATH_MAP, Boolean.TRUE);
 		Tcf.getChannelManager().openChannel(peerNode.getPeer(), flags, doCreateRefreshDoneOpenChannel(new Callback() {
 		    /* (non-Javadoc)
 		     * @see org.eclipse.tcf.te.runtime.callback.Callback#internalDone(java.lang.Object, org.eclipse.core.runtime.IStatus)
 		     */
 		    @Override
 		    protected void internalDone(Object caller, IStatus status) {
 	            refreshChildren(callback);
 		    }
 		}));
 	}

 	/**
 	 * Create the callback object of opening channel for refreshing itself.
 	 *
 	 * @param callback The callback object.
 	 * @return The callback object.
 	 */
 	protected abstract DoneOpenChannel doCreateRefreshDoneOpenChannel(ICallback callback);

 	/**
 	 * Query the children of this file system node.
 	 */
 	public final void queryChildren() {
 		queryChildren(null);
 	}
 	/**
 	 * Query the children of this file system node.
 	 */
 	public void queryChildren(ICallback callback) {
 		queryStarted();
         Map<String, Boolean> flags = new HashMap<String, Boolean>();
         flags.put(IChannelManager.FLAG_NO_PATH_MAP, Boolean.TRUE);
 		Tcf.getChannelManager().openChannel(peerNode.getPeer(), flags, doCreateQueryDoneOpenChannel(callback));
 	}

 	/**
 	 * Create the callback object of opening channel for querying children.
 	 *
 	 * @return The callback object.
 	 */
 	protected abstract DoneOpenChannel doCreateQueryDoneOpenChannel(ICallback callback);

 	/**
 	 * Return if this node is the system root.
 	 *
 	 * @return true if it is.
 	 */
 	public abstract boolean isSystemRoot();

 	/**
 	 * Get the children of this tree node.
 	 *
 	 * @return The list of the children.
 	 */
 	public List<? extends AbstractTreeNode> getChildren() {
 		return new ArrayList<AbstractTreeNode>(children);
 	}

 	/**
 	 * Refresh the children's children.
 	 */
 	public final void refreshChildren() {
 	    refreshChildren(null);
 	}

 	/**
      * Refresh the children's children.
      */
     public abstract void refreshChildren(ICallback callback);
 }
	/*******************************************************************************
	* Copyright (c) 2011, 2014 Wind River Systems, Inc. and others. All rights reserved.
	* This program and the accompanying materials are made available under the terms
	* of the Eclipse Public License v1.0 which accompanies this distribution, and is
	* available at http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* Wind River Systems - initial API and implementation
	*******************************************************************************/
	package org.eclipse.tcf.te.tcf.filesystem.core.model;

	import java.beans.PropertyChangeEvent;
	import java.util.ArrayList;
	import java.util.Collections;
	import java.util.HashMap;
	import java.util.List;
	import java.util.Map;
	import java.util.UUID;

	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.PlatformObject;
	import org.eclipse.tcf.te.core.interfaces.IPropertyChangeProvider;
	import org.eclipse.tcf.te.core.interfaces.IViewerInput;
	import org.eclipse.tcf.te.runtime.callback.Callback;
	import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
	import org.eclipse.tcf.te.tcf.core.Tcf;
	import org.eclipse.tcf.te.tcf.core.interfaces.IChannelManager;
	import org.eclipse.tcf.te.tcf.core.interfaces.IChannelManager.DoneOpenChannel;
	import org.eclipse.tcf.te.tcf.filesystem.core.internal.operations.NullOpExecutor;
	import org.eclipse.tcf.te.tcf.filesystem.core.internal.operations.OpUser;
	import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerNode;

	/**
	* The base class of FSTreeNode and ProcessTreeNode which provides base members and methods.
	*/
	public abstract class AbstractTreeNode extends PlatformObject {
	// The unique id of this node.
	protected final UUID uniqueId = UUID.randomUUID();

	/**
	* The tree node name.
	*/
	public String name = null;

	/**
	* The tree node type.
	*/
	public String type = null;

	/**
	* The peer node the file system tree node is associated with.
	*/
	public IPeerNode peerNode = null;

	/**
	* Flag to mark once the children of the node got queried
	*/
	public boolean childrenQueried = false;

	/**
	* Flag to mark once the children query is running
	*/
	public boolean childrenQueryRunning = false;

	/**
	* The tree node parent.
	*/
	protected AbstractTreeNode parent = null;

	/**
	* The tree node children.
	*/
	protected List<AbstractTreeNode> children = Collections.synchronizedList(new ArrayList<AbstractTreeNode>());

	/*
	* (non-Javadoc)
	*
	* @see java.lang.Object#hashCode()
	*/
	@Override
	public final int hashCode() {
	return uniqueId.hashCode();
	}

	/*
	* (non-Javadoc)
	*
	* @see java.lang.Object#equals(java.lang.Object)
	*/
	@Override
	public final boolean equals(Object obj) {
	if(this == obj)
	return true;
	if (obj instanceof AbstractTreeNode) {
	return uniqueId.equals(((AbstractTreeNode) obj).uniqueId);
	}
	return super.equals(obj);
	}

	/*
	* (non-Javadoc)
	*
	* @see java.lang.Object#toString()
	*/
	@Override
	public String toString() {
	StringBuilder buffer = new StringBuilder(getClass().getSimpleName());
	buffer.append(": name=" + (name != null ? name : super.toString())); //$NON-NLS-1$
	buffer.append(", UUID=" + uniqueId.toString()); //$NON-NLS-1$
	return buffer.toString();
	}

	/**
	* Called when the children query is done.
	*/
	public void queryDone() {
	childrenQueryRunning = false;
	childrenQueried = true;
	PropertyChangeEvent event = new PropertyChangeEvent(this, "query_done", Boolean.FALSE, Boolean.TRUE); //$NON-NLS-1$
	firePropertyChange(event);
	}

	/**
	* Called when the children query is started.
	*/
	public void queryStarted() {
	childrenQueryRunning = true;
	PropertyChangeEvent event = new PropertyChangeEvent(this, "query_started", Boolean.FALSE, Boolean.TRUE); //$NON-NLS-1$
	firePropertyChange(event);
	}

	/**
	* Get the user account of the specified TCF peer.
	*
	* @param peerNode The peer node of the TCF agent.
	* @return The user account that runs the agent.
	*/
	protected UserAccount getUserAccount(IPeerNode peerNode) {
	OpUser user = new OpUser(peerNode);
	new NullOpExecutor().execute(user);
	return user.getUserAccount();
	}

	/**
	* Fire a property change event to notify one of the node's property has changed.
	*
	* @param event The property change event.
	*/
	public void firePropertyChange(PropertyChangeEvent event) {
	if(peerNode != null) {
	IPropertyChangeProvider provider = (IPropertyChangeProvider) peerNode.getAdapter(IPropertyChangeProvider.class);
	provider.firePropertyChange(event);
	} else if(parent != null) {
	parent.firePropertyChange(event);
	}
	}

	/**
	* Add the specified nodes to the children list.
	*
	* @param nodes The nodes to be added.
	*/
	public void addChidren(List<? extends AbstractTreeNode> nodes) {
	children.addAll(nodes);
	PropertyChangeEvent event = new PropertyChangeEvent(this, "addChildren", null, null); //$NON-NLS-1$
	firePropertyChange(event);
	}

	/**
	* Remove the specified nodes from the children list.
	*
	* @param nodes The nodes to be removed.
	*/
	public void removeChildren(List<? extends AbstractTreeNode> nodes) {
	children.removeAll(nodes);
	PropertyChangeEvent event = new PropertyChangeEvent(this, "removeChildren", null, null); //$NON-NLS-1$
	firePropertyChange(event);
	}

	/**
	* Add the specified the node to the children list.
	*
	* @param node The child node to be added.
	*/
	public void addChild(AbstractTreeNode node) {
	children.add(node);
	PropertyChangeEvent event = new PropertyChangeEvent(this, "addChild", null, null); //$NON-NLS-1$
	firePropertyChange(event);
	}

	/**
	* Remove the specified child node from its children list.
	*
	* @param node The child node to be removed.
	*/
	public void removeChild(AbstractTreeNode node) {
	children.remove(node);
	PropertyChangeEvent event = new PropertyChangeEvent(this, "removeChild", null, null); //$NON-NLS-1$
	firePropertyChange(event);
	}

	/**
	* Clear the children of this folder.
	*/
	public void clearChildren() {
	children.clear();
	PropertyChangeEvent event = new PropertyChangeEvent(this, "clearChildren", null, null); //$NON-NLS-1$
	firePropertyChange(event);
	}

	/**
	* If this node is ancestor of the specified node.
	* @return true if it is.
	*/
	public boolean isAncestorOf(AbstractTreeNode node) {
	if (node == null) return false;
	if (node.parent == this) return true;
	return isAncestorOf(node.parent);
	}

	/**
	* Get the parent node of this node.
	*
	* @return The parent node.
	*/
	public AbstractTreeNode getParent() {
	return parent;
	}

	/**
	* Set the parent node of this node.
	*
	* @param parent The parent node.
	*/
	public void setParent(AbstractTreeNode parent) {
	this.parent = parent;
	}

	/**
	* Recursively refresh the children of the given process context.
	*
	* @param parentNode The process context node. Must not be <code>null</code>.
	*/
	public void refresh() {
	refresh(null);
	}

	/*
	* (non-Javadoc)
	* @see org.eclipse.core.runtime.PlatformObject#getAdapter(java.lang.Class)
	*/
	@SuppressWarnings("rawtypes")
	@Override
	public Object getAdapter(Class adapter) {
	if(IViewerInput.class.equals(adapter)) {
	return peerNode.getAdapter(IViewerInput.class);
	}
	if(IPropertyChangeProvider.class.equals(adapter)) {
	return peerNode.getAdapter(adapter);
	}
	return super.getAdapter(adapter);
	}

	/**
	* Recursively refresh the children of the given process context with a callback, which is
	* called when whole process is finished.
	*
	* @param callback The callback object, or <code>null</code> when callback is not needed.
	*/
	public void refresh(final ICallback callback) {
	Map<String, Boolean> flags = new HashMap<String, Boolean>();
	flags.put(IChannelManager.FLAG_NO_PATH_MAP, Boolean.TRUE);
	Tcf.getChannelManager().openChannel(peerNode.getPeer(), flags, doCreateRefreshDoneOpenChannel(new Callback() {
	/* (non-Javadoc)
	* @see org.eclipse.tcf.te.runtime.callback.Callback#internalDone(java.lang.Object, org.eclipse.core.runtime.IStatus)
	*/
	@Override
	protected void internalDone(Object caller, IStatus status) {
	refreshChildren(callback);
	}
	}));
	}

	/**
	* Create the callback object of opening channel for refreshing itself.
	*
	* @param callback The callback object.
	* @return The callback object.
	*/
	protected abstract DoneOpenChannel doCreateRefreshDoneOpenChannel(ICallback callback);

	/**
	* Query the children of this file system node.
	*/
	public final void queryChildren() {
	queryChildren(null);
	}
	/**
	* Query the children of this file system node.
	*/
	public void queryChildren(ICallback callback) {
	queryStarted();
	Map<String, Boolean> flags = new HashMap<String, Boolean>();
	flags.put(IChannelManager.FLAG_NO_PATH_MAP, Boolean.TRUE);
	Tcf.getChannelManager().openChannel(peerNode.getPeer(), flags, doCreateQueryDoneOpenChannel(callback));
	}

	/**
	* Create the callback object of opening channel for querying children.
	*
	* @return The callback object.
	*/
	protected abstract DoneOpenChannel doCreateQueryDoneOpenChannel(ICallback callback);

	/**
	* Return if this node is the system root.
	*
	* @return true if it is.
	*/
	public abstract boolean isSystemRoot();

	/**
	* Get the children of this tree node.
	*
	* @return The list of the children.
	*/
	public List<? extends AbstractTreeNode> getChildren() {
	return new ArrayList<AbstractTreeNode>(children);
	}

	/**
	* Refresh the children's children.
	*/
	public final void refreshChildren() {
	refreshChildren(null);
	}

	/**
	* Refresh the children's children.
	*/
	public abstract void refreshChildren(ICallback callback);
	}