Package uk.ac.starlink.cdf

Class CdfTableBuilder

  • All Implemented Interfaces:
    uk.ac.starlink.table.Documented, uk.ac.starlink.table.formats.DocumentedIOHandler, uk.ac.starlink.table.TableBuilder
    public class CdfTableBuilder
extends uk.ac.starlink.table.formats.DocumentedTableBuilder
    Table input handler for NASA CDF (Common Data Format) files.
    Since:
    24 Jun 2013
    Author:
    Mark Taylor

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canImport​(java.awt.datatransfer.DataFlavor flavor)
      Returns false.
      boolean canStream()  
      static CdfTableProfile createProfile​(boolean invarParams, java.lang.String[] descripAttNames, java.lang.String[] unitAttNames, java.lang.String[] blankvalAttNames)
      Constructs an instance of CdfTableProfile with some suggestions for attribute names with known semantics.
      boolean docIncludesExample()  
      java.lang.String getFormatName()
      Returns "CDF".
      java.lang.String getXmlDescription()  
      uk.ac.starlink.table.StarTable makeStarTable​(uk.ac.starlink.util.DataSource datsrc, boolean wantRandom, uk.ac.starlink.table.StoragePolicy storagePolicy)  
      void streamStarTable​(java.io.InputStream in, uk.ac.starlink.table.TableSink sink, java.lang.String pos)
      Throws a TableFormatException.

      • Methods inherited from class uk.ac.starlink.table.formats.DocumentedTableBuilder

        getExtensions, looksLikeFile

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface uk.ac.starlink.table.formats.DocumentedIOHandler

        readText

    • Field Detail

      • DEFAULT_PROFILE

        public static final CdfTableProfile DEFAULT_PROFILE
        Default CDF-StarTable translation profile.

    • Constructor Detail

      • CdfTableBuilder

        public CdfTableBuilder()
        Constructs a default Cdf table builder.

      • CdfTableBuilder

        public CdfTableBuilder​(CdfTableProfile profile)
        Constructs a Cdf table builder with a custom translation profile.
        Parameters:
        profile - CDF-Startable translation profile

    • Method Detail

      • getFormatName

        public java.lang.String getFormatName()
        Returns "CDF".

      • makeStarTable

        public uk.ac.starlink.table.StarTable makeStarTable​(uk.ac.starlink.util.DataSource datsrc,
                                                    boolean wantRandom,
                                                    uk.ac.starlink.table.StoragePolicy storagePolicy)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • canImport

        public boolean canImport​(java.awt.datatransfer.DataFlavor flavor)
        Returns false. I don't think there is a MIME type associated with the CDF format. References to application/x-cdf and application/cdf appear on the web, but neither is IANA registered, and I think they refer to some other format.

      • streamStarTable

        public void streamStarTable​(java.io.InputStream in,
                            uk.ac.starlink.table.TableSink sink,
                            java.lang.String pos)
                     throws java.io.IOException
        Throws a TableFormatException. CDF is not suitable for streaming.
        Throws:
        java.io.IOException

      • getXmlDescription

        public java.lang.String getXmlDescription()

      • docIncludesExample

        public boolean docIncludesExample()

      • canStream

        public boolean canStream()
        Specified by:
        canStream in class uk.ac.starlink.table.formats.DocumentedTableBuilder

      • createProfile

        public static CdfTableProfile createProfile​(boolean invarParams,
                                            java.lang.String[] descripAttNames,
                                            java.lang.String[] unitAttNames,
                                            java.lang.String[] blankvalAttNames)
        Constructs an instance of CdfTableProfile with some suggestions for attribute names with known semantics.
        Parameters:
        invarParams - true for turning non-row-varying variables into table parameters, false for turning them into variables
        descripAttNames - ordered list of names of attributes that might supply description metadata
        unitAttNames - ordered list of names of attributes that might supply units metadata
        blankvalAttNames - ordered list of names of attributes that might supply magic blank values
        Returns:
        new profile instance