tds.itemrenderer.data.ITSContent.java Source code

Introduction

Here is the source code for tds.itemrenderer.data.ITSContent.java

Source

/*******************************************************************************
 * Educational Online Test Delivery System 
 * Copyright (c) 2014 American Institutes for Research
 *   
 * Distributed under the AIR Open Source License, Version 1.0 
 * See accompanying file AIR-License-1_0.txt or at
 * http://www.smarterapp.org/documents/American_Institutes_for_Research_Open_Source_Software_License.pdf
 ******************************************************************************/
package tds.itemrenderer.data;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections.Predicate;
import org.apache.commons.lang.StringUtils;
import org.w3c.dom.Element;

import java.util.ArrayList;
import java.util.List;

import tds.itemrenderer.data.apip.APIPXml;

public class ITSContent {
    private String _title; // only for passage
    private String _language;
    private ITSMachineRubric _machineRubric;
    private String _illustration;
    private String _illustrationTTS;
    private String _stem;
    private String _stemTTS;
    private String _gridAnswerSpace;
    private ITSOptionList _options;
    private ITSKeyboard _keyboard;
    private APIPXml _apip;
    private List<ITSAttachment> _attachments;
    private ITSQTI _qti;
    private List<Element> _genericElements = new ArrayList<>();

    private static final String ACC_TYPE_BRAILLE_TRANSCRIPT = "Braille Transcript";
    private static final String ACC_CODE_BRAILLE_TRANSCRIPT = "TDS_BrailleTrans1";

    public ITSContent() {
    }

    public ITSContent(String language) {
        _language = language;
    }

    public String getTitle() {
        return _title;
    }

    public void setTitle(String _title) {
        this._title = _title;
    }

    public String getLanguage() {
        return _language;
    }

    public void setLanguage(String _language) {
        this._language = _language;
    }

    public ITSMachineRubric getMachineRubric() {
        return _machineRubric;
    }

    public void setMachineRubric(ITSMachineRubric _machineRubric) {
        this._machineRubric = _machineRubric;
    }

    public String getIllustration() {
        return _illustration;
    }

    public void setIllustration(String _illustration) {
        this._illustration = _illustration;
    }

    public String getIllustrationTTS() {
        return _illustrationTTS;
    }

    public void setIllustrationTTS(String _illustrationTTS) {
        this._illustrationTTS = _illustrationTTS;
    }

    public String getStem() {
        return _stem;
    }

    public void setStem(String _stem) {
        this._stem = _stem;
    }

    public String getStemTTS() {
        return _stemTTS;
    }

    public void setStemTTS(String _stemTTS) {
        this._stemTTS = _stemTTS;
    }

    public String getGridAnswerSpace() {
        return _gridAnswerSpace;
    }

    public void setGridAnswerSpace(String _gridAnswerSpace) {
        this._gridAnswerSpace = _gridAnswerSpace;
    }

    public ITSOptionList getOptions() {
        return _options;
    }

    public void setOptions(ITSOptionList _options) {
        this._options = _options;
    }

    public ITSKeyboard getKeyboard() {
        return _keyboard;
    }

    public void setKeyboard(ITSKeyboard _keyboard) {
        this._keyboard = _keyboard;
    }

    public APIPXml getApip() {
        return _apip;
    }

    public void setApip(APIPXml _apip) {
        this._apip = _apip;
    }

    public List<ITSAttachment> getAttachments() {
        return _attachments;
    }

    public void setAttachments(List<ITSAttachment> _attachments) {
        this._attachments = _attachments;
    }

    public ITSQTI getQti() {
        return _qti;
    }

    public void setQti(ITSQTI _qti) {
        this._qti = _qti;
    }

    public List<ITSAttachment> GetBrailleTypeAttachment(AccLookup accLookup) {
        List<ITSAttachment> brailleAttachments = new ArrayList<ITSAttachment>();

        // check if there are any attachments
        if (_attachments == null || _attachments.isEmpty())
            return brailleAttachments;

        String brailleType = null;
        AccProperties accProps = new AccProperties(accLookup);

        if (accProps.getBrailleType() == null) {
            return brailleAttachments;
        }

        // using the accommodation code for braille type figure out what the ITS
        // braille would be
        switch (accProps.getBrailleType()) {
        case "TDS_BT_G1":
            brailleType = "uncontracted";
            break;
        case "TDS_BT_G2":
            brailleType = "contracted";
            break;
        case "TDS_BT_NM":
            brailleType = "nemeth";
            break;
        }

        // the last part of the code is the braille type
        //  instead of listing them all, use that to allow for new types to be created without altering this case statement
        //  those listed above are legacy
        if (brailleType == null) {
            String[] parts = accProps.getBrailleType().split("_");
            brailleType = parts[parts.length - 1].toLowerCase();
        }

        List<String> brailleSubTypes = new ArrayList<String>();
        brailleSubTypes.add(brailleType);

        // The ending letter determines the Math encoding
        //  N = Nemeth, T = UEB Math, L = No Math Code Needed
        //  The student is assigned Nemeth or UEB Math in ART but the content might be No Math Needed (especially ELA content)
        //  Therefore, we need to check the assigned code as well as the equivalent code with No Math Needed
        if (!brailleType.endsWith("l")) {
            brailleSubTypes.add(brailleType.substring(0, 2) + "l");
        }

        // check if the tests braille type matches the attachments subtype (which is a braille type as well)
        ITSAttachment mainBrailleAttachment = findBrailleAttachment(brailleSubTypes, false);

        if (mainBrailleAttachment != null) {
            brailleAttachments.add(mainBrailleAttachment);
        }

        // check for a transcript version, if the student is assigned the accommodation
        if (accLookup.exists(ACC_TYPE_BRAILLE_TRANSCRIPT, ACC_CODE_BRAILLE_TRANSCRIPT)) {
            ITSAttachment transcriptBrailleAttachment = findBrailleAttachment(brailleSubTypes, true);

            if (transcriptBrailleAttachment != null) {
                brailleAttachments.add(transcriptBrailleAttachment);
            }
        }

        return brailleAttachments;
    }

    public List<Element> getGenericElements() {
        return _genericElements;
    }

    public void setGenericElements(List<Element> _genericElements) {
        this._genericElements = _genericElements;
    }

    private ITSAttachment findBrailleAttachment(List<String> brailleSubTypeCodes, boolean isFindTranscript) {
        ITSAttachment brailleAttachment = null;
        // need to check these in order in case the content has both Math specific and No Math Code Needed versions
        for (String subTypeCode : brailleSubTypeCodes) {
            final String subTypeCodeFinal = subTypeCode + (isFindTranscript ? "_transcript" : "");

            brailleAttachment = (ITSAttachment) CollectionUtils.find(_attachments, new Predicate() {
                @Override
                public boolean evaluate(Object attachment) {
                    return StringUtils.equalsIgnoreCase(subTypeCodeFinal,
                            ((ITSAttachment) attachment).getSubType());
                }
            });

            if (brailleAttachment != null) {
                return brailleAttachment;
            }
        }

        return null;
    }

}