fr.esrf.TangoApi.DbHistory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JTangoCommons Show documentation
Common classes for tango java API
There is a newer version: 10.0.0
//+======================================================================
// $Source$
//
// Project:   Tango
//
// Description:  java source code for the TANGO client/server API.
//
// $Author: pascal_verdier $
//
// Copyright (C) :      2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,
//						European Synchrotron Radiation Facility
//                      BP 220, Grenoble 38043
//                      FRANCE
//
// This file is part of Tango.
//
// Tango is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// Tango 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 Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public License
// along with Tango.  If not, see .
//
// $Revision: 26454 $
//
//-======================================================================


package fr.esrf.TangoApi;

/**
 *	Class Description:
 *	This class manage data object for Tango database history access.
 */
public class DbHistory implements java.io.Serializable {

  private String propName;  // Property name
  private String objectName;// Attribute or pipe name (Not used for device property)
  private String value;     // Property value
  private String date;      // Update date
  private boolean deleted;  // Deleted flag

  /**
   * Constructs a property.
   * @param propName Property name
   * @param date Update date (in MySQL format)
   * @param value Property value
   */
  DbHistory(String propName,String date,String[] value) {

    this.propName = propName;
    this.date = formatMySQLDate(date);
    this.value = formatValue(value);
    deleted = (value.length==0);
  }

  /**
   * Constructs an attribute property.
   * @param objectName Attribute or Pipe name
   * @param propName Property name
   * @param date Update date (in MySQL format)
   * @param value Property value
   */
  DbHistory(String objectName,String propName,String date,String[] value) {

    this(propName,date,value);
    this.objectName = objectName;
  }

  /**
   * Returns property name.
   */
  public String getName() {
    return propName;
  }

  /**
   * Return attribute name. Used when retrieving attribute property.
   */
  public String getAttributeName() {
    return objectName;
  }
  /**
   * Return attribute name. Used when retrieving pipe property.
   */
  public String getPipeName() {
    return objectName;
  }

  /**
   * Returns the value.
   */
  public String getValue() {
    return value;
  }

  /**
   * Returns the update date.
   */
  public String getDate() {
    return date;
  }

  /**
   * Return true if the property is deleted.
   */
  public boolean isDeleted() {
    return deleted;
  }

  /**
   * Format the value in one string by adding "\n" after each string.
   * @param value value to convert.
   */
  private String formatValue(String[] value) {

    String ret = "";
    for(int i=0;i