UiModelEvent.java

/*******************************************************************************
 * Copyright (c) 2008 Red Hat, Inc.
 * 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:
 *    Kent Sebastian <ksebasti@redhat.com> - initial API and implementation
 *******************************************************************************/
package org.eclipse.linuxtools.oprofile.ui.model;

import org.eclipse.linuxtools.internal.oprofile.core.model.OpModelEvent;
import org.eclipse.linuxtools.internal.oprofile.core.model.OpModelImage;
import org.eclipse.linuxtools.internal.oprofile.ui.OprofileUiPlugin;
import org.eclipse.swt.graphics.Image;

/**
 * Top level elements displayed in the view -- events that oprofile
 *  has profiled. Must have children sessions.
 * @since 1.1
 */
public class UiModelEvent implements IUiModelElement {
    private IUiModelElement parent = null;        //parent node -- necessary?
    private OpModelEvent event;                //the node in the data model

    private UiModelImage image;            //this node's child
    private UiModelDependent dependent;    //dependent images of the OpModelImage

    public UiModelEvent(IUiModelElement parent, OpModelEvent event) {
        this.parent = parent;
        this.event = event;
        this.image = null;
        this.dependent = null;
        refreshModel();
    }

    /**
     * Create the ui sessions from the data model.
     */
    private void refreshModel() {
        OpModelImage dataModelImage = event.getImage();
        if (dataModelImage != null) {
            image = new UiModelImage(this, dataModelImage, dataModelImage.getCount(), dataModelImage.getDepCount());

            if (dataModelImage.hasDependents()) {
                dependent = new UiModelDependent(this, dataModelImage.getDependents(), dataModelImage.getCount(), dataModelImage.getDepCount());
            }
        }
    }

    @Override
    public String toString() {
        return (event == null ? "" : event.getName()); //$NON-NLS-1$
    }

    /** IUiModelElement functions **/
    @Override
    public String getLabelText() {
        return toString();
    }

    /**
     * Returns the children of this element.
     * @return An array of child elements or null
     */
    @Override
    public IUiModelElement[] getChildren() {
        if (dependent != null) {
            return new IUiModelElement[] {image, dependent};
        } else {
            return new IUiModelElement[] {image};
        }
    }

    /**
     * Returns if the element has any children.
     * @return true if the element has children, false otherwise
     */
    @Override
    public boolean hasChildren() {
        return (image != null);
    }

    /**
     * Returns the element's parent.
     * @return parent The parent element or null
     */
    @Override
    public IUiModelElement getParent() {
        return parent;
    }

    /**
     * Returns the Image to display next to the text in the tree viewer.
     * @return an Image object of the icon
     */
    @Override
    public Image getLabelImage() {
        return OprofileUiPlugin.getImageDescriptor(OprofileUiPlugin.EVENT_ICON).createImage();
    }
}