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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*********************************************************************
* Copyright (c) 2013 Boeing
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Boeing - initial API and implementation
**********************************************************************/
package org.eclipse.osee.orcs.data;
import static org.eclipse.osee.framework.core.enums.CoreArtifactTypes.Artifact;
import static org.eclipse.osee.framework.core.enums.CoreBranches.COMMON;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.eclipse.osee.framework.core.data.ApplicabilityId;
import org.eclipse.osee.framework.core.data.ArtifactId;
import org.eclipse.osee.framework.core.data.ArtifactToken;
import org.eclipse.osee.framework.core.data.ArtifactTypeToken;
import org.eclipse.osee.framework.core.data.AttributeId;
import org.eclipse.osee.framework.core.data.AttributeTypeEnum;
import org.eclipse.osee.framework.core.data.AttributeTypeToken;
import org.eclipse.osee.framework.core.data.IRelationLink;
import org.eclipse.osee.framework.core.data.RelationTypeSide;
import org.eclipse.osee.framework.core.data.RelationTypeToken;
import org.eclipse.osee.framework.core.data.TransactionId;
import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
import org.eclipse.osee.framework.core.enums.DeletionFlag;
import org.eclipse.osee.framework.core.enums.EnumToken;
import org.eclipse.osee.framework.core.enums.ModificationType;
import org.eclipse.osee.framework.jdk.core.type.Id;
import org.eclipse.osee.framework.jdk.core.type.ResultSet;
import org.eclipse.osee.framework.jdk.core.util.Collections;
/**
* @author Megumi Telles
* @author Roberto E. Escobar
* @author Andrew M. Finkbeiner
*/
public interface ArtifactReadable extends ArtifactToken, HasTransaction, OrcsReadable {
ArtifactReadableImpl SENTINEL = new ArtifactReadableImpl(Id.SENTINEL, Artifact, COMMON, ArtifactId.SENTINEL,
ApplicabilityId.BASE, TransactionId.SENTINEL, ModificationType.SENTINEL, null);
TransactionId getLastModifiedTransaction();
int getAttributeCount(AttributeTypeToken type);
int getAttributeCount(AttributeTypeToken type, DeletionFlag deletionFlag);
Collection<AttributeTypeToken> getValidAttributeTypes();
Collection<AttributeTypeToken> getExistingAttributeTypes();
<T> T getSoleAttributeValue(AttributeTypeToken attributeType);
<T> T getSoleAttributeValue(AttributeTypeToken attributeType, DeletionFlag flag, T defaultValue);
<T> T getSoleAttributeValue(AttributeTypeToken attributeType, T defaultValue);
String getSoleAttributeAsString(AttributeTypeToken attributeType);
String getSoleAttributeAsString(AttributeTypeToken attributeType, String defaultValue);
Long getSoleAttributeId(AttributeTypeToken attributeType);
Long getSoleAttributeId(AttributeTypeToken attributeType, Long defaultValue);
<T> List<T> getAttributeValues(AttributeTypeToken attributeType);
Iterable<Collection<? extends AttributeReadable<Object>>> getAttributeIterable();
default <T extends EnumToken> boolean attributeMatches(AttributeTypeEnum<T> attributeType, T... values) {
T enumValue = getSoleAttributeValue(attributeType);
return enumValue.matches(values);
}
////////////////////
AttributeReadable<Object> getAttributeById(AttributeId attributeId);
ResultSet<? extends AttributeReadable<Object>> getAttributes();
<T> ResultSet<? extends AttributeReadable<T>> getAttributes(AttributeTypeToken attributeType);
ResultSet<? extends AttributeReadable<Object>> getAttributes(DeletionFlag deletionFlag);
public <T> ResultSet<? extends AttributeReadable<T>> getAttributes(AttributeTypeToken attributeType, DeletionFlag deletionFlag);
default String getAttributeValuesAsString(AttributeTypeToken attributeType) {
return Collections.toString(", ", getAttributeValues(attributeType));
}
////////////////////
int getMaximumRelationAllowed(RelationTypeSide relationTypeSide);
Collection<RelationTypeToken> getValidRelationTypes();
Collection<RelationTypeToken> getExistingRelationTypes();
default ArtifactReadable getParent() {
return org.eclipse.osee.framework.jdk.core.util.Collections.exactlyOne(
getRelated(CoreRelationTypes.DefaultHierarchical_Parent, ArtifactTypeToken.SENTINEL));
}
List<ArtifactReadable> getDescendants();
void getDescendants(List<ArtifactReadable> descendants);
boolean isDescendantOf(ArtifactToken parent);
default List<ArtifactReadable> getAncestors() {
List<ArtifactReadable> ancestors = new ArrayList<>();
for (ArtifactReadable parent = getParent(); parent != null; parent = parent.getParent()) {
ancestors.add(parent);
}
return ancestors;
}
List<ArtifactReadable> getChildren();
default ArtifactReadable getChild() {
return Collections.exactlyOne(getChildren());
}
ResultSet<ArtifactReadable> getRelated(RelationTypeSide relationTypeSide);
default List<ArtifactReadable> getRelated(RelationTypeSide relationTypeSide, ArtifactTypeToken artifactType) {
List<ArtifactReadable> artifacts = new ArrayList<>();
for (ArtifactReadable artifact : getRelated(relationTypeSide)) {
if (artifact.isOfType(artifactType)) {
artifacts.add(artifact);
}
}
return artifacts;
}
default List<ArtifactToken> getRelatedIds(RelationTypeSide relationTypeSide, ArtifactTypeToken artifactType) {
return Collections.cast(getRelated(relationTypeSide, artifactType));
}
List<ArtifactReadable> getRelated(RelationTypeSide relationTypeSide, DeletionFlag deletionFlag);
List<ArtifactReadable> getRelated(RelationTypeSide relationTypeSide, ArtifactTypeToken artifactType, DeletionFlag deletionFlag);
boolean areRelated(RelationTypeSide typeAndSide, ArtifactReadable artifact);
int getRelatedCount(RelationTypeSide typeAndSide);
String getRationale(RelationTypeSide typeAndSide, ArtifactReadable readable);
ResultSet<IRelationLink> getRelations(RelationTypeSide relationTypeSide);
Collection<Long> getChildrentIds();
Collection<Long> getRelatedIds(RelationTypeSide relationTypeSide);
boolean isHistorical();
ApplicabilityId getApplicability();
String getSafeName();
List<ArtifactReadable> getRelatedList(RelationTypeSide relationTypeSide);
<T> List<T> getAttributeValues(AttributeTypeToken attributeType, DeletionFlag deletionFlag);
}
|
