Skip to content

Package: IndexDmrSegmentGenerator

IndexDmrSegmentGenerator

nameinstructionbranchcomplexitylinemethod
IndexDmrSegmentGenerator()
M: 0 C: 3
100%
M: 0 C: 0
100%
M: 0 C: 1
100%
M: 0 C: 1
100%
M: 0 C: 1
100%
createIndexSegment(String, int)
M: 0 C: 11
100%
M: 0 C: 0
100%
M: 0 C: 1
100%
M: 0 C: 5
100%
M: 0 C: 1
100%
generateSegments(VDomainModelReference)
M: 0 C: 139
100%
M: 0 C: 12
100%
M: 0 C: 7
100%
M: 0 C: 39
100%
M: 0 C: 1
100%
getEMFFormsSegmentGenerator()
M: 0 C: 20
100%
M: 0 C: 2
100%
M: 0 C: 2
100%
M: 0 C: 7
100%
M: 0 C: 1
100%
isApplicable(VDomainModelReference)
M: 0 C: 12
100%
M: 0 C: 2
100%
M: 0 C: 2
100%
M: 0 C: 4
100%
M: 0 C: 1
100%
reportFailure(String, VDomainModelReference)
M: 0 C: 33
100%
M: 0 C: 0
100%
M: 0 C: 1
100%
M: 0 C: 6
100%
M: 0 C: 1
100%
setEMFFormsSegmentGenerator(EMFFormsSegmentGenerator)
M: 0 C: 4
100%
M: 0 C: 0
100%
M: 0 C: 1
100%
M: 0 C: 2
100%
M: 0 C: 1
100%
setReportService(ReportService)
M: 0 C: 4
100%
M: 0 C: 0
100%
M: 0 C: 1
100%
M: 0 C: 2
100%
M: 0 C: 1
100%

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2011-2018 EclipseSource Muenchen GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Lucas Koehler - initial API and implementation
13: ******************************************************************************/
14: package org.eclipse.emfforms.internal.core.services.segments.index;
15:
16: import java.util.Collections;
17: import java.util.LinkedList;
18: import java.util.List;
19:
20: import org.eclipse.core.runtime.IStatus;
21: import org.eclipse.emf.ecore.EReference;
22: import org.eclipse.emf.ecp.common.spi.asserts.Assert;
23: import org.eclipse.emf.ecp.view.spi.indexdmr.model.VIndexDomainModelReference;
24: import org.eclipse.emf.ecp.view.spi.indexdmr.model.VIndexdmrPackage;
25: import org.eclipse.emf.ecp.view.spi.model.VDomainModelReference;
26: import org.eclipse.emf.ecp.view.spi.model.VDomainModelReferenceSegment;
27: import org.eclipse.emf.ecp.view.spi.model.VFeatureDomainModelReferenceSegment;
28: import org.eclipse.emf.ecp.view.spi.model.VViewFactory;
29: import org.eclipse.emfforms.spi.common.report.AbstractReport;
30: import org.eclipse.emfforms.spi.common.report.ReportService;
31: import org.eclipse.emfforms.spi.core.services.segments.DmrSegmentGenerator;
32: import org.eclipse.emfforms.spi.core.services.segments.EMFFormsSegmentGenerator;
33: import org.eclipse.emfforms.spi.view.indexsegment.model.VIndexDomainModelReferenceSegment;
34: import org.eclipse.emfforms.spi.view.indexsegment.model.VIndexsegmentFactory;
35: import org.osgi.framework.BundleContext;
36: import org.osgi.framework.FrameworkUtil;
37: import org.osgi.framework.ServiceReference;
38: import org.osgi.service.component.annotations.Component;
39: import org.osgi.service.component.annotations.Reference;
40:
41: /**
42: * {@link DmrSegmentGenerator} that generates {@link VDomainModelReferenceSegment segments} for a
43: * {@link VIndexDomainModelReference}.
44: *
45: * @author Lucas Koehler
46: *
47: */
48: @Component(name = "IndexDmrSegmentGenerator")
49: public class IndexDmrSegmentGenerator implements DmrSegmentGenerator {
50:
51:         private EMFFormsSegmentGenerator emfFormsSegmentGenerator;
52:         private ReportService reportService;
53:
54:         /**
55:          * Sets the {@link ReportService}.
56:          *
57:          * @param reportService The {@link ReportService}
58:          */
59:         @Reference(unbind = "-")
60:         void setReportService(ReportService reportService) {
61:                 this.reportService = reportService;
62:         }
63:
64:         @Override
65:         public double isApplicable(VDomainModelReference reference) {
66:                 Assert.create(reference).notNull();
67:•                if (reference.eClass() == VIndexdmrPackage.Literals.INDEX_DOMAIN_MODEL_REFERENCE) {
68:                         return 5d;
69:                 }
70:                 return NOT_APPLICABLE;
71:         }
72:
73:         @Override
74:         public List<VDomainModelReferenceSegment> generateSegments(VDomainModelReference reference) {
75:                 Assert.create(reference).notNull();
76:•                if (reference.eClass() != VIndexdmrPackage.Literals.INDEX_DOMAIN_MODEL_REFERENCE) {
77:                         throw new IllegalArgumentException(
78:                                 String.format("The given DMR was no index domain model reference. The DMR was: %s", reference)); //$NON-NLS-1$
79:                 }
80:                 final VIndexDomainModelReference indexDmr = (VIndexDomainModelReference) reference;
81:                 final List<VDomainModelReferenceSegment> result = new LinkedList<>();
82:
83:                 // If the index dmr has a prefix dmr, use it to resolve the path to the indexed list.
84:                 // Otherwise, use the index dmr's reference path and domain model e feature
85:•                if (indexDmr.getPrefixDMR() != null) {
86:                         final List<VDomainModelReferenceSegment> prefixSegments = getEMFFormsSegmentGenerator()
87:                                 .generateSegments(indexDmr.getPrefixDMR());
88:•                        if (prefixSegments.isEmpty()) {
89:                                 reportFailure("no segments could be generated for the prefix dmr", indexDmr); //$NON-NLS-1$
90:                                 return Collections.emptyList();
91:                         }
92:
93:                         // Transform the last segment of the prefix to an index segment and set its index
94:                         final VFeatureDomainModelReferenceSegment lastPrefixSegment = (VFeatureDomainModelReferenceSegment) prefixSegments
95:                                 .get(prefixSegments.size() - 1);
96:                         final VIndexDomainModelReferenceSegment indexSegment = createIndexSegment(
97:                                 lastPrefixSegment.getDomainModelFeature(), indexDmr.getIndex());
98:
99:                         // Add the path to the index segment (if present) and the index segment to the result
100:                         prefixSegments.remove(lastPrefixSegment);
101:                         result.addAll(prefixSegments);
102:                         result.add(indexSegment);
103:                 } else {
104:                         // Create segments for reference path
105:•                        for (final EReference eReference : indexDmr.getDomainModelEReferencePath()) {
106:                                 final VFeatureDomainModelReferenceSegment segment = VViewFactory.eINSTANCE
107:                                         .createFeatureDomainModelReferenceSegment();
108:                                 segment.setDomainModelFeature(eReference.getName());
109:                                 result.add(segment);
110:                         }
111:                         // Create segment for the domain model e feature
112:•                        if (indexDmr.getDomainModelEFeature() != null) {
113:                                 final VIndexDomainModelReferenceSegment indexSegment = createIndexSegment(
114:                                         indexDmr.getDomainModelEFeature().getName(), indexDmr.getIndex());
115:                                 result.add(indexSegment);
116:                         } else {
117:                                 reportFailure("it has no prefix dmr and its domain model e feature is null", indexDmr); //$NON-NLS-1$
118:                                 return Collections.emptyList();
119:                         }
120:                 }
121:
122:                 // Get the segments for the target dmr and add them to the result
123:                 final List<VDomainModelReferenceSegment> targetSegments = getEMFFormsSegmentGenerator()
124:                         .generateSegments(indexDmr.getTargetDMR());
125:•                if (targetSegments.isEmpty()) {
126:                         reportFailure("no target segments could be generated", indexDmr); //$NON-NLS-1$
127:                         return Collections.emptyList();
128:                 }
129:                 result.addAll(targetSegments);
130:
131:                 return result;
132:         }
133:
134:         private VIndexDomainModelReferenceSegment createIndexSegment(String domainModelFeature, int index) {
135:                 final VIndexDomainModelReferenceSegment indexSegment = VIndexsegmentFactory.eINSTANCE
136:                         .createIndexDomainModelReferenceSegment();
137:                 indexSegment.setDomainModelFeature(domainModelFeature);
138:                 indexSegment.setIndex(index);
139:                 return indexSegment;
140:         }
141:
142:         private void reportFailure(String reason, VDomainModelReference indexDmr) {
143:                 final StringBuilder sb = new StringBuilder();
144:                 sb.append("Could not generate segments for the index dmr because "); //$NON-NLS-1$
145:                 sb.append(reason);
146:                 sb.append(". The index DMR was: %s"); //$NON-NLS-1$
147:                 reportService.report(new AbstractReport(String.format(sb.toString(), indexDmr), IStatus.WARNING));
148:         }
149:
150:         // Manually get the EMFFormsSegmentGenerator to avoid a circular dependency
151:         private EMFFormsSegmentGenerator getEMFFormsSegmentGenerator() {
152:•                if (emfFormsSegmentGenerator == null) {
153:                         final BundleContext bundleContext = FrameworkUtil.getBundle(IndexDmrSegmentGenerator.class)
154:                                 .getBundleContext();
155:                         final ServiceReference<EMFFormsSegmentGenerator> serviceReference = bundleContext
156:                                 .getServiceReference(EMFFormsSegmentGenerator.class);
157:                         emfFormsSegmentGenerator = bundleContext.getService(serviceReference);
158:                 }
159:                 return emfFormsSegmentGenerator;
160:         }
161:
162:         /**
163:          * Sets the {@link EMFFormsSegmentGenerator}.
164:          * <p>
165:          * Package protected because this method should only be used for testing
166:          *
167:          * @param generator The {@link EMFFormsSegmentGenerator}
168:          */
169:         void setEMFFormsSegmentGenerator(EMFFormsSegmentGenerator generator) {
170:                 emfFormsSegmentGenerator = generator;
171:         }
172: }