jimmc.roots
Class RecordFormat

java.lang.Object
  |
  +--jimmc.roots.RecordFormat
All Implemented Interfaces:
PrintHelp

public abstract class RecordFormat
extends java.lang.Object
implements PrintHelp


Field Summary
protected  CommandInterpreter ci
           
 
Constructor Summary
RecordFormat(CommandInterpreter ci)
          Set up common stuff for subclasses.
 
Method Summary
static void AddDefaultFormats(CommandInterpreter ci)
           
abstract  java.lang.String formatRecord(PrintOptions po, RootsRecord r)
          Format the specified record in this format.
abstract  java.lang.String getName()
          Get the name of this format.
 void printOneLineHelp()
          Print out a one-line help
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ci

protected CommandInterpreter ci
Constructor Detail

RecordFormat

public RecordFormat(CommandInterpreter ci)
Set up common stuff for subclasses.
Method Detail

getName

public abstract java.lang.String getName()
Get the name of this format.
Returns:
the name of this format.

formatRecord

public abstract java.lang.String formatRecord(PrintOptions po,
                                              RootsRecord r)
Format the specified record in this format.
Parameters:
po - the print options to control the format
r - the record to format
Returns:
the formatted data

printOneLineHelp

public void printOneLineHelp()
Print out a one-line help
Specified by:
printOneLineHelp in interface PrintHelp

AddDefaultFormats

public static void AddDefaultFormats(CommandInterpreter ci)