com.c5corp.c5utm
Class ReceiptWriter

java.lang.Object
  com.c5corp.c5utm.ReceiptWriter

public class ReceiptWriter
extends java.lang.Object

public class Points ReceiptWriter.java - part of Landscape database (otherwise known as the C5UTM database). the static method writeReceipt of ReceiptWriter creates a receipt file in the RECEIPTS directory containing information about any DEM added to the C5UTM db. file layout:

 # datetime;Transaction Date/Time
 # fileinfo; Info from the type A record
 # demfileinfo;File info
 # software;Software adding points to database
 # url;URL to Display Map
 # backoutid;Backout ID
 # backoutcommand;Backout command
 

Since:

1.0

Author:

Brett Stalbaum Copyright 2002-2006 see LICENSE.txt and UCSD_LICENSE.txt

Constructor Summary

ReceiptWriter()

Method Summary

static void	writeReceipt(C5UTMconfs conf, DemTable dem, java.lang.String software, java.lang.String message, java.lang.String backOutId) public static void writeReceipt(C5UTMconfs conf, Dem dem, String software, String backOutId) writes a receipt to the RECEIPT directory configured for the database.
static void	writeReceipt(C5UTMconfs conf, DemTable dem, java.lang.String software, java.lang.String message, java.lang.String backOutId, java.io.PrintWriter out) public static void writeReceipt(C5UTMconfs conf, Dem dem, String software, String backOutId, PrintWriter out) writes a receipt to the RECEIPT directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiptWriter

public ReceiptWriter()

Method Detail

writeReceipt

public static void writeReceipt(C5UTMconfs conf,
                                DemTable dem,
                                java.lang.String software,
                                java.lang.String message,
                                java.lang.String backOutId)

public static void writeReceipt(C5UTMconfs conf, Dem dem, String software, String backOutId) writes a receipt to the RECEIPT directory configured for the database.

Parameters:

conf - the conf object

dem - the dem reference

software - software that produced the DEM

message - messages

backOutId - database id for backing out the DEM

writeReceipt

public static void writeReceipt(C5UTMconfs conf,
                                DemTable dem,
                                java.lang.String software,
                                java.lang.String message,
                                java.lang.String backOutId,
                                java.io.PrintWriter out)

public static void writeReceipt(C5UTMconfs conf, Dem dem, String software, String backOutId, PrintWriter out) writes a receipt to the RECEIPT directory. This version accepts a printwriter. It the printwriter is null, it creates its own based on the location of the Receipts directory provided in confs.

Parameters:

conf - the conf object

dem - the dem reference

software - software that produced the DEM

message - messages

backOutId - database id for backing out the DEM

out - the PrintWriter object