Re-structure LTTng sub-project as per the Linux Tools guidelines

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / lttng / ui / model / trange / TimeRangeEventResource.java

/*******************************************************************************\r
 * Copyright (c) 2009 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Alvaro Sanchez-Leon (alvsan09@gmail.com) - Initial API and implementation\r
 *******************************************************************************/\r
package org.eclipse.linuxtools.lttng.ui.model.trange;\r
\r
import org.eclipse.linuxtools.lttng.core.state.model.LttngTraceState;\r
\r
/**\r
 * @author alvaro\r
 * \r
 */\r
public abstract class TimeRangeEventResource extends TimeRangeComposite\r
		implements\r
		Comparable<TimeRangeEventResource> {\r
\r
	// ========================================================================\r
	// Data\r
	// =======================================================================\r
	public static enum ResourceTypes {\r
		UNKNOWN, IRQ, TRAP, SOFT_IRQ, BDEV, CPU\r
	}\r
\r
	private ResourceTypes type = ResourceTypes.UNKNOWN;\r
	private Long resourceId = null;\r
\r
	// ========================================================================\r
	// Constructor\r
	// =======================================================================\r
	/**\r
	 * Constructor<br>\r
	 * \r
	 * @param newId            Id used by the UI\r
	 * @param newStartTime     normally set to the Trace start time\r
	 * @param newStopTime      normally set to the Trace end time\r
	 * @param newName          the name of this resource\r
	 * @param newGroupName     the group name of this resource. Should be same as the traceId\r
	 * @param newClassName     the classname of this resource.\r
	 * @param newType          the type of the resource, as defined in the ResourceTypes enum\r
	 * @param newResourceId    the resourceId, unique id identifying this resource \r
	 * \r
	 */\r
	public TimeRangeEventResource(int newId, long newStartTime,\r
			long newStopTime, String newName, String newGroupName,\r
			String newClassName, ResourceTypes newType, Long newResourceId,\r
			long insertionTime) {\r
\r
		super(newId, newStartTime, newStopTime, newName, newGroupName,\r
				newClassName, CompositeType.RESOURCE, insertionTime);\r
\r
		type = newType;\r
		resourceId = newResourceId;\r
	}\r
\r
	// ========================================================================\r
	// Methods\r
	// =======================================================================\r
\r
	/**\r
	 * Interface to add children to this resource\r
	 * \r
	 * @param newEvent\r
	 */\r
	public void addChildren(TimeRangeEvent newEvent) {\r
		if ((newEvent != null)) {\r
			this.ChildEventLeafs.add(newEvent);\r
		}\r
	}\r
\r
	/**\r
	 * @return\r
	 */\r
	public Long getResourceId() {\r
		return resourceId;\r
	}\r
\r
	/**\r
	 * @param newResId\r
	 */\r
	public void setResourceId(Long newResId) {\r
		this.resourceId = newResId;\r
	}\r
\r
	/**\r
	 * @return\r
	 */\r
	public ResourceTypes getType() {\r
		return type;\r
	}\r
\r
	/**\r
	 * @param type\r
	 */\r
	public void setType(ResourceTypes type) {\r
		this.type = type;\r
	}\r
\r
	/**\r
	 * Getter for traceId.<br>\r
	 * Note : traceId and groupName are the same for EventResource\r
	 * \r
	 * @return String\r
	 */\r
	public String getTraceId() {\r
		return groupName;\r
	}\r
\r
	/**\r
	 * Getter for traceId.<br>\r
	 * Note : traceId and groupName are the same for EventResource\r
	 * \r
	 * @return String\r
	 */\r
	public void setTraceId(String traceId) {\r
		this.groupName = traceId;\r
	}\r
\r
	// @Override\r
	/*\r
	 * (non-Javadoc)\r
	 * \r
	 * @see java.lang.Object#toString()\r
	 */\r
//	@Override\r
//	public String toString() {\r
//		return getResourceId().toString() + ":" + getTraceId().toString() + ":"\r
//				+ getType().toString();\r
//	}\r
\r
    @Override\r
    @SuppressWarnings("nls")\r
    public String toString() {\r
		return "[TimeRangeEventResource: " + super.toString() +\r
		",type=" + type + ",resourceId=" + resourceId + "]";\r
    }\r
\r
    /**\r
	 * Compare function to implement Comparable<br>\r
	 * <br>\r
	 * Compare by traceId THEN IF EQUAL by resourceType THEN IF EQUAL by\r
	 * resourceId\r
	 * \r
	 * @param comparedResource\r
	 *            The resource to compare to\r
	 * \r
	 * @return int 0 if equals, negative number if "smaller", positive if\r
	 *         "bigger".\r
	 */\r
	// @Override\r
	@Override\r
	public int compareTo(TimeRangeEventResource comparedResource) {\r
		int returnedValue = 0;\r
\r
		if (comparedResource != null) {\r
			// Compare by trace id first\r
			returnedValue = this.getTraceId().compareTo(\r
					comparedResource.getTraceId());\r
\r
			// If same, compare by resourceName\r
			if (returnedValue == 0) {\r
				returnedValue = this.getName().compareTo(\r
						comparedResource.getName());\r
\r
				// Finally, if same, compare by ResourceId\r
				if (returnedValue == 0) {\r
					returnedValue = this.getResourceId().compareTo(\r
							comparedResource.getResourceId());\r
				}\r
			}\r
\r
		}\r
\r
		return returnedValue;\r
	}\r
\r
	public abstract String getStateMode(LttngTraceState traceState);\r
}\r