Class CdfDump

java.lang.Object
uk.ac.bristol.star.cdf.util.CdfDump

public class CdfDump extends Object
Utility to dump the records of a CDF file, optionally with field values. Intended to be used fro the command line via the main method. The function is roughly comparable to the cdfirsdump command in the CDF distribution.

The output can optionally be written in HTML format. The point of this is so that field values which represent pointers to records can be displayed as hyperlinks, which makes it very easy to chase pointers around the CDF file in a web browser.

Since:
21 Jun 2013
  • Constructor Details

    • CdfDump

      public CdfDump(CdfReader crdr, PrintStream out, boolean writeFields, boolean html)
      Constructor.
      Parameters:
      crdr - CDF reader
      out - output stream for listing
      writeFields - true to write field data as well as record IDs
      html - true to write output in HTML format
  • Method Details

    • run

      public void run() throws IOException
      Does the work, writing output.
      Throws:
      IOException
    • runMain

      public static int runMain(String[] args) throws IOException
      Does the work for the command line tool, handling arguments. Sucess is indicated by the return value.
      Parameters:
      args - command-line arguments
      Returns:
      0 for success, non-zero for failure
      Throws:
      IOException
    • main

      public static void main(String[] args) throws IOException
      Main method. Use -help for arguments.
      Throws:
      IOException