Skip to content

DIS: Download ELL Headcount reports by district and by school #1060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2024
Merged

DIS: Download ELL Headcount reports by district and by school #1060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bf28ca
ell dis and dis per school reports
alexmcdermid Aug 15, 2024
47a5d1b
test
alexmcdermid Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions api/src/main/java/ca/bc/gov/educ/studentdatacollection/api/constants/v1/ReportTypeCode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ public enum ReportTypeCode {
DIS_GRADE_ENROLLMENT_HEADCOUNT("DIS_GRADE_ENROLLMENT_HEADCOUNT"),
DIS_GRADE_ENROLLMENT_HEADCOUNT_PER_SCHOOL("DIS_GRADE_ENROLLMENT_HEADCOUNT_PER_SCHOOL"),
ELL_HEADCOUNT("ELL_HEADCOUNT"),
DIS_ELL_HEADCOUNT("DIS_ELL_HEADCOUNT"),
DIS_ELL_HEADCOUNT_PER_SCHOOL("DIS_ELL_HEADCOUNT_PER_SCHOOL"),
DIS_REFUGEE_HEADCOUNT_PER_SCHOOL("DIS_REFUGEE_HEADCOUNT_PER_SCHOOL"),
SPECIAL_EDUCATION_HEADCOUNT("SPECIAL_EDUCATION_HEADCOUNT"),
DIS_SPECIAL_EDUCATION_HEADCOUNT("DIS_SPECIAL_EDUCATION_HEADCOUNT"),
Expand Down
5 changes: 4 additions & 1 deletion ...va/ca/bc/gov/educ/studentdatacollection/api/controller/v1/ReportGenerationController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public class ReportGenerationController implements ReportGenerationEndpoint {
private final IndigenousHeadcountReportService indigenousHeadcountReportService;
private final IndigenousPerSchoolHeadcountReportService indigenousPerSchoolHeadcountReportService;
private final EllHeadcountReportService ellHeadcountReportService;
private final EllHeadcountPerSchoolReportService ellHeadcountPerSchoolReportService;
private final SpecialEdHeadcountReportService specialEdHeadcountReportService;
private final SpecialEdHeadcountPerSchoolReportService specialEdHeadcountPerSchoolReportService;
private final AllStudentLightCollectionGenerateCsvService allStudentLightCollectionGenerateCsvService;
Expand Down Expand Up @@ -73,7 +74,9 @@ public DownloadableReportResponse generateSDCReport(UUID collectionID, String re
case DIS_INDIGENOUS_HEADCOUNT_PER_SCHOOL -> indigenousPerSchoolHeadcountReportService.generateIndigenousHeadcountPerSchoolReport(collectionID);
case BAND_RESIDENCE_HEADCOUNT -> bandOfResidenceHeadcountReportService.generateBandOfResdienceReport(collectionID);
case DIS_REFUGEE_HEADCOUNT_PER_SCHOOL -> refugeeHeadcountPerSchoolReportService.generateRefugeePerSchoolReport(collectionID);
case ELL_HEADCOUNT -> ellHeadcountReportService.generateEllHeadcountReport(collectionID);
case ELL_HEADCOUNT -> ellHeadcountReportService.generateEllHeadcountReport(collectionID, false);
case DIS_ELL_HEADCOUNT -> ellHeadcountReportService.generateEllHeadcountReport(collectionID, true);
case DIS_ELL_HEADCOUNT_PER_SCHOOL -> ellHeadcountPerSchoolReportService.generateEllHeadcountPerSchoolReport(collectionID);
case SPECIAL_EDUCATION_HEADCOUNT -> specialEdHeadcountReportService.generateSpecialEdHeadcountReport(collectionID, false);
case DIS_SPECIAL_EDUCATION_HEADCOUNT -> specialEdHeadcountReportService.generateSpecialEdHeadcountReport(collectionID, true);
case DIS_SPECIAL_EDUCATION_HEADCOUNT_PER_SCHOOL -> specialEdHeadcountPerSchoolReportService.generateSpecialEdHeadcountPerSchoolReport(collectionID);
Expand Down
143 changes: 143 additions & 0 deletions .../ca/bc/gov/educ/studentdatacollection/api/reports/EllHeadcountPerSchoolReportService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
package ca.bc.gov.educ.studentdatacollection.api.reports;

import ca.bc.gov.educ.studentdatacollection.api.constants.v1.ReportTypeCode;
import ca.bc.gov.educ.studentdatacollection.api.constants.v1.SchoolGradeCodes;
import ca.bc.gov.educ.studentdatacollection.api.exception.EntityNotFoundException;
import ca.bc.gov.educ.studentdatacollection.api.exception.StudentDataCollectionAPIRuntimeException;
import ca.bc.gov.educ.studentdatacollection.api.model.v1.SdcDistrictCollectionEntity;
import ca.bc.gov.educ.studentdatacollection.api.properties.ApplicationProperties;
import ca.bc.gov.educ.studentdatacollection.api.repository.v1.SdcDistrictCollectionRepository;
import ca.bc.gov.educ.studentdatacollection.api.repository.v1.SdcSchoolCollectionRepository;
import ca.bc.gov.educ.studentdatacollection.api.repository.v1.SdcSchoolCollectionStudentRepository;
import ca.bc.gov.educ.studentdatacollection.api.rest.RestUtils;
import ca.bc.gov.educ.studentdatacollection.api.struct.external.institute.v1.SchoolTombstone;
import ca.bc.gov.educ.studentdatacollection.api.struct.v1.headcounts.EllHeadcountResult;
import ca.bc.gov.educ.studentdatacollection.api.struct.v1.reports.DownloadableReportResponse;
import ca.bc.gov.educ.studentdatacollection.api.struct.v1.reports.HeadcountChildNode;
import com.fasterxml.jackson.core.JsonProcessingException;
import jakarta.annotation.PostConstruct;
import lombok.extern.slf4j.Slf4j;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JasperCompileManager;
import net.sf.jasperreports.engine.JasperReport;
import org.springframework.stereotype.Service;

import java.io.InputStream;
import java.util.*;

@Service
@Slf4j
public class EllHeadcountPerSchoolReportService extends BaseReportGenerationService<EllHeadcountResult> {
protected static final String ALLELL = "allEll";
private final SdcDistrictCollectionRepository sdcDistrictCollectionRepository;
private final SdcSchoolCollectionStudentRepository sdcSchoolCollectionStudentRepository;
private JasperReport ellHeadcountPerSchoolReport;
private final RestUtils restUtils;
private List<EllHeadcountResult> ellHeadcounts = new ArrayList<>();
private List<SchoolTombstone> allSchoolsTombstones;

public EllHeadcountPerSchoolReportService(SdcDistrictCollectionRepository sdcDistrictCollectionRepository, SdcSchoolCollectionStudentRepository sdcSchoolCollectionStudentRepository, RestUtils restUtils, SdcSchoolCollectionRepository sdcSchoolCollectionRepository, RestUtils restUtils1) {
super(restUtils, sdcSchoolCollectionRepository);

this.sdcDistrictCollectionRepository = sdcDistrictCollectionRepository;
this.sdcSchoolCollectionStudentRepository = sdcSchoolCollectionStudentRepository;
this.restUtils = restUtils1;
}

@PostConstruct
public void init() {
ApplicationProperties.bgTask.execute(this::initialize);
}

private void initialize() {
this.compileJasperReports();
}

private void compileJasperReports() {
try {
InputStream inputSpecialEdHeadcount = getClass().getResourceAsStream("/reports/specialEdHeadcountsPerSchool.jrxml");
ellHeadcountPerSchoolReport = JasperCompileManager.compileReport(inputSpecialEdHeadcount);
} catch (JRException e) {
throw new StudentDataCollectionAPIRuntimeException("Compiling Jasper reports has failed :: " + e.getMessage());
}
}

public DownloadableReportResponse generateEllHeadcountPerSchoolReport(UUID collectionID) {
try {
Optional<SdcDistrictCollectionEntity> sdcDistrictCollectionEntityOptional = sdcDistrictCollectionRepository.findById(collectionID);
SdcDistrictCollectionEntity sdcDistrictCollectionEntity = sdcDistrictCollectionEntityOptional.orElseThrow(() ->
new EntityNotFoundException(SdcDistrictCollectionEntity.class, "CollectionId", collectionID.toString()));

ellHeadcounts = sdcSchoolCollectionStudentRepository.getEllHeadcountsByBySchoolIdAndSdcDistrictCollectionId(sdcDistrictCollectionEntity.getSdcDistrictCollectionID());
this.allSchoolsTombstones = getAllSchoolTombstones(collectionID);
return generateJasperReport(convertToReportJSONStringDistrict(ellHeadcounts, sdcDistrictCollectionEntity), ellHeadcountPerSchoolReport, ReportTypeCode.DIS_ELL_HEADCOUNT_PER_SCHOOL);
} catch (JsonProcessingException e) {
log.error("Exception occurred while writing PDF report for ell dis per school :: " + e.getMessage());
throw new StudentDataCollectionAPIRuntimeException("Exception occurred while writing PDF report for ell dis per school :: " + e.getMessage());
}
}

public HashMap<String, HeadcountChildNode> generateNodeMap(boolean includeKH) {
HashMap<String, HeadcountChildNode> nodeMap = new HashMap<>();
Set<String> includedSchoolIDs = new HashSet<>();
addValuesForSectionToMap(nodeMap, ALLELL, "All English Language Learners Headcount for All Schools", "00");

int sequencePrefix = 10;
if (!ellHeadcounts.isEmpty()) {
for (EllHeadcountResult result : ellHeadcounts) {
String schoolID = result.getSchoolID();
Optional<SchoolTombstone> schoolOptional = restUtils.getSchoolBySchoolID(schoolID);
int finalSequencePrefix = sequencePrefix;
schoolOptional.ifPresent(school -> {
includedSchoolIDs.add(school.getSchoolId());
String schoolTitle = school.getMincode() + " - " + school.getDisplayName();
addValuesForSectionToMap(nodeMap, schoolID, schoolTitle, String.valueOf(finalSequencePrefix));
});
sequencePrefix += 10;
}
}

for (SchoolTombstone school : allSchoolsTombstones) {
if (!includedSchoolIDs.contains(school.getSchoolId())) {
String schoolTitle = school.getMincode() + " - " + school.getDisplayName();
addValuesForSectionToMap(nodeMap, school.getSchoolId(), schoolTitle, String.valueOf(sequencePrefix));
sequencePrefix += 10;
}
}

return nodeMap;
}

private void addValuesForSectionToMap(HashMap<String, HeadcountChildNode> nodeMap, String sectionPrefix, String sectionTitle, String sequencePrefix) {
if (Objects.equals(sectionPrefix, ALLELL)) {
nodeMap.put(sectionPrefix, new HeadcountChildNode(sectionTitle, "true", sequencePrefix + "0", false, false, false, false));
} else {
nodeMap.put(sectionPrefix + "Heading", new HeadcountChildNode(sectionTitle, "true", sequencePrefix + "0", false));
nodeMap.put(sectionPrefix + "all", new HeadcountChildNode("All English Language Learners", FALSE, sequencePrefix + "1", false));
}
}

public void setValueForGrade(HashMap<String, HeadcountChildNode> nodeMap, EllHeadcountResult gradeResult) {
Optional<SchoolGradeCodes> optionalCode = SchoolGradeCodes.findByValue(gradeResult.getEnrolledGradeCode());
var code = optionalCode.orElseThrow(() ->
new EntityNotFoundException(SchoolGradeCodes.class, "Grade Value", gradeResult.getEnrolledGradeCode()));
String schoolID = gradeResult.getSchoolID();

HeadcountChildNode allEllNode = nodeMap.get(ALLELL);
if (allEllNode.getValueForGrade(code) == null) {
allEllNode.setValueForGrade(code, "0");
}

if (nodeMap.containsKey(schoolID + "all")) {
nodeMap.get(schoolID + "all").setValueForGrade(code, gradeResult.getTotalEllStudents());
}

if (nodeMap.containsKey(schoolID + "Heading")) {
nodeMap.get(schoolID + "Heading").setAllValuesToNull();
}

int currentTotal = Integer.parseInt(gradeResult.getTotalEllStudents());
int accumulatedTotal = Integer.parseInt(allEllNode.getValueForGrade(code));
allEllNode.setValueForGrade(code, String.valueOf(accumulatedTotal + currentTotal));
}
}
42 changes: 30 additions & 12 deletions ...main/java/ca/bc/gov/educ/studentdatacollection/api/reports/EllHeadcountReportService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
import ca.bc.gov.educ.studentdatacollection.api.constants.v1.SchoolGradeCodes;
import ca.bc.gov.educ.studentdatacollection.api.exception.EntityNotFoundException;
import ca.bc.gov.educ.studentdatacollection.api.exception.StudentDataCollectionAPIRuntimeException;
import ca.bc.gov.educ.studentdatacollection.api.model.v1.SdcDistrictCollectionEntity;
import ca.bc.gov.educ.studentdatacollection.api.model.v1.SdcSchoolCollectionEntity;
import ca.bc.gov.educ.studentdatacollection.api.properties.ApplicationProperties;
import ca.bc.gov.educ.studentdatacollection.api.repository.v1.SdcDistrictCollectionRepository;
import ca.bc.gov.educ.studentdatacollection.api.repository.v1.SdcSchoolCollectionRepository;
import ca.bc.gov.educ.studentdatacollection.api.repository.v1.SdcSchoolCollectionStudentRepository;
import ca.bc.gov.educ.studentdatacollection.api.rest.RestUtils;
Expand All @@ -31,12 +33,14 @@ public class EllHeadcountReportService extends BaseReportGenerationService<EllHe

private final SdcSchoolCollectionRepository sdcSchoolCollectionRepository;
private final SdcSchoolCollectionStudentRepository sdcSchoolCollectionStudentRepository;
private final SdcDistrictCollectionRepository sdcDistrictCollectionRepository;
private JasperReport ellHeadcountReport;

public EllHeadcountReportService(SdcSchoolCollectionRepository sdcSchoolCollectionRepository, SdcSchoolCollectionStudentRepository sdcSchoolCollectionStudentRepository, RestUtils restUtils) {
public EllHeadcountReportService(SdcSchoolCollectionRepository sdcSchoolCollectionRepository, SdcSchoolCollectionStudentRepository sdcSchoolCollectionStudentRepository, RestUtils restUtils, SdcDistrictCollectionRepository sdcDistrictCollectionRepository) {
super(restUtils, sdcSchoolCollectionRepository);
this.sdcSchoolCollectionRepository = sdcSchoolCollectionRepository;
this.sdcSchoolCollectionStudentRepository = sdcSchoolCollectionStudentRepository;
this.sdcDistrictCollectionRepository = sdcDistrictCollectionRepository;
}

@PostConstruct
Expand All @@ -57,17 +61,31 @@ private void compileJasperReports(){
}
}

public DownloadableReportResponse generateEllHeadcountReport(UUID collectionID){
try {
Optional<SdcSchoolCollectionEntity> sdcSchoolCollectionEntityOptional = sdcSchoolCollectionRepository.findById(collectionID);
SdcSchoolCollectionEntity sdcSchoolCollectionEntity = sdcSchoolCollectionEntityOptional.orElseThrow(() ->
new EntityNotFoundException(SdcSchoolCollectionEntity.class, "Collection by Id", collectionID.toString()));

var headcountsList = sdcSchoolCollectionStudentRepository.getEllHeadcountsBySdcSchoolCollectionId(sdcSchoolCollectionEntity.getSdcSchoolCollectionID());
return generateJasperReport(convertToReportJSONString(headcountsList, sdcSchoolCollectionEntity), ellHeadcountReport, ReportTypeCode.ELL_HEADCOUNT);
} catch (JsonProcessingException e) {
log.error("Exception occurred while writing PDF report for ell programs :: " + e.getMessage());
throw new StudentDataCollectionAPIRuntimeException("Exception occurred while writing PDF report for ell programs :: " + e.getMessage());
public DownloadableReportResponse generateEllHeadcountReport(UUID collectionID, Boolean isDistrict){
if (Boolean.TRUE.equals(isDistrict)) {
try {
Optional<SdcDistrictCollectionEntity> sdcDistrictCollectionEntityOptional = sdcDistrictCollectionRepository.findById(collectionID);
SdcDistrictCollectionEntity sdcDistrictCollectionEntity = sdcDistrictCollectionEntityOptional.orElseThrow(() ->
new EntityNotFoundException(SdcDistrictCollectionEntity.class, "Collection ID: " + collectionID));

var programList = sdcSchoolCollectionStudentRepository.getEllHeadcountsBySdcDistrictCollectionId(sdcDistrictCollectionEntity.getSdcDistrictCollectionID());
return generateJasperReport(convertToReportJSONStringDistrict(programList, sdcDistrictCollectionEntity), ellHeadcountReport, ReportTypeCode.DIS_ELL_HEADCOUNT);
} catch (JsonProcessingException e) {
log.error("Exception occurred while writing PDF report for district ell programs :: " + e.getMessage());
throw new StudentDataCollectionAPIRuntimeException("Exception occurred while writing PDF report for district ell programs :: " + e.getMessage());
}
} else {
try {
Optional<SdcSchoolCollectionEntity> sdcSchoolCollectionEntityOptional = sdcSchoolCollectionRepository.findById(collectionID);
SdcSchoolCollectionEntity sdcSchoolCollectionEntity = sdcSchoolCollectionEntityOptional.orElseThrow(() ->
new EntityNotFoundException(SdcSchoolCollectionEntity.class, "Collection by Id", collectionID.toString()));

var headcountsList = sdcSchoolCollectionStudentRepository.getEllHeadcountsBySdcSchoolCollectionId(sdcSchoolCollectionEntity.getSdcSchoolCollectionID());
return generateJasperReport(convertToReportJSONString(headcountsList, sdcSchoolCollectionEntity), ellHeadcountReport, ReportTypeCode.ELL_HEADCOUNT);
} catch (JsonProcessingException e) {
log.error("Exception occurred while writing PDF report for ell programs :: " + e.getMessage());
throw new StudentDataCollectionAPIRuntimeException("Exception occurred while writing PDF report for ell programs :: " + e.getMessage());
}
}
}

Expand Down
2 changes: 1 addition & 1 deletion api/src/main/resources/reports/ellHeadcounts.jrxml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@
<textElement>
<font fontName="BCSans" size="8"/>
</textElement>
<textFieldExpression><![CDATA[$F{schoolMincodeAndName}]]></textFieldExpression>
<textFieldExpression><![CDATA[$F{schoolMincodeAndName} == null ? "" : $F{schoolMincodeAndName}]]></textFieldExpression>
</textField>
<image>
<reportElement x="-9" y="-17" width="100" height="44" uuid="c139017e-89b8-438d-b893-49e771231c44"/>
Expand Down
Loading
Loading