Skip to content

Commit a87e923

Browse files
sahydosahydo
sahydo
authored and
sahydo
committed
Modifications in the source code:
1. Add Links[] to @rationale 2. Change the report format in ItexReport 3. Add default values
1 parent 085ee47 commit a87e923

File tree

9 files changed

+216
-190
lines changed

9 files changed

+216
-190
lines changed

reports/1-Class-Main.pdf

21.1 KB
Binary file not shown.

reports/1-Method-main.pdf

21.1 KB
Binary file not shown.
951 Bytes
Binary file not shown.

src/main/java/com/unicauca/arat/business/model/implementations/Report_Impl_Itext.java

+166-179
Large diffs are not rendered by default.

src/main/java/com/unicauca/arat/business/model/rationale/Rationale.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ enum QualityAtribute {
3434
// Atributos miembro de configuración
3535
String id() default ""; // 0: Es recomendable establecer un identificador que me sirva para controlar una jerarquía al estilo de un arbol de información del Rationale
3636

37-
boolean hiden() default false;
37+
boolean hiden() default false; // Sirve para ocultar la información
38+
39+
String[] links() default {};
3840

3941
// Atributos miembro de información
4042
QualityAtribute[] quality_attributes(); // 1: Establecer el(los) atributo(s) de calidad que se quieren documentar

src/main/java/com/unicauca/arat/business/model/reporter/Reporter.java

+4-7
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,13 @@
1414
*
1515
* @author sahydo
1616
*/
17-
public final class Reporter {
17+
public class Reporter {
1818

1919
private Report reportStrategy;
2020
private Reflection reflection;
2121
private HashMap<Information, Rationale> rationaleInformation;
2222

2323
public Reporter(String packageName) {
24-
loadRationaleInformation(packageName);
25-
}
26-
27-
public void loadRationaleInformation(String packageNameToScan) {
2824
switch (DefaultValues.DEFAULT_REPORT) {
2925
case "Report_Impl_Itext":
3026
reportStrategy = new Report_Impl_Itext();
@@ -35,15 +31,16 @@ public void loadRationaleInformation(String packageNameToScan) {
3531
}
3632
switch (DefaultValues.DEFAULT_REFLECTION) {
3733
case "Reflection_Impl_JAR":
38-
reflection = new Reflection_Impl_JAR(packageNameToScan);
34+
reflection = new Reflection_Impl_JAR(packageName);
3935
break;
4036
default:
41-
reflection = new Reflection_Impl_JAR(packageNameToScan);
37+
reflection = new Reflection_Impl_JAR(packageName);
4238
break;
4339
}
4440
this.rationaleInformation = this.reflection.getRationaleInformation();
4541
}
4642

43+
4744
public JavaUtil.ResponseCode createRationaleReportByAll(String nameFile) {
4845
JavaUtil.ResponseCode response;
4946
response = reportStrategy.generateReportByAll(rationaleInformation, JavaUtil.setNameFile(nameFile));

src/main/java/com/unicauca/arat/business/util/DefaultValues.java

+28
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,41 @@
77

88
import com.unicauca.arat.business.model.implementations.Reflection_Impl_JAR;
99
import com.unicauca.arat.business.model.implementations.Report_Impl_Itext;
10+
import java.util.Date;
1011

1112
/**
1213
*
1314
* @author sahydo
1415
*/
1516
public class DefaultValues {
1617
public static final String DEFAULT_REPORT_NAME = "Architectural Rationale Report";
18+
public static final String RATIONALE_REPORT_IMAGE = "resources/unicauca.png";
1719
public static final String DEFAULT_REPORT = Report_Impl_Itext.class.getSimpleName();
1820
public static final String DEFAULT_REFLECTION = Reflection_Impl_JAR.class.getSimpleName();
21+
22+
public static final String LABEL_ORGANIZATION = "ORGANIZATION:";
23+
public static final String LABEL_DESCRIPTION = "DESCRIPTION:";
24+
public static final String LABEL_VERSION = "VERSION:";
25+
public static final String LABEL_AUTHOR = "AUTHOR:";
26+
public static final String LABEL_CURRENT_DATE = "CURRENT DATE:";
27+
public static final String LABEL_RATIONALE = "RATIONALE:";
28+
public static final String LABEL_IDENTIFIER = "ID:";
29+
public static final String LABEL_TYPE = "TYPE:";
30+
public static final String LABEL_PATH = "PATH:";
31+
public static final String LABEL_NAME = "NAME:";
32+
public static final String LABEL_QUALITY_ATTRIBUTES = "QUALITY ATTRIBUTES:";
33+
public static final String LABEL_REASONS = "REASONS:";
34+
public static final String LABEL_ALTERNATIVES = "ALTERNATIVES:";
35+
public static final String LABEL_DECISIONS = "DECISIONS:";
36+
public static final String LABEL_CAUSES = "CAUSES:";
37+
public static final String LABEL_TACTICS = "TACTICS:";
38+
public static final String LABEL_PATTERNS = "PATTERNS:";
39+
public static final String LABEL_LINKS = "LINKS:";
40+
public static final String ORGANIZATION = "Universidad del Cauca";
41+
public static final String DESCRIPTION = ".jar library to manage the Architectural Rationale through Java Source Code Annotations";
42+
public static final String VERSION = "1.0";
43+
public static final String AUTHOR = "Santiago Hyun Dorado";
44+
public static final String TITLE = "ARCHITECTURAL RATIONALE ANNOTATIONS TOOL";
45+
46+
public static Date SYSDATE = new Date();
1947
}

src/main/java/com/unicauca/arat/presentation/Main.java

+14-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
*/
1414
@Rationale(
1515
id = "1",
16-
causes = {"causa número 1","otra causa"},
16+
causes = {"causa número 1", "otra causa"},
1717
quality_attributes = Rationale.QualityAtribute.FUNCTIONAL_ADECUATION,
1818
decisions_record = {"Esta es la primera decisión que se tomó"},
1919
reasons = {"Por estas razones"},
@@ -27,9 +27,21 @@ public class Main {
2727
/**
2828
* @param args the command line arguments
2929
*/
30+
@Rationale(
31+
id = "1",
32+
causes = {"causa número 1", "otra causa"},
33+
quality_attributes = Rationale.QualityAtribute.FUNCTIONAL_ADECUATION,
34+
decisions_record = {"Esta es la primera decisión que se tomó"},
35+
reasons = {"Por estas razones"},
36+
alternatives = {"Tuvimos en cuenta estas alternativas"},
37+
patterns = {"La cual considera los siguientes patrones"},
38+
tactics = {"De las siguientes tácticas"},
39+
hiden = false
40+
)
3041
public static void main(String[] args) {
3142
// TODO code application logic here
3243
RationaleFacade.generateReportByAll("com");
44+
RationaleFacade.generateReportsByOne("com");
3345
}
34-
46+
3547
}

target/maven-archiver/pom.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#Generated by Maven
2-
#Mon Jul 09 22:59:41 COT 2018
2+
#Thu Jul 12 23:20:05 COT 2018
33
version=1
44
groupId=com.unicauca
55
artifactId=arat

0 commit comments

Comments
 (0)