org.eclipse.emf.validation.debug.ui.view.AbstractNodeLabelProvider.java Source code

Java tutorial

Introduction

Here is the source code for org.eclipse.emf.validation.debug.ui.view.AbstractNodeLabelProvider.java

Source

/**
 * <copyright>
 *
 * Copyright (c) 2013 CEA LIST 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:
 *   E.D.Willink (CEA LIST) - initial API and implementation
 *
 * </copyright>
 */
package org.eclipse.emf.validation.debug.ui.view;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;

import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.TreeIterator;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.edit.ui.provider.ExtendedImageRegistry;
import org.eclipse.emf.validation.debug.validity.AbstractNode;
import org.eclipse.emf.validation.debug.validity.ConstrainingNode;
import org.eclipse.emf.validation.debug.validity.LeafConstrainingNode;
import org.eclipse.emf.validation.debug.validity.Result;
import org.eclipse.emf.validation.debug.validity.ResultConstrainingNode;
import org.eclipse.emf.validation.debug.validity.ResultValidatableNode;
import org.eclipse.emf.validation.debug.validity.Severity;
import org.eclipse.emf.validation.debug.validity.ValidatableNode;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.viewers.ColumnLabelProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.ILabelProviderListener;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.Image;

public class AbstractNodeLabelProvider extends ColumnLabelProvider {
    protected class Summary {
        private int oks = 0;
        private int infos = 0;
        private int warnings = 0;
        private int errors = 0;
        private int fatals = 0;
        private int defaults = 0;

        public void accumulate(@NonNull EObject eObject) {
            Result worstResult = null;
            if (eObject instanceof ResultValidatableNode) {
                worstResult = ((ResultValidatableNode) eObject).getWorstResult();
            } else if (eObject instanceof ResultConstrainingNode) {
                worstResult = ((ResultConstrainingNode) eObject).getWorstResult();
            }
            if (worstResult != null) {
                Severity severity = worstResult.getSeverity();
                switch (severity) {
                case OK:
                    oks++;
                    break;
                case INFO:
                    infos++;
                    break;
                case WARNING:
                    warnings++;
                    break;
                case ERROR:
                    errors++;
                    break;
                case FATAL:
                    fatals++;
                    break;
                default:
                    defaults++;
                    break;
                }
            }
        }

        public @NonNull String toString() {
            String separator = ", "; //"\n";
            StringBuilder s = new StringBuilder();
            s.append(oks + " ok" + (oks != 1 ? "s" : ""));
            if (infos > 0) {
                s.append(separator + infos + " info" + (oks != 1 ? "s" : ""));
            }
            if (warnings > 0) {
                s.append(separator + warnings + " warning" + (warnings != 1 ? "s" : ""));
            }
            if (errors > 0) {
                s.append(separator + errors + " error" + (errors != 1 ? "s" : ""));
            }
            if (fatals > 0) {
                s.append(separator + fatals + " fatal" + (fatals != 1 ? "s" : ""));
            }
            if (defaults > 0) {
                s.append(separator + defaults + " other" + (defaults != 1 ? "s" : ""));
            }
            @SuppressWarnings("null")
            @NonNull
            String string = s.toString();
            return string;
        }
    }

    private final @NonNull ILabelProvider labelProvider;
    private final Color validatableColor;
    private final Color constrainingNodeColor;

    public AbstractNodeLabelProvider(@NonNull ILabelProvider labelProvider, Color validatableColor,
            Color constrainingNodeColor) {
        this.labelProvider = labelProvider;
        this.validatableColor = validatableColor;
        this.constrainingNodeColor = constrainingNodeColor;
    }

    @Override
    public void addListener(ILabelProviderListener listener) {
        labelProvider.addListener(listener);
    }

    protected void appendResourceDiagnostic(@NonNull Writer s, @NonNull Diagnostic diagnostic) {
        try {
            s.append(diagnostic.getMessage());
        } catch (IOException e) {
        }
        for (Diagnostic child : diagnostic.getChildren()) {
            try {
                s.append("\n" + child.getMessage());
            } catch (IOException e) {
            }
        }
    }

    public Color getBackground(Object element) {
        return null;
    }

    public Font getFont(Object element) {
        if (element instanceof ResultConstrainingNode) {
            return null;
        } else if (element instanceof ResultValidatableNode) {
            return JFaceResources.getFontRegistry().getItalic(JFaceResources.DEFAULT_FONT);
        } else if (element instanceof ConstrainingNode) {
            return JFaceResources.getFontRegistry().getItalic(JFaceResources.DEFAULT_FONT);
        } else {
            return null;
        }
    }

