| /******************************************************************************* |
| * 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.revision; |
| |
| import static org.eclipse.osee.framework.core.enums.DeletionFlag.INCLUDE_DELETED; |
| import java.util.Collection; |
| import java.util.HashMap; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| import java.util.logging.Level; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.osee.framework.core.data.IOseeBranch; |
| import org.eclipse.osee.framework.core.data.OseeServerContext; |
| import org.eclipse.osee.framework.core.enums.CoreTranslatorId; |
| import org.eclipse.osee.framework.core.enums.Function; |
| import org.eclipse.osee.framework.core.enums.ModificationType; |
| import org.eclipse.osee.framework.core.exception.OseeCoreException; |
| import org.eclipse.osee.framework.core.message.ChangeReportRequest; |
| import org.eclipse.osee.framework.core.message.ChangeReportResponse; |
| import org.eclipse.osee.framework.core.model.Branch; |
| import org.eclipse.osee.framework.core.model.TransactionDelta; |
| import org.eclipse.osee.framework.core.model.TransactionRecord; |
| import org.eclipse.osee.framework.core.model.change.ArtifactChangeItem; |
| import org.eclipse.osee.framework.core.model.change.AttributeChangeItem; |
| import org.eclipse.osee.framework.core.model.change.ChangeItem; |
| import org.eclipse.osee.framework.core.model.change.ChangeItemUtil; |
| import org.eclipse.osee.framework.core.model.change.ChangeVersion; |
| import org.eclipse.osee.framework.core.model.change.RelationChangeItem; |
| import org.eclipse.osee.framework.core.model.type.AttributeType; |
| import org.eclipse.osee.framework.core.model.type.RelationType; |
| import org.eclipse.osee.framework.core.operation.AbstractOperation; |
| import org.eclipse.osee.framework.jdk.core.type.CompositeKeyHashMap; |
| import org.eclipse.osee.framework.logging.OseeLog; |
| import org.eclipse.osee.framework.skynet.core.artifact.Artifact; |
| import org.eclipse.osee.framework.skynet.core.artifact.BranchManager; |
| import org.eclipse.osee.framework.skynet.core.artifact.HttpClientMessage; |
| import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery; |
| import org.eclipse.osee.framework.skynet.core.attribute.AttributeTypeManager; |
| import org.eclipse.osee.framework.skynet.core.change.ArtifactChange; |
| import org.eclipse.osee.framework.skynet.core.change.ArtifactDelta; |
| import org.eclipse.osee.framework.skynet.core.change.AttributeChange; |
| import org.eclipse.osee.framework.skynet.core.change.Change; |
| import org.eclipse.osee.framework.skynet.core.change.ErrorChange; |
| import org.eclipse.osee.framework.skynet.core.change.RelationChange; |
| import org.eclipse.osee.framework.skynet.core.internal.Activator; |
| import org.eclipse.osee.framework.skynet.core.relation.RelationTypeManager; |
| |
| /** |
| * @author Jeff C. Phillips |
| */ |
| public class ChangeDataLoader extends AbstractOperation { |
| |
| private final TransactionDelta txDelta; |
| private final Collection<Change> changes; |
| |
| public ChangeDataLoader(Collection<Change> changes, TransactionDelta txDelta) { |
| super("Compute Changes", Activator.PLUGIN_ID); |
| this.changes = changes; |
| this.txDelta = txDelta; |
| } |
| |
| @Override |
| protected void doWork(IProgressMonitor monitor) throws Exception { |
| ChangeReportResponse response = requestChanges(monitor, txDelta); |
| Collection<ChangeItem> changeItems = response.getChangeItems(); |
| |
| monitor.worked(calculateWork(0.20)); |
| |
| if (changeItems.isEmpty()) { |
| monitor.worked(calculateWork(0.80)); |
| } else { |
| monitor.setTaskName("Bulk load changed artifacts"); |
| |
| CompositeKeyHashMap<TransactionRecord, Integer, Artifact> bulkLoaded = |
| new CompositeKeyHashMap<TransactionRecord, Integer, Artifact>(); |
| |
| bulkLoadArtifactDeltas(monitor, bulkLoaded, changeItems); |
| monitor.worked(calculateWork(0.20)); |
| |
| monitor.setTaskName("Compute artifact deltas"); |
| double workAmount = 0.60 / changeItems.size(); |
| IOseeBranch startTxBranch = txDelta.getStartTx().getBranch(); |
| for (ChangeItem item : changeItems) { |
| checkForCancelledStatus(monitor); |
| Change change = computeChange(bulkLoaded, startTxBranch, item); |
| changes.add(change); |
| monitor.worked(calculateWork(workAmount)); |
| } |
| } |
| } |
| |
| private Change computeChange(CompositeKeyHashMap<TransactionRecord, Integer, Artifact> bulkLoaded, IOseeBranch startTxBranch, ChangeItem item) { |
| Change change = null; |
| try { |
| int artId = item.getArtId(); |
| Artifact startTxArtifact; |
| if (txDelta.areOnTheSameBranch()) { |
| startTxArtifact = bulkLoaded.get(txDelta.getStartTx(), artId); |
| } else { |
| startTxArtifact = bulkLoaded.get(txDelta.getStartTx().getBranch().getBaseTransaction(), artId); |
| } |
| Artifact endTxArtifact; |
| if (txDelta.areOnTheSameBranch()) { |
| endTxArtifact = bulkLoaded.get(txDelta.getEndTx(), artId); |
| } else { |
| endTxArtifact = bulkLoaded.get(txDelta.getStartTx(), artId); |
| } |
| |
| ArtifactDelta artifactDelta = new ArtifactDelta(txDelta, startTxArtifact, endTxArtifact); |
| change = createChangeObject(bulkLoaded, item, txDelta, startTxBranch, artifactDelta); |
| change.setChangeItem(item); |
| |
| } catch (Exception ex) { |
| OseeLog.log(Activator.class, Level.SEVERE, ex); |
| change = new ErrorChange(startTxBranch, item.getArtId(), ex.toString()); |
| } |
| return change; |
| } |
| |
| private Change createChangeObject(CompositeKeyHashMap<TransactionRecord, Integer, Artifact> bulkLoaded, ChangeItem item, TransactionDelta txDelta, IOseeBranch startTxBranch, ArtifactDelta artifactDelta) throws OseeCoreException { |
| Change change = null; |
| |
| int itemId = item.getItemId(); |
| long itemGammaId = item.getNetChange().getGammaId(); |
| ModificationType netModType = item.getNetChange().getModType(); |
| int artId = item.getArtId(); |
| |
| // The change artifact is the artifact that is displayed by the GUI. |
| // When we are comparing two different branches, the displayed artifact should be the start artifact or the artifact from the |
| // source branch. When we are comparing items from the same branch, the displayed artifact should be the artifact in the end transaction |
| // since that is the resulting change artifact. |
| Artifact changeArtifact = artifactDelta.getEndArtifact(); |
| boolean isHistorical = txDelta.areOnTheSameBranch(); |
| |
| if (item instanceof ArtifactChangeItem) { |
| change = |
| new ArtifactChange(startTxBranch, itemGammaId, itemId, txDelta, netModType, isHistorical, changeArtifact, |
| artifactDelta); |
| } else if (item instanceof AttributeChangeItem) { |
| String isValue = item.getCurrentVersion().getValue(); |
| AttributeType attributeType = AttributeTypeManager.getType(item.getItemTypeId()); |
| |
| String wasValue = ""; |
| if (!txDelta.areOnTheSameBranch()) { |
| ChangeVersion netChange = item.getNetChange(); |
| if (!ChangeItemUtil.isNew(netChange) && !ChangeItemUtil.isIntroduced(netChange)) { |
| ChangeVersion fromVersion = ChangeItemUtil.getStartingVersion(item); |
| wasValue = fromVersion.getValue(); |
| } |
| } |
| change = |
| new AttributeChange(startTxBranch, itemGammaId, artId, txDelta, netModType, isValue, wasValue, itemId, |
| attributeType, netModType, isHistorical, changeArtifact, artifactDelta); |
| |
| } else if (item instanceof RelationChangeItem) { |
| RelationChangeItem relationItem = (RelationChangeItem) item; |
| RelationType relationType = RelationTypeManager.getType(relationItem.getItemTypeId()); |
| |
| TransactionRecord transaction = txDelta.getStartTx(); |
| if (txDelta.areOnTheSameBranch()) { |
| transaction = txDelta.getEndTx(); |
| } |
| Artifact endTxBArtifact = bulkLoaded.get(transaction, relationItem.getBArtId()); |
| |
| change = |
| new RelationChange(startTxBranch, itemGammaId, artId, txDelta, netModType, endTxBArtifact.getArtId(), |
| itemId, relationItem.getRationale(), relationType, isHistorical, changeArtifact, artifactDelta, |
| endTxBArtifact); |
| } else { |
| throw new OseeCoreException("The change item must map to either an artifact, attribute or relation change"); |
| } |
| return change; |
| } |
| |
| private void bulkLoadArtifactDeltas(IProgressMonitor monitor, CompositeKeyHashMap<TransactionRecord, Integer, Artifact> bulkLoaded, Collection<ChangeItem> changeItems) throws OseeCoreException { |
| checkForCancelledStatus(monitor); |
| Set<Integer> artIds = asArtIds(changeItems); |
| |
| preloadArtifacts(bulkLoaded, artIds, txDelta.getStartTx(), txDelta.areOnTheSameBranch()); |
| if (!txDelta.getStartTx().equals(txDelta.getEndTx())) { |
| preloadArtifacts(bulkLoaded, artIds, txDelta.getEndTx(), txDelta.areOnTheSameBranch()); |
| } |
| |
| if (!txDelta.areOnTheSameBranch()) { |
| preloadArtifacts(bulkLoaded, artIds, txDelta.getStartTx().getBranch().getBaseTransaction(), true); |
| } |
| } |
| |
| private static void preloadArtifacts(CompositeKeyHashMap<TransactionRecord, Integer, Artifact> bulkLoaded, Collection<Integer> artIds, TransactionRecord tx, boolean isHistorical) throws OseeCoreException { |
| Branch branch = BranchManager.getBranch(tx.getBranchId()); |
| List<Artifact> artifacts; |
| if (isHistorical) { |
| artifacts = ArtifactQuery.getHistoricalArtifactListFromIds(artIds, tx, INCLUDE_DELETED); |
| } else { |
| artifacts = ArtifactQuery.getArtifactListFromIds(artIds, branch, INCLUDE_DELETED); |
| } |
| for (Artifact artifact : artifacts) { |
| bulkLoaded.put(tx, artifact.getArtId(), artifact); |
| } |
| } |
| |
| private static Set<Integer> asArtIds(Collection<ChangeItem> changeItems) { |
| Set<Integer> artIds = new HashSet<Integer>(); |
| for (ChangeItem item : changeItems) { |
| artIds.add(item.getArtId()); |
| if (item instanceof RelationChangeItem) { |
| artIds.add(((RelationChangeItem) item).getBArtId()); |
| } |
| } |
| return artIds; |
| } |
| |
| private static ChangeReportResponse requestChanges(IProgressMonitor monitor, TransactionDelta txDelta) throws OseeCoreException { |
| Map<String, String> parameters = new HashMap<String, String>(); |
| parameters.put("function", Function.CHANGE_REPORT.name()); |
| |
| ChangeReportRequest requestData = |
| new ChangeReportRequest(txDelta.getStartTx().getId(), txDelta.getEndTx().getId()); |
| |
| ChangeReportResponse response = |
| HttpClientMessage.send(OseeServerContext.BRANCH_CONTEXT, parameters, CoreTranslatorId.CHANGE_REPORT_REQUEST, |
| requestData, CoreTranslatorId.CHANGE_REPORT_RESPONSE); |
| if (response.wasSuccessful()) { |
| // OseeEventManager.kickBranchEvent(HttpBranchCreation.class, , |
| // branch.getId()); |
| } |
| return response; |
| } |
| } |
