blob: e56752ee616f659fa7077935d15ac472b5805e8d (
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
|
/*******************************************************************************
* 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.artifact.annotation;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.skynet.core.artifact.Attribute;
/**
* Provides access to annotations stored as the "Annotation" attribute in the specified artifact. NOTE: Annotations can
* also be provided through IArtifactAnnotation extension point.
*
* @author Donald G. Dunne
*/
public class AttributeAnnotationManager {
private final Artifact artifact;
public AttributeAnnotationManager(Artifact artifact) {
this.artifact = artifact;
}
private Collection<Attribute<String>> getAttributes() throws OseeCoreException {
return artifact.getAttributes(CoreAttributeTypes.Annotation);
}
/**
* @return annotations stored in "Annotation" attribute of given artifact. NOTE: This is not a full list of
* annotation for this artifact as annotations can be added via extension point.
*/
public List<ArtifactAnnotation> getAnnotations() throws OseeCoreException {
List<ArtifactAnnotation> annotations = new ArrayList<ArtifactAnnotation>();
for (String value : artifact.getAttributesToStringList(CoreAttributeTypes.Annotation)) {
ArtifactAnnotation annotation = new ArtifactAnnotation(value);
annotations.add(annotation);
}
return annotations;
}
/**
* Add an annotation to be stored in the "Annotation" attribute of this given artifact.
*
* @param newAnnotation
* @throws OseeCoreException
*/
public void addAnnotation(ArtifactAnnotation newAnnotation) throws OseeCoreException {
// Update attribute if it already exists
for (Attribute<String> attr : getAttributes()) {
ArtifactAnnotation annotation = new ArtifactAnnotation(attr.getValue());
if (newAnnotation.equals(annotation)) {
attr.setValue(newAnnotation.toXml());
return;
}
}
artifact.addAttribute(CoreAttributeTypes.Annotation, newAnnotation.toXml());
}
/**
* Remove the annotation from the "Annotation" attribute of the given artifact.
*
* @param annotation
* @throws OseeCoreException
*/
public void removeAnnotation(ArtifactAnnotation annotation) throws OseeCoreException {
// Update attribute if it already exists
for (Attribute<String> attr : getAttributes()) {
ArtifactAnnotation attrAnnotation = new ArtifactAnnotation(attr.getValue());
if (annotation.equals(attrAnnotation)) {
attr.delete();
return;
}
}
}
}
|
