ca.nrc.cadc.vosi.Availability.java Source code

Java tutorial

Introduction

Here is the source code for ca.nrc.cadc.vosi.Availability.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.vosi;

import java.text.DateFormat;
import java.text.ParseException;
import java.util.Date;

import ca.nrc.cadc.util.StringBuilderWriter;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.Namespace;

import ca.nrc.cadc.date.DateUtil;
import ca.nrc.cadc.vosi.util.Util;

/**
 * @author zhangsa
 *
 */
public class Availability {
    private AvailabilityStatus _status;

    public Availability(AvailabilityStatus status) {
        super();
        if (status == null)
            throw new IllegalArgumentException("Availability Status is null.");
        _status = status;
    }

    public Availability(Document xml) {
        super();
        if (xml == null)
            throw new IllegalArgumentException("Document is null.");
        try {
            _status = fromXmlDocument(xml);
        } catch (ParseException e) {
            throw new IllegalStateException("Invalid date format in XML", e);
        }
    }

    public Document toXmlDocument() {
        DateFormat df = DateUtil.getDateFormat(DateUtil.IVOA_DATE_FORMAT, DateUtil.UTC);
        Namespace vosi = Namespace.getNamespace("vosi", VOSI.AVAILABILITY_NS_URI);

        Element eleAvailability = new Element("availability", vosi);

        Util.addChild(eleAvailability, vosi, "available", Boolean.toString(_status.isAvailable()));
        if (_status.getUpSince() != null)
            Util.addChild(eleAvailability, vosi, "upSince", df.format(_status.getUpSince()));
        if (_status.getDownAt() != null)
            Util.addChild(eleAvailability, vosi, "downAt", df.format(_status.getDownAt()));
        if (_status.getBackAt() != null)
            Util.addChild(eleAvailability, vosi, "backAt", df.format(_status.getBackAt()));
        if (_status.getNote() != null)
            Util.addChild(eleAvailability, vosi, "note", _status.getNote());

        Document document = new Document();
        document.addContent(eleAvailability);

        return document;
    }

    public AvailabilityStatus fromXmlDocument(Document doc) throws ParseException {
        Namespace vosi = Namespace.getNamespace("vosi", VOSI.AVAILABILITY_NS_URI);
        Element availability = doc.getRootElement();
        if (!availability.getName().equals("availability"))
            throw new IllegalArgumentException("missing root element 'availability'");

        Element elemAvailable = availability.getChild("available", vosi);
        if (elemAvailable == null)
            throw new IllegalArgumentException("missing element 'available'");
        boolean available = elemAvailable.getText().equalsIgnoreCase("true");

        DateFormat df = DateUtil.getDateFormat(DateUtil.IVOA_DATE_FORMAT, DateUtil.UTC);

        Element elemUpSince = availability.getChild("upSince", vosi);
        Element elemDownAt = availability.getChild("downAt", vosi);
        Element elemBackAt = availability.getChild("backAt", vosi);
        Element elemNote = availability.getChild("note", vosi);

        Date upSince = null;
        Date downAt = null;
        Date backAt = null;
        String note = null;

        if (elemUpSince != null)
            upSince = df.parse(elemUpSince.getText());
        if (elemDownAt != null)
            downAt = df.parse(elemDownAt.getText());
        if (elemBackAt != null)
            backAt = df.parse(elemBackAt.getText());
        if (elemNote != null)
            note = elemNote.getText();

        return new AvailabilityStatus(available, upSince, downAt, backAt, note);
    }

    public AvailabilityStatus getStatus() {
        return _status;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("Availability[");
        sb.append("available=").append(_status.isAvailable());
        if (_status.getUpSince() != null)
            sb.append(",upSince=").append(_status.getUpSince());
        if (_status.getDownAt() != null)
            sb.append(",downAt=").append(_status.getDownAt());
        if (_status.getBackAt() != null)
            sb.append(",backAt=").append(_status.getBackAt());
        if (_status.getNote() != null)
            sb.append(",note=").append(_status.getNote());
        sb.append("]");
        return sb.toString();
    }

}