AbstractModel.java

package name.abuchen.portfolio.ui.dialogs.transactions;

import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.math.BigDecimal;

import org.eclipse.core.databinding.validation.ValidationStatus;
import org.eclipse.core.runtime.IStatus;

import name.abuchen.portfolio.money.ExchangeRateProviderFactory;
import name.abuchen.portfolio.money.Values;

public abstract class AbstractModel
{
    private PropertyChangeSupport propertyChangeSupport = new PropertyChangeSupport(this);
    private ExchangeRateProviderFactory factory;

    public abstract String getHeading();

    /**
     * Creates or updates the underlying transaction.
     */
    public abstract void applyChanges();

    /**
     * Resets the model so that a new transaction can be entered.
     */
    public abstract void resetToNewTransaction();

    public IStatus getCalculationStatus()
    {
        return ValidationStatus.ok();
    }

    public void addPropertyChangeListener(PropertyChangeListener listener)
    {
        propertyChangeSupport.addPropertyChangeListener(listener);
    }

    public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
    {
        propertyChangeSupport.addPropertyChangeListener(propertyName, listener);
    }

    public void removePropertyChangeListener(PropertyChangeListener listener)
    {
        propertyChangeSupport.removePropertyChangeListener(listener);
    }

    protected void firePropertyChange(String attribute, Object oldValue, Object newValue)
    {
        propertyChangeSupport.firePropertyChange(attribute, oldValue, newValue);
    }

    protected void firePropertyChange(String attribute, long oldValue, long newValue)
    {
        propertyChangeSupport.firePropertyChange(attribute, oldValue, newValue);
    }

    public void setExchangeRateProviderFactory(ExchangeRateProviderFactory factory)
    {
        this.factory = factory;
    }

    public ExchangeRateProviderFactory getExchangeRateProviderFactory()
    {
        return factory;
    }

    /**
     * Creates a tool tip text that includes exchange rate plus inverse exchange
     * rate for informational purposes.
     */
    /* package */ static String createCurrencyToolTip(BigDecimal exchangeRate, String term, String base)
    {
        BigDecimal inverseRate = BigDecimal.ONE.divide(exchangeRate, 10, BigDecimal.ROUND_HALF_DOWN);

        StringBuilder tooltip = new StringBuilder();
        tooltip.append(Values.ExchangeRate.format(exchangeRate)) //
                        .append(" ").append(term).append("/").append(base).append("\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
        tooltip.append(Values.ExchangeRate.format(inverseRate)) //
                        .append(" ").append(base).append("/").append(term); //$NON-NLS-1$ //$NON-NLS-2$
        return tooltip.toString();
    }
}