ca.nrc.cadc.dali.tables.votable.FieldElement.java Source code

Java tutorial

Introduction

Here is the source code for ca.nrc.cadc.dali.tables.votable.FieldElement.java

Source

/*
 ************************************************************************
 *******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
 **************  CENTRE CANADIEN DE DONNES ASTRONOMIQUES  **************
 *
 *  (c) 2009.                            (c) 2009.
 *  Government of Canada                 Gouvernement du Canada
 *  National Research Council            Conseil national de recherches
 *  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
 *  All rights reserved                  Tous droits rservs
 *
 *  NRC disclaims any warranties,        Le CNRC dnie toute garantie
 *  expressed, implied, or               nonce, implicite ou lgale,
 *  statutory, of any kind with          de quelque nature que ce
 *  respect to the software,             soit, concernant le logiciel,
 *  including without limitation         y compris sans restriction
 *  any warranty of merchantability      toute garantie de valeur
 *  or fitness for a particular          marchande ou de pertinence
 *  purpose. NRC shall not be            pour un usage particulier.
 *  liable in any event for any          Le CNRC ne pourra en aucun cas
 *  damages, whether direct or           tre tenu responsable de tout
 *  indirect, special or general,        dommage, direct ou indirect,
 *  consequential or incidental,         particulier ou gnral,
 *  arising from the use of the          accessoire ou fortuit, rsultant
 *  software.  Neither the name          de l'utilisation du logiciel. Ni
 *  of the National Research             le nom du Conseil National de
 *  Council of Canada nor the            Recherches du Canada ni les noms
 *  names of its contributors may        de ses  participants ne peuvent
 *  be used to endorse or promote        tre utiliss pour approuver ou
 *  products derived from this           promouvoir les produits drivs
 *  software without specific prior      de ce logiciel sans autorisation
 *  written permission.                  pralable et particulire
 *                                       par crit.
 *
 *  This file is part of the             Ce fichier fait partie du projet
 *  OpenCADC project.                    OpenCADC.
 *
 *  OpenCADC is free software:           OpenCADC est un logiciel libre ;
 *  you can redistribute it and/or       vous pouvez le redistribuer ou le
 *  modify it under the terms of         modifier suivant les termes de
 *  the GNU Affero General Public        la GNU Affero General Public
 *  License as published by the          License? telle que publie
 *  Free Software Foundation,            par la Free Software Foundation
 *  either version 3 of the              : soit la version 3 de cette
 *  License, or (at your option)         licence, soit ( votre gr)
 *  any later version.                   toute version ultrieure.
 *
 *  OpenCADC is distributed in the       OpenCADC est distribu
 *  hope that it will be useful,         dans lespoir quil vous
 *  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
 *  without even the implied             GARANTIE : sans mme la garantie
 *  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILIT
 *  or FITNESS FOR A PARTICULAR          ni dADQUATION  UN OBJECTIF
 *  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
 *  General Public License for           Gnrale Publique GNU Affero
 *  more details.                        pour plus de dtails.
 *
 *  You should have received             Vous devriez avoir reu une
 *  a copy of the GNU Affero             copie de la Licence Gnrale
 *  General Public License along         Publique GNU Affero avec
 *  with OpenCADC.  If not, see          OpenCADC ; si ce nest
 *  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
 *                                       <http://www.gnu.org/licenses/>.
 *
 *  $Revision: 4 $
 *
 ************************************************************************
 */

package ca.nrc.cadc.dali.tables.votable;

import java.util.List;
import org.jdom2.Element;
import org.jdom2.Namespace;

public class FieldElement extends Element {
    /**
     * Builds a FIELD Element from a TableField.
     *
     * @param field
     * @param namespace 
     */
    public FieldElement(TableField field, Namespace namespace) {
        this("FIELD", field, namespace);
    }

    /**
     * Builds an Element with the specified element name and populates
     * the Element using the TableField.
     *
     * @param elementName
     * @param field
     * @param namespace
     */
    protected FieldElement(String elementName, TableField field, Namespace namespace) {
        super(elementName, namespace);
        init(field);
    }

    private void init(TableField field) {
        if (field != null) {
            setFieldAttribute("name", field.getName());
            setFieldAttribute("datatype", field.getDatatype());
            setFieldAttribute("ID", field.id);
            setFieldAttribute("ucd", field.ucd);
            setFieldAttribute("unit", field.unit);
            setFieldAttribute("utype", field.utype);
            setFieldAttribute("xtype", field.xtype);
            setArraysize(field.arraysize, field.variableSize);
            setDescription(field.description, namespace);
            setValues(field.values, namespace);
        }
    }

    /**
     * Set a String or Integer FIELD attribute.
     * @param name
     * @param value
     */
    protected void setFieldAttribute(String name, Object value) {
        if (value != null) {
            if (value instanceof String) {
                setAttribute(name, (String) value);
            } else if (value instanceof Integer) {
                setAttribute(name, String.valueOf((Integer) value));
            }
        }
    }

    /**
     * Add a DESCRIPTION Element to the FIELD.
     * @param description
     * @param namespace
     */
    protected void setDescription(String description, Namespace namespace) {
        if (description != null) {
            Element element = new Element("DESCRIPTION", namespace);
            element.setText(description);
            addContent(element);
        }
    }

    /**
     * Set the arraysize attribute.
     * @param arraysize
     * @param variableSize
     */
    protected void setArraysize(Integer arraysize, Boolean variableSize) {
        if (arraysize != null) {
            if (variableSize != null && variableSize) {
                setFieldAttribute("arraysize", arraysize.toString() + "*");
            } else {
                setFieldAttribute("arraysize", arraysize.toString());
            }
        } else if (variableSize != null) {
            setFieldAttribute("arraysize", "*");
        }
    }

    /**
     * Add VALUES Element with OPTION child Elements.
     * @param values
     * @param namespace
     */
    protected void setValues(List<String> values, Namespace namespace) {
        if (values != null && !values.isEmpty()) {
            Element element = new Element("VALUES", namespace);
            for (String value : values) {
                Element option = new Element("OPTION", namespace);
                option.setAttribute("value", value);
                element.addContent(option);
            }
            addContent(element);
        }
    }

}