    public Color getForeground(Object element) {
        if (element instanceof ResultConstrainingNode) {
            return validatableColor;
        } else if (element instanceof ResultValidatableNode) {
            return constrainingNodeColor;
        } else if (element instanceof ConstrainingNode) {
            return constrainingNodeColor;
        } else {
            return validatableColor;
        }
    }

    @Override
    public Image getImage(Object element) {
        if (element instanceof ResultValidatableNode) {
            ConstrainingNode constrainingNode = ((ResultValidatableNode) element).getResultConstrainingNode()
                    .getParent();
            if (constrainingNode instanceof LeafConstrainingNode) {
                return labelProvider
                        .getImage(((LeafConstrainingNode) constrainingNode).getConstraintLocator().getImage());
            } else {
                return labelProvider.getImage(constrainingNode.getConstrainingObject());
            }
        } else if (element instanceof ResultConstrainingNode) {
            ConstrainingNode constrainingNode = (ConstrainingNode) ((ResultConstrainingNode) element).getParent();
            if (constrainingNode instanceof LeafConstrainingNode) {
                return labelProvider
                        .getImage(((LeafConstrainingNode) constrainingNode).getConstraintLocator().getImage());
            } else {
                return labelProvider.getImage(constrainingNode.getConstrainingObject());
            }
        } else if (element instanceof ConstrainingNode) {
            return labelProvider.getImage(((ConstrainingNode) element).getConstrainingObject());
        } else if (element instanceof ValidatableNode) {
            return labelProvider.getImage(((ValidatableNode) element).getConstrainedObject());
        } else {
            return labelProvider.getImage(element);
        }
    }

    protected @NonNull String getResultToolTip(@Nullable Result result) {
        if (result == null) {
            return "No result available";
        }
        if (result.getSeverity() == Severity.OK) {
            return "Successful";
        }
        StringWriter s = new StringWriter();
        Object diagnostic = result.getDiagnostic();
        if (diagnostic == null) {
            s.append("<<null diagnostic message>>");
        } else if (diagnostic instanceof Diagnostic) {
            appendResourceDiagnostic(s, (Diagnostic) diagnostic);
        } else {
            s.append(String.valueOf(diagnostic));
        }
        Exception exception = result.getException();
        if (exception != null) {
            s.append("\n" + exception.getClass().getName() + ":\n");
            exception.printStackTrace(new PrintWriter(s));
        }
        @SuppressWarnings("null")
        @NonNull
        String string = s.toString();
        return string;
    }

    protected @NonNull String getSummaryToolTip(@NonNull AbstractNode node) {
        Summary summary = new Summary();
        summary.accumulate(node);
        for (TreeIterator<EObject> tit = node.eAllContents(); tit.hasNext();) {
            @SuppressWarnings("null")
            @NonNull
            EObject eObject = tit.next();
            summary.accumulate(eObject);
        }
        return summary.toString();
    }

    @Override
    public String getText(Object element) {
        /*      if (element instanceof ConstrainingNode) {
                 return labelProvider.getText(((ConstrainingNode)element).getConstrainingObject());
              }
              else if (element instanceof ValidatableNode) {
                 return labelProvider.getText(((ValidatableNode)element).getConstrainedObject());
              }
              else {
                 return labelProvider.getText(element);
              } */
        return ((AbstractNode) element).getLabel();
    }

    //   public int getToolTipDisplayDelayTime(Object object) {
    //      return 0;
    //   }

    @Override
    public Image getToolTipImage(Object object) {
        Object severityImage = SeveritiesDecorator.getSeverityImage(object);
        return ExtendedImageRegistry.INSTANCE.getImage(severityImage);
    }

    @Override
    public @Nullable String getToolTipText(Object element) {
        if (element instanceof ResultConstrainingNode) {
            return getResultToolTip(((ResultConstrainingNode) element).getWorstResult());
        } else if (element instanceof ResultValidatableNode) {
            return getResultToolTip(((ResultValidatableNode) element).getWorstResult());
        } else if (element instanceof AbstractNode) {
            return getSummaryToolTip((AbstractNode) element);
        } else {
            return "Unknown";
        }
    }

    public int getToolTipTimeDisplayed(Object object) {
        return 15000;
    }

    @Override
    public boolean isLabelProperty(Object element, String property) {
        if (element instanceof ConstrainingNode) {
            return labelProvider.isLabelProperty(((ConstrainingNode) element).getConstrainingObject(), property);
        } else if (element instanceof ValidatableNode) {
            return labelProvider.isLabelProperty(((ValidatableNode) element).getConstrainedObject(), property);
        } else {
            return labelProvider.isLabelProperty(element, property);
        }
    }

    @Override
    public void removeListener(ILabelProviderListener listener) {
        labelProvider.removeListener(listener);
    }
}