ucar.nc2.EnumTypedef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of netcdf Show documentation
The NetCDF-Java Library is a Java interface to NetCDF files, as well as to many other types of scientific data formats.
The newest version!
/*
 * Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
 *
 * Portions of this software were developed by the Unidata Program at the
 * University Corporation for Atmospheric Research.
 *
 * Access and use of this software shall impose the following obligations
 * and understandings on the user. The user is granted the right, without
 * any fee or cost, to use, copy, modify, alter, enhance and distribute
 * this software, and any derivative works thereof, and its supporting
 * documentation for any purpose whatsoever, provided that this entire
 * notice appears in all copies of the software, derivative works and
 * supporting documentation.  Further, UCAR requests that the user credit
 * UCAR/Unidata in any publications that result from the use of this
 * software or in any product that includes this software. The names UCAR
 * and/or Unidata, however, may not be used in any advertising or publicity
 * to endorse or promote any products or commercial entity unless specific
 * written permission is obtained from UCAR/Unidata. The user also
 * understands that UCAR/Unidata is not obligated to provide the user with
 * any support, consulting, training or assistance of any kind with regard
 * to the use, operation and performance of this software nor to provide
 * the user with any updates, revisions, new versions or "bug fixes."
 *
 * THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
 * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package ucar.nc2;

import net.jcip.annotations.Immutable;
import ucar.ma2.DataType;
import ucar.nc2.util.Indent;

import java.util.*;

/**
 * Enumeration Typedef map integers to Strings.
 * For ENUM1, ENUM2, ENUM4 enumeration types.
 * Immutable.
 *
 * @author caron
 */
@Immutable
public class EnumTypedef extends CDMNode {
  private final Map map;
  private ArrayList enumStrings;
  private DataType basetype;

  public EnumTypedef(String name, Map map) {
    this(name,map,DataType.ENUM4); //default basetype
  }

  public EnumTypedef(String name, Map map, DataType basetype)
  {
    super(name);
    assert(validateMap(map,basetype));
    this.map = map;
    setBaseType(basetype); // default
  }

  /*Obsolete
  public String getName() { return getShortName(); }
  */

  public List getEnumStrings() {
    if (enumStrings != null) {
      enumStrings = new ArrayList(map.values());
      Collections.sort(enumStrings);
    }
    return enumStrings;
  }
  public Map getMap() {
    return map;
  }

  public DataType getBaseType() {return this.basetype;}
  public void setBaseType(DataType basetype)
  {
     switch (basetype) {
     case ENUM1:    
     case ENUM2:
     case ENUM4:
	this.basetype = basetype;
	break;
     default: assert(false) : "Illegal Enum basetype";
     }
  }

  public boolean
  validateMap(Map map, DataType basetype)
  {
     if(map == null || basetype == null) return false;
     for(Integer I: map.keySet()) {
         int i = (int) I;
	if(basetype == DataType.ENUM1
	   && (i < Byte.MIN_VALUE || i > Byte.MAX_VALUE))
	    return false;
	if(basetype == DataType.ENUM2
	   && (i < Short.MIN_VALUE || i > Short.MAX_VALUE))
	    return false;
	if(basetype == DataType.ENUM2
	   && (i < Integer.MIN_VALUE || i > Integer.MAX_VALUE))
	    return false;
     }
     return true;
  }

  public boolean
  inRange(int i)
  {
    if(this.basetype == DataType.ENUM1
       && (i >= Byte.MIN_VALUE || i <= Byte.MAX_VALUE))
        return true;
    else if(this.basetype == DataType.ENUM2
       && (i >= Short.MIN_VALUE || i <= Short.MAX_VALUE))
        return true;
    else if(this.basetype == DataType.ENUM2
       && (i >= Integer.MIN_VALUE || i <= Integer.MAX_VALUE))
        return true;
    else
        return false;
  }

  public String lookupEnumString(int e) {
    String result = map.get(e);
    return (result == null) ? "Unknown enum value="+e : result;
  }

  /** String representation.
   * @param strict if true, write in strict adherence to CDL definition.
   * @return CDL representation.
   */
  public String writeCDL(boolean strict) {
    Formatter out = new Formatter();
    writeCDL(out, new Indent(2), strict);
    return out.toString();
  }

  protected void writeCDL(Formatter out, Indent indent, boolean strict) {
    String name = strict ? NetcdfFile.makeValidCDLName(getShortName()) : getShortName();
    out.format("%senum %s { ", indent, name);
    int count = 0;
    List