Class Index<V>

  • Type Parameters:
    V - Index data type
    All Implemented Interfaces:
    java.lang.Iterable<V>
    Direct Known Subclasses:
    ColumnIndex, DateTimeIndex


    public class Index<V>
    extends java.lang.Object
    implements java.lang.Iterable<V>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.List<V> data  
      protected ucar.ma2.DataType dataType  
      protected java.lang.String format  
      protected java.lang.String name  
    • Constructor Summary

      Constructors 
      Constructor Description
      Index​()
      Constructor
      Index​(int size)
      Constructor
      Index​(java.util.List data)
      Constructor
      Index​(java.util.List data, java.lang.String name)
      Constructor
      Index​(ucar.ma2.Array array)
      Constructor
      Index​(ucar.ma2.Array array, java.lang.String name)
      Constructor
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(int i, V v)
      Add a value
      void add​(V v)
      Add a value
      Index append​(Index idx)
      Append another index
      java.lang.Object clone​()  
      boolean contains​(V v)
      Contains function
      static Index factory​(java.util.List data)
      Factory method to create a new index object
      static Index factory​(ucar.ma2.Array data)
      Factory method to create a new index object
      ucar.ma2.Array fillKeyList​(ucar.ma2.Array data, java.util.List<java.lang.Integer> rrdata)
      Fill key list
      V get​(int i)
      Get a value
      java.util.List<V> getData​()
      Get data
      java.lang.String getFormat​()
      Get string format
      java.lang.Object[] getIndices​(java.lang.Object label)
      Get indices
      java.lang.Object[] getIndices​(java.util.List<java.lang.Object> labels)
      Get indices
      java.lang.Object[] getIndices​(ucar.ma2.Array labels)
      Get indices
      java.lang.String getName​()
      Get name
      java.lang.String getNameFormat​()
      Get Name format
      java.util.List<V> getValues​()
      Get data
      int indexOf​(java.lang.Object v)
      Index of
      java.util.List<java.lang.Integer> indexOf​(java.util.List<V> vs)
      Index of
      java.lang.Integer[] indices​(java.lang.Object[] names)
      Get indices
      java.lang.Integer[] indices​(java.util.List<java.lang.Object> names)
      Get indices
      java.util.Iterator iterator​()  
      void set​(int i, V value)
      Set a value
      void setData​(java.util.List<V> value)
      Set data
      void setFormat​(java.lang.String value)
      Set string format
      void setName​(java.lang.String value)
      Set name
      int size​()
      Get data size
      Index subIndex​()
      Sub index
      Index subIndex​(int start, int end, int step)
      Sub index
      Index subIndex​(java.util.List<java.lang.Integer> idx)
      Sub index
      static java.util.List subList​(java.util.List list, java.util.List<java.lang.Integer> index)
      Sub list by index
      java.lang.String toString​()  
      java.lang.String toString​(int idx)
      Convert i_th index to string
      java.lang.String toString_Index​(int idx)
      Convert i_th index to string
      void updateFormat​()
      Update format
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • data

        protected java.util.List<V> data
      • format

        protected java.lang.String format
      • name

        protected java.lang.String name
      • dataType

        protected ucar.ma2.DataType dataType
    • Constructor Detail

      • Index

        public Index​()
        Constructor
      • Index

        public Index​(ucar.ma2.Array array,
                     java.lang.String name)
        Constructor
        Parameters:
        array - Index array
        name - Index name
      • Index

        public Index​(ucar.ma2.Array array)
        Constructor
        Parameters:
        array - Index array
      • Index

        public Index​(int size)
        Constructor
        Parameters:
        size - Index size
      • Index

        public Index​(java.util.List data,
                     java.lang.String name)
        Constructor
        Parameters:
        data - Index data
        name - Index name
      • Index

        public Index​(java.util.List data)
        Constructor
        Parameters:
        data - Index data
    • Method Detail

      • getValues

        public java.util.List<V> getValues​()
        Get data
        Returns:
        Values
      • getData

        public java.util.List<V> getData​()
        Get data
        Returns:
        Data
      • setData

        public void setData​(java.util.List<V> value)
        Set data
        Parameters:
        value - Data
      • iterator

        public java.util.Iterator iterator​()
        Specified by:
        iterator in interface java.lang.Iterable<V>
      • size

        public int size​()
        Get data size
        Returns:
        Index size
      • getFormat

        public java.lang.String getFormat​()
        Get string format
        Returns:
        String format
      • getNameFormat

        public java.lang.String getNameFormat​()
        Get Name format
        Returns:
      • setFormat

        public void setFormat​(java.lang.String value)
        Set string format
        Parameters:
        value - String format
      • getName

        public java.lang.String getName​()
        Get name
        Returns:
        Name
      • setName

        public void setName​(java.lang.String value)
        Set name
        Parameters:
        value - Name
      • factory

        public static Index factory​(java.util.List data)
        Factory method to create a new index object
        Parameters:
        data - Values
        Returns:
        Index object
      • factory

        public static Index factory​(ucar.ma2.Array data)
        Factory method to create a new index object
        Parameters:
        data - Values
        Returns:
        Index object
      • updateFormat

        public void updateFormat​()
        Update format
      • add

        public void add​(V v)
        Add a value
        Parameters:
        v - Value
      • add

        public void add​(int i,
                        V v)
        Add a value
        Parameters:
        i - Index
        v - Value
      • append

        public Index append​(Index idx)
        Append another index
        Parameters:
        idx - Index
        Returns:
        Appended index
      • get

        public V get​(int i)
        Get a value
        Parameters:
        i - Index
        Returns:
        Value
      • set

        public void set​(int i,
                        V value)
        Set a value
        Parameters:
        i - Index
        value - Value
      • indices

        public java.lang.Integer[] indices​(java.lang.Object[] names)
        Get indices
        Parameters:
        names - Names
        Returns:
        Indices
      • indices

        public java.lang.Integer[] indices​(java.util.List<java.lang.Object> names)
        Get indices
        Parameters:
        names - Names
        Returns:
        Indices
      • indexOf

        public int indexOf​(java.lang.Object v)
        Index of
        Parameters:
        v - Value
        Returns:
        Index
      • indexOf

        public java.util.List<java.lang.Integer> indexOf​(java.util.List<V> vs)
        Index of
        Parameters:
        vs - Value list
        Returns:
        Index list
      • contains

        public boolean contains​(V v)
        Contains function
        Parameters:
        v - Value
        Returns:
        Boolean
      • subIndex

        public Index subIndex​()
        Sub index
        Returns:
        Index
      • subIndex

        public Index subIndex​(java.util.List<java.lang.Integer> idx)
        Sub index
        Parameters:
        idx - Index list
        Returns:
        Index
      • subIndex

        public Index subIndex​(int start,
                              int end,
                              int step)
        Sub index
        Parameters:
        start - Start index
        end - End index
        step - Step
        Returns:
        Index
      • getIndices

        public java.lang.Object[] getIndices​(ucar.ma2.Array labels)
        Get indices
        Parameters:
        labels - Labels
        Returns:
        Indices
      • getIndices

        public java.lang.Object[] getIndices​(java.util.List<java.lang.Object> labels)
        Get indices
        Parameters:
        labels - Labels
        Returns:
        Indices
      • getIndices

        public java.lang.Object[] getIndices​(java.lang.Object label)
        Get indices
        Parameters:
        label - Label
        Returns:
        Indices
      • subList

        public static java.util.List subList​(java.util.List list,
                                             java.util.List<java.lang.Integer> index)
        Sub list by index
        Parameters:
        list - The list
        index - The index
        Returns:
        Result list
      • fillKeyList

        public ucar.ma2.Array fillKeyList​(ucar.ma2.Array data,
                                          java.util.List<java.lang.Integer> rrdata)
        Fill key list
        Parameters:
        data - Valid data array
        rrdata - Result data flags
        Returns:
        Result data array with same length as key list
      • toString

        public java.lang.String toString​()
        Overrides:
        toString in class java.lang.Object
      • toString_Index

        public java.lang.String toString_Index​(int idx)
        Convert i_th index to string
        Parameters:
        idx - Index i
        Returns:
        String
      • toString

        public java.lang.String toString​(int idx)
        Convert i_th index to string
        Parameters:
        idx - Index i
        Returns:
        String
      • clone

        public java.lang.Object clone​()
        Overrides:
        clone in class java.lang.Object