CDOViewEventProducer.java

/*
 * Copyright (c) 2016 Eike Stepper (Berlin, Germany) 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:
 *    Eike Stepper - initial API and implementation
 */
package org.eclipse.emf.cdo.view;

import org.eclipse.emf.cdo.CDOObject;
import org.eclipse.emf.cdo.CDOState;
import org.eclipse.emf.cdo.common.revision.delta.CDOFeatureDelta;
import org.eclipse.emf.cdo.transaction.CDOCommitContext;
import org.eclipse.emf.cdo.transaction.CDOTransaction;
import org.eclipse.emf.cdo.transaction.CDOTransactionHandler1;
import org.eclipse.emf.cdo.transaction.CDOTransactionHandler2;

import org.eclipse.net4j.util.container.SelfAttachingContainerListener;
import org.eclipse.net4j.util.event.Event;
import org.eclipse.net4j.util.event.IListener;

/**
 * @author Eike Stepper
 * @since 4.5
 */
public class CDOViewEventProducer extends SelfAttachingContainerListener.Delegating
{
  private final CDOObjectHandler objectHandler = new CDOObjectHandler()
  {
    public void objectStateChanged(CDOView view, CDOObject object, CDOState oldState, CDOState newState)
    {
      notifyOtherEvent(new CDOObjectStateChangedEvent(view, object, oldState, newState));
    }
  };

  private final CDOTransactionHandler1 transactionHandler1 = new CDOTransactionHandler1()
  {
    public void attachingObject(CDOTransaction transaction, CDOObject object)
    {
      notifyOtherEvent(new CDOAttachingObjectEvent(transaction, object));
    }

    public void detachingObject(CDOTransaction transaction, CDOObject object)
    {
      notifyOtherEvent(new CDODetachingObjectEvent(transaction, object));
    }

    public void modifyingObject(CDOTransaction transaction, CDOObject object, CDOFeatureDelta featureDelta)
    {
      notifyOtherEvent(new CDOModifyingObjectEvent(transaction, object, featureDelta));
    }
  };

  private final CDOTransactionHandler2 transactionHandler2 = new CDOTransactionHandler2()
  {
    public void committingTransaction(CDOTransaction transaction, CDOCommitContext commitContext)
    {
      notifyOtherEvent(new CDOCommittingTransactionEvent(transaction, commitContext));
    }

    public void committedTransaction(CDOTransaction transaction, CDOCommitContext commitContext)
    {
      notifyOtherEvent(new CDOCommittedTransactionEvent(transaction, commitContext));
    }

    public void rolledBackTransaction(CDOTransaction transaction)
    {
      notifyOtherEvent(new CDORolledBackTransactionEvent(transaction));
    }
  };

  public CDOViewEventProducer(IListener delegate, boolean delegateContainerEvents)
  {
    super(delegate, delegateContainerEvents);
  }

  public CDOViewEventProducer(IListener delegate)
  {
    super(delegate);
  }

  @Override
  public void attach(Object element)
  {
    if (element instanceof CDOView)
    {
      CDOView view = (CDOView)element;
      if (produceObjectStateChangedEvents())
      {
        view.addObjectHandler(objectHandler);
      }

      if (view instanceof CDOTransaction)
      {
        CDOTransaction transaction = (CDOTransaction)view;
        if (produceObjectModificationEvents())
        {
          transaction.addTransactionHandler(transactionHandler1);
        }

        if (produceTransactionDemarcationEvents())
        {
          transaction.addTransactionHandler(transactionHandler2);
        }
      }
    }

    super.attach(element);
  }

  @Override
  public void detach(Object element)
  {
    super.detach(element);

    if (element instanceof CDOView)
    {
      CDOView view = (CDOView)element;
      if (produceObjectStateChangedEvents())
      {
        view.removeObjectHandler(objectHandler);
      }

      if (view instanceof CDOTransaction)
      {
        CDOTransaction transaction = (CDOTransaction)view;
        if (produceObjectModificationEvents())
        {
          transaction.removeTransactionHandler(transactionHandler1);
        }

        if (produceTransactionDemarcationEvents())
        {
          transaction.removeTransactionHandler(transactionHandler2);
        }
      }
    }
  }

  protected boolean produceObjectStateChangedEvents()
  {
    return true;
  }

  protected boolean produceObjectModificationEvents()
  {
    return true;
  }

  protected boolean produceTransactionDemarcationEvents()
  {
    return true;
  }

  /**
   * @author Eike Stepper
   */
  public static final class CDOObjectStateChangedEvent extends Event implements CDOViewEvent
  {
    private static final long serialVersionUID = 1L;

    private final CDOObject object;

