package org.hapiserver;

/**
 * Interface for conveying a single HAPI record, regardless of its source
 * (binary, csv, etc).
 * @author jbf
 */
public interface HapiRecord {

    /**
     * returns the time as ISO-8601 encoded string
     * @param i the index of the column
     * @return the time as ISO-8601 encoded string
     * @see TimeUtil#toMillisecondsSince1970(java.lang.String) to get the long milliseconds.
     * @see TimeUtil#isoTimeToArray(java.lang.String) to decompose the time.
     */
    String getIsoTime(int i);

    /**
     * returns the time as a 1-D array of ISO-8601 encoded strings
     * @param i the index of the column
     * @return the time as ISO-8601 encoded string
     * @see TimeUtil#toMillisecondsSince1970(java.lang.String) to get the long milliseconds.
     * @see TimeUtil#isoTimeToArray(java.lang.String) to decompose the time.
     */
    String[] getIsoTimeArray(int i);
    
    /**
     * get the string value
     * @param i the index of the column
     * @return the string
     */
    String getString(int i);

    /**
     * return the data as a 1-D array.  Note that a [n,m] element array
     * will be a n*m element array.
     * @param i the index of the column
     * @return a 1D array
     */
    String[] getStringArray(int i);
    
    /**
     * get the double data
     * @param i the index of the column
     * @return the double data
     */
    double getDouble(int i);

    /**
     * return the data as a 1-D array.  Note that a [n,m] element array
     * will be a n*m element array.
     * @param i the index of the column
     * @return a 1D array
     */
    double[] getDoubleArray(int i);

    /**
     * get the integer
     * @param i the index of the column
     * @return the integer
     */
    int getInteger(int i);
    
    /**
     * return the data as a 1-D array.  Note that a [n,m] element array
     * will be a n*m element array.
     * @param i the index of the column
     * @return a 1D array
     */
    int[] getIntegerArray(int i);

    /**
     * get the value as a formatted value.
     * @param i the index of the column
     * @return the string value.
     */
    String getAsString( int i );

    /**
     * return the number of items.
     * @return the number of items.
     */
    int length();
    
}