Package uk.ac.starlink.table

Class ValueInfoMapGroup

  • public class ValueInfoMapGroup
extends uk.ac.starlink.util.MapGroup
    A MapGroup which describes a set of ValueInfo objects.
    Author:
    Mark Taylor (Starlink)

    • Constructor Summary

      Constructors 
      Constructor Description
      ValueInfoMapGroup()
      Constructs a new ValueInfoMapGroup.
      ValueInfoMapGroup​(StarTable startab)
      Constructs a ValueInfoMapGroup based on the column information in a StarTable.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addColumnAuxDataKeys​(StarTable startab)
      Adds the column auxiliary metadata keys associated with a StarTable to this MapGroup's list of known keys.
      void addDescribedValue​(DescribedValue dval)
      Adds a new Map to the group which contains the metadata and value in a DescribedValue object.
      void addTableColumns​(StarTable startab)
      Adds a Map to the group for each one of the ColumnInfo objects in a StarTable.
      void addValueInfo​(ValueInfo info)
      Adds a new Map to the group which contains the metadata in a ValueInfo object.
      static java.util.Map makeMap​(ColumnInfo colinfo)
      Returns a new Map representing a ColumnInfo object.
      static java.util.Map makeMap​(DescribedValue dval)
      Returns a new Map representing a DescribedValue object.
      static java.util.Map makeMap​(ValueInfo info)
      Returns a new Map representing a ValueInfo object.

      • Methods inherited from class uk.ac.starlink.util.MapGroup

        addMap, getKeyOrder, getKnownKeys, getMaps, removeKey, removeKeys, retainKeys, setKeyOrder, setKnownKeys, size

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ValueInfoMapGroup

        public ValueInfoMapGroup()
        Constructs a new ValueInfoMapGroup.

      • ValueInfoMapGroup

        public ValueInfoMapGroup​(StarTable startab)
        Constructs a ValueInfoMapGroup based on the column information in a StarTable. This convenience constructor just calls addTableColumns(uk.ac.starlink.table.StarTable).
        Parameters:
        startab - the StarTable to base it on

    • Method Detail

      • addValueInfo

        public void addValueInfo​(ValueInfo info)
        Adds a new Map to the group which contains the metadata in a ValueInfo object.
        Parameters:
        info - the ValueInfo object

      • addDescribedValue

        public void addDescribedValue​(DescribedValue dval)
        Adds a new Map to the group which contains the metadata and value in a DescribedValue object.
        Parameters:
        dval - the DescribedValue object

      • addTableColumns

        public void addTableColumns​(StarTable startab)
        Adds a Map to the group for each one of the ColumnInfo objects in a StarTable. The proper ordering of the column metadata is also incorporated into the ordering of this MapGroup.
        Parameters:
        startab - the table from which to add items

      • addColumnAuxDataKeys

        public void addColumnAuxDataKeys​(StarTable startab)
        Adds the column auxiliary metadata keys associated with a StarTable to this MapGroup's list of known keys.
        Parameters:
        startab - the table whose aux column metadata keys will be added

      • makeMap

        public static java.util.Map makeMap​(ColumnInfo colinfo)
        Returns a new Map representing a ColumnInfo object. This contains its name description etc plus any auxiliary metadata items.
        Parameters:
        colinfo - the ColumnInfo to make a map from
        Returns:
        new map

      • makeMap

        public static java.util.Map makeMap​(ValueInfo info)
        Returns a new Map representing a ValueInfo object. This contains its name and description etc.
        Parameters:
        info - the ValuInfo to make a map from
        Returns:
        new map

      • makeMap

        public static java.util.Map makeMap​(DescribedValue dval)
        Returns a new Map representing a DescribedValue object. This contains its name and description etc as well as its value.
        Parameters:
        dval - the DescribedValue to make a map from
        Returns:
        new map