Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: add2bba18645f98064a0bb5506f71c5e150e33a5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 * Copyright (c) 2012, 2013 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.transaction;

import org.eclipse.net4j.util.collection.Closeable;
import org.eclipse.net4j.util.event.IListener;
import org.eclipse.net4j.util.lifecycle.ILifecycle;
import org.eclipse.net4j.util.lifecycle.LifecycleEventAdapter;

/**
 * A utility class that, when associated with a {@link CDOTransaction transaction}, automatically updates the
 * {@link CDOTransaction#setCommitComment(String) commit comment} according to local model modifications.
 *
 * @author Eike Stepper
 * @since 4.2
 */
public class CDOTransactionCommentator implements Closeable
{
  private final IListener transactionListener = new LifecycleEventAdapter()
  {
    @Override
    protected void onDeactivated(ILifecycle lifecycle)
    {
      close();
    }
  };

  private final CDOTransactionHandler2 transactionHandler = new CDOTransactionHandler2()
  {
    private String lastComment;

    public void committingTransaction(CDOTransaction transaction, CDOCommitContext commitContext)
    {
      lastComment = createComment(commitContext);
      if (lastComment != null)
      {
        String commitComment = transaction.getCommitComment();
        if (commitComment != null)
        {
          transaction.setCommitComment(commitComment = " " + lastComment);
        }
        else
        {
          transaction.setCommitComment(lastComment);
        }
      }
    }

    public void committedTransaction(CDOTransaction transaction, CDOCommitContext commitContext)
    {
      cleanUp();
    }

    public void rolledBackTransaction(CDOTransaction transaction)
    {
      cleanUp();
    }

    private void cleanUp()
    {
      if (lastComment != null)
      {
        String commitComment = transaction.getCommitComment();
        if (commitComment != null)
        {
          if (commitComment.endsWith(lastComment))
          {
            commitComment = commitComment.substring(0, commitComment.length() - lastComment.length());
            transaction.setCommitComment(commitComment.trim());
          }
        }
      }

      lastComment = null;
    }
  };

  private CDOTransaction transaction;

  public CDOTransactionCommentator(CDOTransaction transaction)
  {
    this.transaction = transaction;
    transaction.addListener(transactionListener);
    transaction.addTransactionHandler(transactionHandler);
  }

  public final CDOTransaction getTransaction()
  {
    return transaction;
  }

  public final boolean isClosed()
  {
    return transaction == null;
  }

  public void close()
  {
    transaction.removeTransactionHandler(transactionHandler);
    transaction.removeListener(transactionListener);
    transaction = null;
  }

  protected String createComment(CDOCommitContext commitContext)
  {
    StringBuilder builder = new StringBuilder("<");
    appendSummary(builder, commitContext);
    builder.append(">");
    return builder.toString();
  }

  /**
   * @since 4.2
   */
  public static void appendSummary(StringBuilder builder, CDOCommitContext commitContext)
  {
    boolean needComma = false;
    needComma |= appendSummary(builder, needComma, commitContext.getNewObjects().size(), "addition");
    needComma |= appendSummary(builder, needComma, commitContext.getDirtyObjects().size(), "change");
    needComma |= appendSummary(builder, needComma, commitContext.getDetachedObjects().size(), "removal");
  }

  private static boolean appendSummary(StringBuilder builder, boolean needComma, int count, String label)
  {
    if (count > 0)
    {
      if (needComma)
      {
        builder.append(", ");
      }

      builder.append(count);
      builder.append(" ");
      builder.append(label);
      if (count > 1)
      {
        builder.append("s");
      }

      return true;
    }

    return false;
  }

}

Back to the top