Class CdfDump


  • public class CdfDump
    extends java.lang.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 Summary

      Constructors 
      Constructor Description
      CdfDump​(CdfReader crdr, java.io.PrintStream out, boolean writeFields, boolean html)
      Constructor.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void main​(java.lang.String[] args)
      Main method.
      void run()
      Does the work, writing output.
      static int runMain​(java.lang.String[] args)
      Does the work for the command line tool, handling arguments.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CdfDump

        public CdfDump​(CdfReader crdr,
                       java.io.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 Detail

      • run

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

        public static int runMain​(java.lang.String[] args)
                           throws java.io.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:
        java.io.IOException
      • main

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