TreeNode.java

/*
*
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
* This file is part of jAPS software.
* jAPS is a free software; 
* you can redistribute it and/or modify it
* under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; version 2.
* 
* See the file License for the specific language governing permissions   
* and limitations under the License
* 
* 
* 
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
*/
package com.agiletec.aps.system.common.tree;

import java.io.Serializable;

import com.agiletec.aps.util.ApsProperties;

/**
 * A node of a tree. 
 * The node is the basic information a tree and contains all the 
 * minimum information necessary for its definition.
 * @author E.Santoboni
 */
public class TreeNode implements ITreeNode, Serializable {
	
	@Override
	public String getCode() {
		return _code;
	}
	public void setCode(String code) {
		this._code = code;
	}
	
	@Override
	public boolean isRoot() {
		return (null == this.getParent() || this.getCode().equals(this.getParent().getCode()));
	}
	
	@Override
	public ITreeNode getParent() {
		return _parent;
	}
	public void setParent(ITreeNode parent) {
		this._parent = parent;
	}
	
	/**
	 * Return the group code this node belongs to
	 * @return the authorization group
	 */
	@Override
	public String getGroup() {
		return _group;
	}
	
	/**
	 * Set the group code of this node
	 * @param The group to assign this node to
	 */
	public void setGroup(String group) {
		this._group = group;
	}
	
	@Override
	public ITreeNode[] getChildren() {
		return _children;
	}
	public void setChildren(ITreeNode[] children) {
		this._children = children;
	}
	
	/**
	 * Adds a node to nodes in a lower level. 
	 * The new node is inserted in the final position.
	 * @param treeNode The node to add.
	 */
	public void addChild(ITreeNode treeNode) {
		int len = this._children.length;
		ITreeNode[] newChildren = new ITreeNode[len + 1];
		for(int i=0; i < len; i++){
			newChildren[i] = this._children[i];
		}
		newChildren[len] = treeNode;
		this._children = newChildren;
	}
	
	@Override
	public int getPosition() {
		return _position;
	}
	protected void setPosition(int position) {
		this._position = position;
	}
	
	@Override
	public ApsProperties getTitles() {
		return _titles;
	}
	
	/**
	 * Set the titles of the node. 
	 * @param titles A set of properties with the titles, 
	 * where the keys are the codes of language.
	 */
	public void setTitles(ApsProperties titles) {
		this._titles = titles;
	}
	
	@Override
	public void setTitle(String langCode, String title) {
		this.getTitles().setProperty(langCode, title);
	}
	
	@Override
	public String getTitle(String langCode) {
		return this.getTitles().getProperty(langCode);
	}
	
	@Override
	public String getFullTitle(String langCode) {
		return this.getFullTitle(langCode, " / ");
	}
	
	@Override
	public String getFullTitle(String langCode, String separator) {
		return this.getFullTitle(langCode, separator, false);
	}
	
	@Override
	public String getShortFullTitle(String langCode) {
		return this.getShortFullTitle(langCode, " / ");
	}
	
	@Override
	public String getShortFullTitle(String langCode, String separator) {
		return this.getFullTitle(langCode, separator, true);
	}
	
	private String getFullTitle(String langCode, String separator, boolean shortTitle) {
		String title = this.getTitles().getProperty(langCode);
		if (null == title) title = this.getCode();
		if (this.isRoot()) return title;
		ITreeNode parent = this.getParent();
		while (parent != null && parent.getParent() != null) {
			String parentTitle = "..";
			if (!shortTitle) {
				parentTitle = parent.getTitles().getProperty(langCode);
				if (null == parentTitle) parentTitle = parent.getCode();
			}
			title = parentTitle + separator + title;
			if (parent.isRoot()) return title;
			parent = parent.getParent();
		}
		return title;
	}
	
	@Override
	public boolean isChildOf(String nodeCode) {
		return this.isChildOf(this, nodeCode);
	}
	
	private boolean isChildOf(ITreeNode node, String nodeCode) {
		if (node.getCode().equals(nodeCode)) {
			return true;
		} else {
			ITreeNode parent = node.getParent();
			if (parent != null && !parent.getCode().equals(node.getCode())) {
				return this.isChildOf(parent, nodeCode);
			} else {
				return false;
			}
		}
	}
	
	@Override
	public String toString() {
		return "Node: " + this.getCode();
	}
	
	private String _code;
	
	private ITreeNode _parent;
	
	private String _group;
	
	private ITreeNode[] _children = new ITreeNode[0];
	
	private int _position = -1;
	
	private ApsProperties _titles = new ApsProperties();
	
}