org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/commit/actions/CatchTrackedChanges.java

/*******************************************************************************
 * Copyright (c) 2004, 2007 Boeing.
 * 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:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.framework.skynet.core.commit.actions;

import java.util.HashSet;
import java.util.Set;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.osee.framework.core.enums.ModificationType;
import org.eclipse.osee.framework.core.operation.Operations;
import org.eclipse.osee.framework.db.connection.exception.OseeCoreException;
import org.eclipse.osee.framework.db.connection.exception.OseeWrappedException;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.skynet.core.artifact.Branch;
import org.eclipse.osee.framework.skynet.core.attribute.Attribute;
import org.eclipse.osee.framework.skynet.core.attribute.WordAttribute;
import org.eclipse.osee.framework.skynet.core.change.AttributeChanged;
import org.eclipse.osee.framework.skynet.core.change.Change;
import org.eclipse.osee.framework.skynet.core.revision.ChangeManager;
import org.eclipse.osee.framework.skynet.core.status.EmptyMonitor;
import org.eclipse.osee.framework.skynet.core.validation.IOseeValidator;
import org.eclipse.osee.framework.skynet.core.validation.OseeValidator;

/**
 * @author Theron Virgin
 */
public class CatchTrackedChanges implements CommitAction {

   /* (non-Javadoc)
    * @see org.eclipse.osee.framework.skynet.core.commit.actions.CommitAction#runCommitAction(org.eclipse.osee.framework.skynet.core.artifact.Branch)
    */
   /**
    * Check that none of the artifacts that will be commited contain tracked changes Use the change report to get
    * attributeChanges and check their content for trackedChanges
    */

   @Override
   public void runCommitAction(Branch branch) throws OseeCoreException {
      Set<Artifact> changedArtifacts = new HashSet<Artifact>();

      for (Change change : ChangeManager.getChangesPerBranch(branch, new EmptyMonitor())) {
         if (!change.getModificationType().equals(ModificationType.DELETED)) {
            if (change instanceof AttributeChanged) {
               Attribute<?> attribute = ((AttributeChanged) change).getAttribute();
               if (attribute instanceof WordAttribute) {
                  if (((WordAttribute) attribute).containsWordAnnotations()) {
                     throw new OseeCoreException(
                           String.format(
                                 "Commit Branch Failed Artifact \"%s\" Art_ID \"%d\" contains Tracked Changes. Accept all revision changes and then recommit",
                                 attribute.getArtifact().getSafeName(), attribute.getArtifact().getArtId()));
                  }
               }
            }
            Artifact artifactChanged = change.getArtifact();
            if (artifactChanged != null) {
               changedArtifacts.add(artifactChanged);
            }
         }
      }

      int severityMask = IStatus.ERROR; // Only catch Errors not Warnings | IStatus.WARNING;
      OseeValidator validator = OseeValidator.getInstance();
      for (Artifact artifactChanged : changedArtifacts) {
         IStatus status = validator.validate(IOseeValidator.LONG, artifactChanged);
         try {
            Operations.checkForStatusSeverityMask(status, severityMask);
         } catch (Exception ex) {
            throw new OseeWrappedException(getArtifactErrorMessage(artifactChanged), ex);
         }
      }
   }

   private String getArtifactErrorMessage(Artifact artifact) {
      return String.format("Error validating: [(%s)(%s) - %s] on branchId:[%s]", artifact.getArtId(),
            artifact.getHumanReadableId(), artifact.getDescriptiveName(), artifact.getBranch().getBranchId());
   }
}