/*
 * $RCSfile: JSElement.java,v $
 *
 * Copyright 2002
 * CH-1700 Fribourg, Switzerland
 * All rights reserved.
 *
 *========================================================================
 * Modifications history
 *========================================================================
 * $Log: not supported by cvs2svn $
 * Revision 1.1  2004/09/02 18:14:39  jsurfer
 * intial source from ttp://www.sf.net/projects/wdte
 *
 * Revision 1.2  2004/02/27 18:28:10  cell
 * Make model elements platform objects so they are automatically adapted
 *
 * Revision 1.1  2004/02/26 02:25:42  agfitzp
 * renamed packages to match xml & css
 *
 * Revision 1.1  2004/02/05 03:10:08  agfitzp
 * Initial Submission
 *
 * Revision 1.1.2.1  2003/12/12 21:37:24  agfitzp
 * Experimental work for Classes view
 *
 * Revision 1.2  2003/05/30 20:53:08  agfitzp
 * 0.0.2 : Outlining is now done as the user types. Some other bug fixes.
 *
 * Revision 1.1  2003/05/28 15:17:12  agfitzp
 * net.sourceforge.phpeclipse.js.core 0.0.1 code base
 *
 *========================================================================
*/

package net.sourceforge.phpeclipse.js.core.model;

import java.util.LinkedList;
import java.util.List;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.PlatformObject;

/**
 * DOCUMENT ME!
 * 
 * @author Addi 
 */
abstract public class JSElement extends PlatformObject
	implements JSElementCategories
{
	protected IFile file;
	protected String name;
	protected int offset;
	protected int numberOfLines;
	protected int length;

	protected JSElement parent;
	protected List children;

	/**
	 * Creates a new JSElement and stores parent element and location in the text.
	 * 
	 * @param aName text corresponding to the func
	 * @param offset  the offset into the text
	 * @param length  the length of the element
	 */
	public JSElement(IFile aFile, String aName, int offset, int length)
	{
		this.file = aFile;
		this.name = aName;
		this.offset = offset;
		this.length = length;
		this.children = new LinkedList();
	}

	/**
	 * Method declared on IWorkbenchAdapter
	 * @param o
	 * 
	 * @return
	 */
	public String getLabel(Object o)
	{
		return name;
	}

	/**
	 * Returns the number of characters in this section.
	 * @return
	 */
	public int getLength()
	{
		return length;
	}

	/**
	 * Returns the number of lines in the element.
	 * 
	 * @return the number of lines in the element
	 */
	public int getNumberOfLines()
	{
		return numberOfLines;
	}

	/**
	 * Returns the offset of this section in the file.
	 * @return
	 */
	public int getStart()
	{
		return offset;
	}

	/**
	 * Sets the number of lines in the element
	 * 
	 * @param newNumberOfLines  the number of lines in the element
	 */
	public void setNumberOfLines(int newNumberOfLines)
	{
		numberOfLines = newNumberOfLines;
	}

	/**
	 * @see java.lang.Object#toString()
	 */
	public String toString()
	{
		return getLabel(this);
	}

	/**
	 * @see org.eclipse.ui.model.IWorkbenchAdapter#getChildren(Object)
	 */
	public Object[] getChildren(Object o)
	{
		Object[] result = new Object[children.size()];
		return children.toArray(result);
	}

	/**
	 * @see org.eclipse.ui.model.IWorkbenchAdapter#getParent(Object)
	 */
	public Object getParent(Object o)
	{
		return null;
	}
	
	/**
	 * 
	 * @return A category enumeration for sub-types.
	 */
	abstract public int category();

	/**
	 * @return
	 */
	public String getName()
	{
		return name;
	}

	/**
	 * @return
	 */
	public int getOffset()
	{
		return offset;
	}

	/**
	 * @return
	 */
	public JSElement getParent()
	{
		return parent;
	}

	/**
	 * @param element
	 */
	protected void setParent(JSElement element)
	{
		parent = element;
	}

	/**
	 * @param anElement
	 * @return
	 */
	public boolean sharesParentWith(JSElement anElement)
	{
		if(parent == null) {
			return anElement.getParent() == null;
		}
		
		return parent.equals(anElement.getParent());
	}

	/**
	 * @param anElement
	 * @return
	 */
	public boolean equals(JSElement anElement)
	{
		return sharesParentWith(anElement) && name.equals(anElement.getName());
	}

	/**
	 * @return Returns the file.
	 */
	public IFile getFile() {
		return file;
	}

	/**
	 * @param file The file to set.
	 */
	protected void setFile(IFile file) {
		this.file = file;
	}

}