org.openmrs.web.taglib.ForEachDisplayAttributeTag.java Source code

Introduction

Here is the source code for org.openmrs.web.taglib.ForEachDisplayAttributeTag.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.web.taglib;

import java.util.Iterator;
import java.util.List;

import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.jstl.core.LoopTagSupport;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openmrs.PersonAttributeType;
import org.openmrs.api.PersonService;
import org.openmrs.api.PersonService.ATTR_VIEW_TYPE;
import org.openmrs.api.context.Context;
import org.openmrs.util.OpenmrsConstants.PERSON_TYPE;

/**
 * Loops over the display attributes for a person. If 'type' is 'patient', only patient display
 * attributes are returned. If 'type' is 'user', only user display attributes are returned. This
 * list is maintained with global properties: patient.displayAttributeTypes and
 * user.displayAttributeTypes. Both are comma delimited lists of either PersonAttributeType names or
 * ids.
 */
public class ForEachDisplayAttributeTag extends LoopTagSupport {

    public static final long serialVersionUID = 123230012322221123L;

    private final Log log = LogFactory.getLog(getClass());

    private String personType = "";

    private String displayType = "listing";

    private Iterator<PersonAttributeType> attrTypes;

    public void prepare() throws JspTagException {

        attrTypes = null;

        try {
            PersonService ps = Context.getPersonService();

            PERSON_TYPE personType = null;
            if (StringUtils.isNotBlank(getPersonType())) {
                personType = PERSON_TYPE.valueOf(getPersonType());
            }

            ATTR_VIEW_TYPE viewType = null;
            if (StringUtils.isNotBlank(getDisplayType())) {
                viewType = ATTR_VIEW_TYPE.valueOf(getDisplayType());
            }

            List<PersonAttributeType> types = ps.getPersonAttributeTypes(personType, viewType);

            attrTypes = types.iterator();
            setVarStatus("varStatus");

        } catch (Exception e) {
            log.error("Error getting attributes", e);
        }
    }

    @Override
    protected boolean hasNext() throws JspTagException {
        if (attrTypes == null) {
            return false;
        }
        return attrTypes.hasNext();
    }

    @Override
    protected Object next() throws JspTagException {
        if (attrTypes == null) {
            throw new JspTagException("The attr iterator is null");
        }
        return attrTypes.next();
    }

    @Override
    public void release() {
        // Clean out the variables
        personType = "";
        attrTypes = null;
    }

    /**
     * @return the type
     */
    public String getPersonType() {
        return personType;
    }

    /**
     * @param type the type to set
     */
    public void setPersonType(String type) {
        this.personType = type.toUpperCase();
    }

    /**
     * @return the displayType
     */
    public String getDisplayType() {
        return displayType;
    }

    /**
     * @param displayType the displayType to set
     */
    public void setDisplayType(String displayType) {
        this.displayType = displayType.toUpperCase();
    }

}