ucar.nc2.ft.point.standard.TableConfig Maven / Gradle / Ivy
Show all versions of cdm Show documentation
/*
* Copyright 1998-2014 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.ft.point.standard;
import ucar.nc2.constants.FeatureType;
import ucar.ma2.ArrayStructure;
import ucar.ma2.StructureData;
import java.util.List;
import java.util.ArrayList;
/**
* This encapsulates the info needed by NestedTable to handle point feature "nested table" datasets.
* A TableAnalyzer creates these from a specific dataset convention.
* a TableConfig has a tree of TableConfigs, representing the join of parent and children tables.
*
* @author caron
* @since Apr 23, 2008
*/
public class TableConfig {
public enum StructureType {Structure, PsuedoStructure, PsuedoStructure2D}
public Table.Type type;
public String name;
public TableConfig parent;
public List children;
public List extraJoin;
public String structName; // full name of structure
public String nestedTableName; // short name of structure
public StructureType structureType = StructureType.Structure; // default
// linked, contiguous list
public String start; // name of variable - starting child index (in parent)
public String next; // name of variable - next child index (in child)
public String numRecords; // name of variable - number of children (in parent)
// only the top featureType in the tree is used
public FeatureType featureType;
// TablePsuedoStructureList, Structure
public List vars;
public String dimName; // outer dimension
// multidim: outer and inner dimensions
public String outerName, innerName;
// Table.Type ArrayStructure
public ArrayStructure as;
// Table.Type Singleton
public StructureData sdata;
// Table.Type ParentIndex
public String parentIndex; // name of variable - parent index (in parent)
// coordinate variable names
public String lat, lon, elev, time, timeNominal, limit;
// station info
public String stnId, stnDesc, stnNpts, stnWmoId, stnAlt;
// variable name holding the id
public String feature_id;
public String missingVar;
/**
* Constructor
* @param type type of join
* @param name name of table
*/
public TableConfig(Table.Type type, String name) {
this.type = type;
this.name = name;
this.structName = name;
}
public void addChild(TableConfig t) {
if (children == null) children = new ArrayList<>();
children.add(t);
t.parent = this;
}
public void addJoin(Join extra) {
if (extraJoin == null) extraJoin = new ArrayList<>(3);
extraJoin.add(extra);
}
public String findCoordinateVariableName(Table.CoordName coordName) {
switch (coordName) {
case Elev:
return elev;
case Lat:
return lat;
case Lon:
return lon;
case Time:
return time;
case TimeNominal:
return timeNominal;
case StnId:
return stnId;
case StnDesc:
return stnDesc;
case WmoId:
return stnWmoId;
case StnAlt:
return stnAlt;
case FeatureId:
return feature_id;
case MissingVar:
return missingVar;
}
return null;
}
public void setCoordinateVariableName(Table.CoordName coordName, String name) {
switch (coordName) {
case Elev:
elev = name;
break;
case Lat:
lat = name;
break;
case Lon:
lon = name;
break;
case Time:
time = name;
break;
case TimeNominal:
timeNominal = name;
break;
case StnId:
stnId = name;
break;
case StnDesc:
stnDesc = name;
break;
case WmoId:
stnWmoId = name;
break;
case StnAlt:
stnAlt = name;
break;
case FeatureId:
feature_id = name;
break;
case MissingVar:
missingVar = name;
break;
}
}
String getNumRecords() {
if (numRecords != null) return numRecords;
if (parent != null) return parent.getNumRecords();
return null;
}
String getStart() {
if (start != null) return start;
if (parent != null) return parent.getStart();
return null;
}
}