    private final CDOState oldState;

    private final CDOState newState;

    private CDOObjectStateChangedEvent(CDOView view, CDOObject object, CDOState oldState, CDOState newState)
    {
      super(view);
      this.object = object;
      this.oldState = oldState;
      this.newState = newState;
    }

    @Override
    public CDOView getSource()
    {
      return (CDOView)super.getSource();
    }

    public CDOObject getObject()
    {
      return object;
    }

    public CDOState getOldState()
    {
      return oldState;
    }

    public CDOState getNewState()
    {
      return newState;
    }

    @Override
    protected String formatAdditionalParameters()
    {
      return "object=" + object + ", oldState=" + oldState + ", newState=" + newState;
    }
  }

  /**
   * @author Eike Stepper
   */
  public static final class CDOAttachingObjectEvent extends Event implements CDOViewEvent
  {
    private static final long serialVersionUID = 1L;

    private final CDOObject object;

    private CDOAttachingObjectEvent(CDOTransaction transaction, CDOObject object)
    {
      super(transaction);
      this.object = object;
    }

    @Override
    public CDOTransaction getSource()
    {
      return (CDOTransaction)super.getSource();
    }

    public CDOObject getObject()
    {
      return object;
    }

    @Override
    protected String formatAdditionalParameters()
    {
      return "object=" + object;
    }
  }

  /**
   * @author Eike Stepper
   */
  public static final class CDODetachingObjectEvent extends Event implements CDOViewEvent
  {
    private static final long serialVersionUID = 1L;

    private final CDOObject object;

    private CDODetachingObjectEvent(CDOTransaction transaction, CDOObject object)
    {
      super(transaction);
      this.object = object;
    }

    @Override
    public CDOTransaction getSource()
    {
      return (CDOTransaction)super.getSource();
    }

    public CDOObject getObject()
    {
      return object;
    }

    @Override
    protected String formatAdditionalParameters()
    {
      return "object=" + object;
    }
  }

  /**
   * @author Eike Stepper
   */
  public static final class CDOModifyingObjectEvent extends Event implements CDOViewEvent
  {
    private static final long serialVersionUID = 1L;

    private final CDOObject object;

    private final CDOFeatureDelta featureDelta;

    private CDOModifyingObjectEvent(CDOTransaction transaction, CDOObject object, CDOFeatureDelta featureDelta)
    {
      super(transaction);
      this.object = object;
      this.featureDelta = featureDelta;
    }

    @Override
    public CDOTransaction getSource()
    {
      return (CDOTransaction)super.getSource();
    }

    public CDOObject getObject()
    {
      return object;
    }

    public CDOFeatureDelta getFeatureDelta()
    {
      return featureDelta;
    }

    @Override
    protected String formatAdditionalParameters()
    {
      return "object=" + object + ", featureDelta=" + featureDelta;
    }
  }

  /**
   * @author Eike Stepper
   */
  public static final class CDOCommittingTransactionEvent extends Event implements CDOViewEvent
  {
    private static final long serialVersionUID = 1L;

    private final CDOCommitContext commitContext;

    private CDOCommittingTransactionEvent(CDOTransaction transaction, CDOCommitContext commitContext)
    {
      super(transaction);
      this.commitContext = commitContext;
    }

    @Override
    public CDOTransaction getSource()
    {
      return (CDOTransaction)super.getSource();
    }

    public CDOCommitContext getCommitContext()
    {
      return commitContext;
    }

    @Override
    protected String formatAdditionalParameters()
    {
      return "commitContext=" + commitContext;
    }
  }

  /**
   * @author Eike Stepper
   */
  public static final class CDOCommittedTransactionEvent extends Event implements CDOViewEvent
  {
    private static final long serialVersionUID = 1L;

    private final CDOCommitContext commitContext;

    private CDOCommittedTransactionEvent(CDOTransaction transaction, CDOCommitContext commitContext)
    {
      super(transaction);
      this.commitContext = commitContext;
    }

    @Override
    public CDOTransaction getSource()
    {
      return (CDOTransaction)super.getSource();
    }

    public CDOCommitContext getCommitContext()
    {
      return commitContext;
    }

    @Override
    protected String formatAdditionalParameters()
    {
      return "commitContext=" + commitContext;
    }
  }

  /**
   * @author Eike Stepper
   */
  public static final class CDORolledBackTransactionEvent extends Event implements CDOViewEvent
  {
    private static final long serialVersionUID = 1L;

    private CDORolledBackTransactionEvent(CDOTransaction transaction)
    {
      super(transaction);
    }

    @Override
    public CDOTransaction getSource()
    {
      return (CDOTransaction)super.getSource();
    }
  }
}