edu.tum.in.bruegge.epd.emfstore.handler.merge.util.DecisionUtil.java Source code

Introduction

Here is the source code for edu.tum.in.bruegge.epd.emfstore.handler.merge.util.DecisionUtil.java

Source

/*******************************************************************************
 * Copyright (c) 2008-2011 Chair for Applied Software Engineering,
 * Technische Universitaet Muenchen.
 * 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:
 ******************************************************************************/
package edu.tum.in.bruegge.epd.emfstore.handler.merge.util;

import java.util.List;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.edit.provider.ComposedAdapterFactory;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryLabelProvider;
import org.eclipse.jface.resource.FontRegistry;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;

import edu.tum.in.bruegge.epd.emfstore.handler.merge.conflict.Conflict;
import edu.tum.in.bruegge.epd.emfstore.handler.merge.conflict.ConflictOption;
import edu.tum.in.bruegge.epd.emfstore.handler.merge.conflict.ConflictOption.OptionType;
import edu.tum.in.bruegge.epd.emfstorehelper.Activator;

/**
 * Class offering common methods for the merge dialog.
 * 
 * @author wesendon
 */
public final class DecisionUtil {

    private DecisionUtil() {
    }

    private static FontRegistry fontRegistry;

    /**
     * Fetches image by path.
     * 
     * @param path path
     * @return image
     */
    public static Image getImage(String path) {
        return getImageDescriptor(path).createImage();
    }

    /**
     * Fetches image descriptor by path.
     * 
     * @param path path
     * @return {@link ImageDescriptor}
     */
    public static ImageDescriptor getImageDescriptor(String path) {
        final String key = path;
        ImageDescriptor regImage = JFaceResources.getImageRegistry().getDescriptor(key);
        if (regImage == null) {
            regImage = Activator.getImageDescriptor("icons/merge/" + path);
            JFaceResources.getImageRegistry().put(key, regImage);
        }
        return regImage;
    }

    /**
     * Cuts a text to certain length and adds "..." at the end if needed.
     * 
     * @param str text
     * @param length length
     * @param addPoints true, if ending dotts
     * @return shortened string
     */
    public static String cutString(String str, int length, boolean addPoints) {
        if (str == null) {
            return "";
        }
        if (str.length() > length) {
            str = str.substring(0, length);
            if (addPoints) {
                str += "...";
            }
            return str;
        } else {
            return str;
        }
    }

    /**
     * Strips line breaking characters from text.
     * 
     * @param text text
     * @return linf of text
     */
    public static String stripNewLine(String text) {
        if (text == null) {
            return "";
        }
        return text.replaceAll("\n\r|\r\n|\n \r|\r \n|\n|\r", " ");
    }

    /**
     * Returns label provider.
     * 
     * @return provider
     */
    public static AdapterFactoryLabelProvider getLabelProvider() {
        AdapterFactoryLabelProvider provider = new AdapterFactoryLabelProvider(
                new ComposedAdapterFactory(ComposedAdapterFactory.Descriptor.Registry.INSTANCE));
        return provider;
    }

    /**
     * Returns FontRegistry.
     * 
     * @return fonts
     */
    public static FontRegistry getFontRegistry() {
        if (fontRegistry == null) {
            fontRegistry = new FontRegistry(Display.getCurrent());
            DecisionConfig.initFonts(fontRegistry);
        }
        return fontRegistry;
    }

    /**
     * Get Option by is type.
     * 
     * @param options list of options
     * @param type type
     * @return resulting option or null
     */
    public static ConflictOption getConflictOptionByType(List<ConflictOption> options, OptionType type) {
        for (ConflictOption option : options) {
            if (option.getType().equals(type)) {
                return option;
            }
        }
        return null;
    }

    /**
     * Checks whether a conflict needs details.
     * 
     * @param conflict conflict
     * @return true, if so
     */
    public static boolean detailsNeeded(Conflict conflict) {
        if (!conflict.hasDetails()) {
            return false;
        }
        for (ConflictOption option : conflict.getOptions()) {
            if (!option.isDetailsProvider()) {
                continue;
            }
            if (option.getDetailProvider().startsWith(DecisionConfig.WIDGET_MULTILINE)) {
                if (option.getOptionLabel().length() > DecisionConfig.OPTION_LENGTH) {
                    return true;
                }
            } else {
                return true;
            }
        }
        return false;
    }

    /**
     * Uses the object's toString method or returns unset string.
     * 
     * @param obj obj to string
     * @param unset unset string
     * @return obj.toString or unset
     */
    public static String getLabel(Object obj, String unset) {
        return (obj != null && obj.toString().length() > 1) ? obj.toString() : unset;
    }

    /**
     * Returns Class and Name of {@link EObject}.
     * 
     * @param modelElement modelelement
     * @return string
     */
    public static String getClassAndName(EObject modelElement) {
        if (modelElement == null) {
            return "";
        }
        String name = getAdapterFactory().getText(modelElement);
        return modelElement.eClass().getName() + " \"" + name + "\"";
    }

    /**
     * Returns label provider.
     * 
     * @return label proivder
     */
    public static AdapterFactoryLabelProvider getAdapterFactory() {
        AdapterFactoryLabelProvider adapterFactoryLabelProvider = new AdapterFactoryLabelProvider(
                new ComposedAdapterFactory(ComposedAdapterFactory.Descriptor.Registry.INSTANCE));
        return adapterFactoryLabelProvider;
    }
}