Skip to content

Commit c3baf9c

Browse files
alexmcdermidalexmcdermid
committed
smells
1 parent 0aa56a2 commit c3baf9c

File tree

2 files changed

+30
-15
lines changed

2 files changed

+30
-15
lines changed

‎api/src/main/java/ca/bc/gov/educ/studentdatacollection/api/reports/AllStudentLightCollectionGenerateCsvService.java‎

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ public class AllStudentLightCollectionGenerateCsvService {
3333
private final SdcSchoolCollectionStudentSearchService sdcSchoolCollectionStudentSearchService;
3434
private final RestUtils restUtils;
3535

36+
private static final String SCHOOL_CODE = "School Code";
37+
private static final String SCHOOL_NAME = "School Name";
38+
private static final String FACILITY_CODE = "Facility Code";
39+
40+
private static final String PEN = "PEN";
41+
private static final String LEGAL_NAME = "Legal Name";
42+
private static final String USUAL_NAME = "Usual Name";
43+
private static final String FTE = "FTE";
44+
private static final String PROGRAM_ELIGIBLE = "Program Eligible";
45+
private static final String LOCAL_ID = "Local ID";
46+
private static final String ADULT = "Adult";
47+
private static final String GRADUATE = "Graduate";
48+
private static final String GRADE = "Grade";
49+
private static final String FUNDING_CODE = "Funding Code";
50+
3651
public AllStudentLightCollectionGenerateCsvService(SdcSchoolCollectionStudentSearchService sdcSchoolCollectionStudentSearchService, RestUtils restUtils) {
3752
this.sdcSchoolCollectionStudentSearchService = sdcSchoolCollectionStudentSearchService;
3853
this.restUtils = restUtils;
@@ -41,7 +56,7 @@ public AllStudentLightCollectionGenerateCsvService(SdcSchoolCollectionStudentSea
4156
public DownloadableReportResponse generateErrorWarnInfoReportFromSdcSchoolCollectionID(UUID sdcSchoolCollectionID) {
4257
List<SdcSchoolCollectionStudentEntity> entities = sdcSchoolCollectionStudentSearchService.findAllStudentsWithErrorsWarningInfoBySchoolCollectionID(sdcSchoolCollectionID);
4358
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
44-
.setHeader("Errors & Warnings", "P.E.N.", "Legal Name", "Usual Name", "Birth Date", "Gender", "Postal Code", "Local ID", "Grade", "F.T.E.", "Adult", "Graduate", "Fee Payer",
59+
.setHeader("Errors & Warnings", PEN, LEGAL_NAME, USUAL_NAME, "Birth Date", "Gender", "Postal Code", LOCAL_ID, GRADE, "F.T.E.", ADULT, GRADUATE, "Fee Payer",
4560
"Refugee", "Indigenous Ancestry", "Ordinarily Resident on Reserve", "Band Code", "Home Language", "# Courses", "# Support Blocks", "# Other Courses",
4661
"Programme Francophone", "Core French", "Early Immersion", "Late Immersion", "ELL", "Years in ELL", "Indigenous Culture/Lang", "Indigenous Support", "Indigenous Other",
4762
"Career Prog", "Career Prep", "Coop", "Apprentice", "CTC - Career Technical C.", "Inclusive Ed Category")
@@ -69,7 +84,7 @@ public DownloadableReportResponse generateErrorWarnInfoReportFromSdcSchoolCollec
6984
public DownloadableReportResponse generateFromSdcSchoolCollectionID(UUID sdcSchoolCollectionID) {
7085
List<SdcSchoolCollectionStudentLightEntity> entities = sdcSchoolCollectionStudentSearchService.findAllStudentsLightBySchoolCollectionID(sdcSchoolCollectionID);
7186
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
72-
.setHeader("P.E.N.", "Legal Name", "Usual Name", "Birth Date", "Gender", "Postal Code", "Local ID", "Grade", "F.T.E.", "Adult", "Graduate", "Fee Payer",
87+
.setHeader(PEN, LEGAL_NAME, USUAL_NAME, "Birth Date", "Gender", "Postal Code", LOCAL_ID, GRADE, "F.T.E.", ADULT, GRADUATE, "Fee Payer",
7388
"Refugee", "Indigenous Ancestry", "Ordinarily Resident on Reserve", "Band Code", "Home Language", "# Courses", "# Support Blocks", "# Other Courses",
7489
"Programme Francophone", "Core French", "Early Immersion", "Late Immersion", "ELL", "Years in ELL", "Indigenous Culture/Lang", "Indigenous Support", "Indigenous Other",
7590
"Career Prog", "Career Prep", "Coop", "Apprentice", "CTC - Career Technical C.", "Inclusive Ed Category")
@@ -97,7 +112,7 @@ public DownloadableReportResponse generateFromSdcSchoolCollectionID(UUID sdcScho
97112
public DownloadableReportResponse generateFrenchFromSdcSchoolCollectionID(UUID sdcSchoolCollectionID) {
98113
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllFrenchStudentsLightBySchoolCollectionID(sdcSchoolCollectionID);
99114
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
100-
.setHeader("PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "French Program")
115+
.setHeader(PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "French Program")
101116
.build();
102117
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
103118
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -122,7 +137,7 @@ public DownloadableReportResponse generateFrenchFromSdcSchoolCollectionID(UUID s
122137
public DownloadableReportResponse generateCareerFromSdcSchoolCollectionID(UUID sdcSchoolCollectionID) {
123138
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllCareerStudentsLightBySchoolCollectionID(sdcSchoolCollectionID);
124139
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
125-
.setHeader("PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "Career Program", "Career Code")
140+
.setHeader(PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "Career Program", "Career Code")
126141
.build();
127142
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
128143
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -147,7 +162,7 @@ public DownloadableReportResponse generateCareerFromSdcSchoolCollectionID(UUID s
147162
public DownloadableReportResponse generateIndigenousFromSdcSchoolCollectionID(UUID sdcSchoolCollectionID) {
148163
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllIndigenousStudentsLightBySchoolCollectionID(sdcSchoolCollectionID);
149164
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
150-
.setHeader("PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "Indigenous Ancestry", "Band Code", "Indigenous Support Program")
165+
.setHeader(PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "Indigenous Ancestry", "Band Code", "Indigenous Support Program")
151166
.build();
152167
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
153168
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -172,7 +187,7 @@ public DownloadableReportResponse generateIndigenousFromSdcSchoolCollectionID(UU
172187
public DownloadableReportResponse generateInclusiveFromSdcSchoolCollectionID(UUID sdcSchoolCollectionID) {
173188
List<SdcSchoolCollectionStudentLightEntity> entities = sdcSchoolCollectionStudentSearchService.findAllInclusiveEdStudentsLightBySchoolCollectionId(sdcSchoolCollectionID);
174189
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
175-
.setHeader("PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "Inclusive Education Category")
190+
.setHeader(PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "Inclusive Education Category")
176191
.build();
177192
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
178193
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -197,7 +212,7 @@ public DownloadableReportResponse generateInclusiveFromSdcSchoolCollectionID(UUI
197212
public DownloadableReportResponse generateEllFromSdcSchoolCollectionID(UUID sdcSchoolCollectionID) {
198213
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllEllStudentsLightBySchoolCollectionId(sdcSchoolCollectionID);
199214
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
200-
.setHeader("PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "Language Program", "Years in ELL")
215+
.setHeader(PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "Language Program", "Years in ELL")
201216
.build();
202217
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
203218
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -222,7 +237,7 @@ public DownloadableReportResponse generateEllFromSdcSchoolCollectionID(UUID sdcS
222237
public DownloadableReportResponse generateErrorWarnInfoReportFromSdcDistrictCollectionID(UUID sdcDistrictCollectionID) {
223238
List<SdcSchoolCollectionStudentEntity> entities = sdcSchoolCollectionStudentSearchService.findAllStudentsWithErrorsWarningInfoByDistrictCollectionID(sdcDistrictCollectionID);
224239
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
225-
.setHeader("School Code", "School Name", "Facility Type","Errors & Warnings", "P.E.N.", "Legal Name", "Usual Name", "Birth Date", "Gender", "Postal Code", "Local ID", "Grade", "F.T.E.", "Adult", "Graduate", "Fee Payer",
240+
.setHeader(SCHOOL_CODE, SCHOOL_NAME, "Facility Type","Errors & Warnings", PEN, LEGAL_NAME, USUAL_NAME, "Birth Date", "Gender", "Postal Code", LOCAL_ID, GRADE, "F.T.E.", ADULT, GRADUATE, "Fee Payer",
226241
"Refugee", "Indigenous Ancestry", "Ordinarily Resident on Reserve", "Band Code", "Home Lang", "# Courses", "# Support Blocks", "# Other Courses",
227242
"Prog Franco", "Core French", "Early Immer", "Late Immer", "ELL", "ELL-yrs", "Indigenous Culture/Lang", "Indigenous Support", "Indigenous Other",
228243
"Career Prog", "Career Prep", "Coop", "Apprentice", "CTC", "Inclusive Ed Category")
@@ -250,7 +265,7 @@ public DownloadableReportResponse generateErrorWarnInfoReportFromSdcDistrictColl
250265
public DownloadableReportResponse generateFromSdcDistrictCollectionID(UUID sdcDistrictCollectionID) {
251266
List<SdcSchoolCollectionStudentLightEntity> entities = sdcSchoolCollectionStudentSearchService.findAllStudentsLightByDistrictCollectionId(sdcDistrictCollectionID);
252267
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
253-
.setHeader("School Code", "School Name", "Facility Type", "P.E.N.", "Legal Name", "Usual Name", "Birth Date", "Gender", "Postal Code", "Local ID", "Grade", "F.T.E.", "Adult", "Graduate", "Fee Payer",
268+
.setHeader(SCHOOL_CODE, SCHOOL_NAME, "Facility Type", PEN, LEGAL_NAME, USUAL_NAME, "Birth Date", "Gender", "Postal Code", LOCAL_ID, GRADE, "F.T.E.", ADULT, GRADUATE, "Fee Payer",
254269
"Refugee", "Indigenous Ancestry", "Ordinarily Resident on Reserve", "Band Code", "Home Lang", "# Courses", "# Support Blocks", "# Other Courses",
255270
"Prog Franco", "Core French", "Early Immer", "Late Immer", "ELL", "ELL-yrs", "Indigenous Culture/Lang", "Indigenous Support", "Indigenous Other",
256271
"Career Prog", "Career Prep", "Coop", "Apprentice", "CTC", "Inclusive Ed Category")
@@ -278,7 +293,7 @@ public DownloadableReportResponse generateFromSdcDistrictCollectionID(UUID sdcDi
278293
public DownloadableReportResponse generateFrenchFromSdcDistrictCollectionID(UUID sdcDistrictCollectionID) {
279294
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllFrenchStudentsLightByDistrictCollectionId(sdcDistrictCollectionID);
280295
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
281-
.setHeader("School Code", "School Name", "Facility Code", "PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "French Program")
296+
.setHeader(SCHOOL_CODE, SCHOOL_NAME, FACILITY_CODE, PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "French Program")
282297
.build();
283298
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
284299
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -303,7 +318,7 @@ public DownloadableReportResponse generateFrenchFromSdcDistrictCollectionID(UUID
303318
public DownloadableReportResponse generateCareerFromSdcDistrictCollectionID(UUID sdcDistrictCollectionID) {
304319
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllCareerStudentsLightByDistrictCollectionId(sdcDistrictCollectionID);
305320
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
306-
.setHeader("School Code", "School Name", "Facility Code", "PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "Career Program", "Career Code")
321+
.setHeader(SCHOOL_CODE, SCHOOL_NAME, FACILITY_CODE, PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "Career Program", "Career Code")
307322
.build();
308323
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
309324
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -328,7 +343,7 @@ public DownloadableReportResponse generateCareerFromSdcDistrictCollectionID(UUID
328343
public DownloadableReportResponse generateIndigenousFromSdcDistrictCollectionID(UUID sdcDistrictCollectionID) {
329344
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllIndigenousStudentsLightByDistrictCollectionId(sdcDistrictCollectionID);
330345
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
331-
.setHeader("School Code", "School Name", "Facility Code", "PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code",
346+
.setHeader(SCHOOL_CODE, SCHOOL_NAME, FACILITY_CODE, PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE,
332347
"Indigenous Ancestry", "Band Code", "Indigenous Support Program")
333348
.build();
334349
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
@@ -354,7 +369,7 @@ public DownloadableReportResponse generateIndigenousFromSdcDistrictCollectionID(
354369
public DownloadableReportResponse generateInclusiveFromSdcDistrictCollectionID(UUID sdcDistrictCollectionID) {
355370
List<SdcSchoolCollectionStudentLightEntity> entities = sdcSchoolCollectionStudentSearchService.findAllInclusiveEdStudentsLightByDistrictCollectionId(sdcDistrictCollectionID);
356371
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
357-
.setHeader("School Code", "School Name", "Facility Code", "PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "Inclusive Education Category")
372+
.setHeader(SCHOOL_CODE, SCHOOL_NAME, FACILITY_CODE, PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "Inclusive Education Category")
358373
.build();
359374
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
360375
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));
@@ -379,7 +394,7 @@ public DownloadableReportResponse generateInclusiveFromSdcDistrictCollectionID(U
379394
public DownloadableReportResponse generateEllFromSdcDistrictCollectionID(UUID sdcDistrictCollectionID) {
380395
List<SdcSchoolCollectionStudentLightWithEnrolledProgramCodesEntity> entities = sdcSchoolCollectionStudentSearchService.findAllEllStudentsLightByDistrictCollectionId(sdcDistrictCollectionID);
381396
CSVFormat csvFormat = CSVFormat.DEFAULT.builder()
382-
.setHeader("School Code", "School Name", "Facility Code", "PEN", "Legal Name", "Usual Name", "FTE", "Program Eligible", "Local ID", "Adult", "Graduate", "Grade", "Funding Code", "Language Program", "Years in ELL")
397+
.setHeader(SCHOOL_CODE, SCHOOL_NAME, FACILITY_CODE, PEN, LEGAL_NAME, USUAL_NAME, FTE, PROGRAM_ELIGIBLE, LOCAL_ID, ADULT, GRADUATE, GRADE, FUNDING_CODE, "Language Program", "Years in ELL")
383398
.build();
384399
try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
385400
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(byteArrayOutputStream));

‎api/src/test/java/ca/bc/gov/educ/studentdatacollection/api/service/v1/AllStudentLightCollectionGenerateCsvServiceTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ void testGenerateFromSdcSchoolCollectionID() {
5353
assertFalse(response.getDocumentData().isEmpty());
5454
verify(mockSearchService).findAllStudentsLightBySchoolCollectionID(schoolCollectionId);
5555
String decodedData = new String(Base64.getDecoder().decode(response.getDocumentData()));
56-
assertTrue(decodedData.contains("P.E.N."));
56+
assertTrue(decodedData.contains("PEN"));
5757
assertTrue(decodedData.contains("Legal Name"));
5858
assertTrue(decodedData.contains("Usual Name"));
5959
assertTrue(decodedData.contains("Birth Date"));

0 commit comments

Comments
 (0)