edu.ku.brc.af.ui.forms.formatters.DataObjAggregator.java Source code

Introduction

Here is the source code for edu.ku.brc.af.ui.forms.formatters.DataObjAggregator.java

Source

/* Copyright (C) 2015, University of Kansas Center for Research
 * 
 * Specify Software Project, specify@ku.edu, Biodiversity Institute,
 * 1345 Jayhawk Boulevard, Lawrence, Kansas, 66045, USA
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/
package edu.ku.brc.af.ui.forms.formatters;

import static edu.ku.brc.helpers.XMLHelper.xmlAttr;

import org.apache.commons.lang.StringUtils;

import edu.ku.brc.helpers.XMLHelper;

/**
 * This class aggregates to several Data Objects into a single value by taking the output from the formatters and appending them
 * together with a separator character (or string).
 * 
 * @author rods
 *
 * @code_status Beta
 *
 * Created Date: Jan 17, 2007
 *
 */
public class DataObjAggregator implements Cloneable {
    protected String name; // unique identifier to the aggregator 
    protected String title; // name assigned to aggregator by the user (so that renaming won't affect references)
    protected Class<?> dataClass;
    protected boolean isDefault;
    protected String separator;
    protected Integer count = null;
    protected String ending;
    protected String formatName;
    protected String orderFieldName;
    protected boolean useIdentity;

    /**
     * 
     */
    public DataObjAggregator() {
    }

    public DataObjAggregator(final String name, final String title, final Class<?> dataClass,
            final boolean isDefault, final String separator, final Integer count, final String ending,
            final String formatName, final String orderFieldName) {
        super();

        this.name = name;
        this.title = title;
        this.isDefault = isDefault;
        this.dataClass = dataClass;
        this.separator = separator;
        this.count = count;
        this.ending = ending;

        this.orderFieldName = orderFieldName;

        setFormatName(formatName); // sets boolean also

        if (StringUtils.isEmpty(this.title)) {
            this.title = this.name;
        }
    }

    public String getTitle() {
        return title;
    }

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

    public boolean isDefault() {
        return isDefault;
    }

    public Class<?> getDataClass() {
        return dataClass;
    }

    public Integer getCount() {
        return count;
    }

    public String getEnding() {
        return ending;
    }

    public String getFormatName() {
        return formatName;
    }

    public String getName() {
        return name;
    }

    public String getSeparator() {
        return separator;
    }

    /**
     * @return the useIdentity
     */
    public boolean useIdentity() {
        return useIdentity;
    }

    /**
     * @return the orderFieldName
     */
    public String getOrderFieldName() {
        return orderFieldName;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setDataClass(Class<?> dataClass) {
        this.dataClass = dataClass;
    }

    public void setDefault(boolean isDefault) {
        this.isDefault = isDefault;
    }

    public void setSeparator(String separator) {
        this.separator = separator;
    }

    public void setCount(String count) {
        try {
            this.count = Integer.valueOf(count);
        } catch (Exception e) {
            this.count = 0;
        }
    }

    public void setCount(Integer count) {
        this.count = count;
    }

    public void setEnding(String ending) {
        this.ending = ending;
    }

    public void setFormatName(String formatName) {
        this.formatName = formatName;
        this.useIdentity = "identity".equals(formatName);
    }

    public void setOrderFieldName(String orderFieldName) {
        this.orderFieldName = orderFieldName;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    public String toString() {
        return (StringUtils.isNotEmpty(title)) ? title : StringUtils.isNotEmpty(name) ? name : "";
    }

    /*
     * 
     */
    public void toXML(StringBuilder sb) {
        XMLHelper.setEmptyAttrOK(true);
        String padding = "\n               ";
        sb.append("    <aggregator");
        xmlAttr(sb, "name", name);
        sb.append(padding);
        xmlAttr(sb, "title", title);
        sb.append(padding);
        xmlAttr(sb, "class", dataClass.getName());
        sb.append(padding);
        xmlAttr(sb, "default", String.valueOf(isDefault));
        sb.append(padding);
        xmlAttr(sb, "separator", separator != null ? separator : "");
        sb.append(padding);
        xmlAttr(sb, "ending", ending != null ? ending : "");
        sb.append(padding);
        xmlAttr(sb, "count", count != null ? String.valueOf(count) : "");
        sb.append(padding);
        xmlAttr(sb, "format", formatName != null ? formatName : "");
        sb.append(padding);
        xmlAttr(sb, "orderfieldname", orderFieldName != null ? orderFieldName : "");
        sb.append(padding);
        sb.append("/>\n\n");
        XMLHelper.setEmptyAttrOK(false);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#clone()
     */
    @Override
    protected Object clone() throws CloneNotSupportedException {
        return super.clone();
    }

}