com.jFormTK
Class JReportWriter

java.lang.Object
  extended by com.jFormTK.JReportWriter
All Implemented Interfaces:
JConstants

public class JReportWriter
extends java.lang.Object
implements JConstants

        JReportWriter:
        The 'jFormTK' Report Writer Class [JReportWriter] is responsible for generating all of
        the 'jFormTK' Application Reports. Each report added to the 'jFormTK' Report Writer is
        assigned a Report Name and a Report Type...

        The 'jFormTK' Report Writer instance is designed to encapsulate and manage all the
        reports of a 'jFormTK' Application. Each Application report is assigned a unique
        "Report Name" when it is added to the Report Writer instance...
        
        Kernel Usage:
        1)      An instance is created and hosted by the 'AppDB' Class via the
                'AppDB.initialize' Method...
        

Version:
1.00, 21 Feb 2007
Author:
Jim Crowell Professional Computer Solutions [PCS] URL: http://jFormTK.com/ E-Mail: JimCrowell@EMail.com Copyright (c) 2007 by Professional Computer Solutions [PCS] All Rights Reserved

Field Summary
 
Fields inherited from interface com.jFormTK.JConstants
__, _AB, _AB_, _AField, _B, _BField, _CField, _CIField, _DField, _EU_, _H, _HEIGHT, _HEIGHT_INV, _HField, _I, _IField, _LField, _MField, _NField, _NotRequired, _PField, _PIField, _QField, _Required, _RField, _TAField, _TField, _WIDTH, _WIDTH_INV, _XField, AB, APP_TRACE_FOCUS, APP_TRACE_GET, APP_TRACE_SET, B_, BAR, BAR_, BB, BH, BI, BREAKPOINT_FOCUS, BREAKPOINT_GET, BREAKPOINT_SET, BVB, C_QUOTE, CLOSE, CLOSE_BRACKET, COLORS_DELIMITER, COMMA, COMMA_, D_ELEMENT, D_ELEMENT_N, D_ELEMENT_N1, D_ELEMENT_N2, D_ELEMENT_N3, D_FIELDS, D_FIELDS_N, D_FIELDS_N1, D_FIELDS_N2, D_FIELDS_N3, D_ITEMS, DASH, DOT, EOL, EOP, EOS, FIELD_TRACE_FOCUS, FIELD_TRACE_GET, FIELD_TRACE_SET, FONT_DELIMITER, H_, HB, HH, HI, I_, IB, IH, II, JLAF_DELIMITER, LF, LISTBRACKET, NO, OPEN, OPEN_BRACKET, pCheckboxGroup, QUOTE, SPACE_, TAB, YES
 
Constructor Summary
JReportWriter()
           
 
Method Summary
static void add(java.lang.String reportName, int type, java.lang.String title, int dateMode, java.lang.String header)
           Add a Key [reportName], Report Type [type], Report Title [title], Date Mode [int] and Report Header [String] to the 'reports' Map...
static void add(java.lang.String reportName, JReportData data)
           Add a Key, JReportData Ordered Pair to the 'reports' Map...
 void addKey(java.lang.String key)
           
 void addReferences(java.lang.String ref)
           
static java.lang.String getAccessControl(java.lang.String reportName)
           Get the 'Access Control' from the 'JReportData' instance of the given 'reportName'...
static int getDateMode(java.lang.String reportName)
           Get the 'Date Mode' from the 'JReportData' instance of the given 'reportName'...
static java.lang.String[] getElements(java.lang.String reportName)
           Get the 'Elements' from the 'JReportData' instance of the given 'reportName'...
static java.lang.String getFooter(java.lang.String reportName)
           Get the 'Footer' from the 'JReportData' instance of the given 'reportName'...
static java.lang.String getHeader(java.lang.String reportName)
           Get the 'Header' from the 'JReportData' instance of the given 'reportName'...
 java.lang.String[] getKeys()
           Return a String Array to represent a set of "Keys" for each 'jFormTK' Application report...
static java.lang.String getTitle(java.lang.String reportName)
           Get the 'Title' from the 'JReportData' instance of the given 'reportName'...
static int getType(java.lang.String reportName)
           Get the 'Type' from the 'JReportData' instance of the given 'reportName'...
static void setAccessControl(java.lang.String reportName, java.lang.String accessControl)
           Set the 'Access Control' from the 'JReportData' instance for the 'reportName' TreeMap key...
static void setDateMode(java.lang.String reportName, int dateMode)
           Set the 'Date Mode' from the 'JReportData' instance for the 'reportName' TreeMap key...
static void setElements(java.lang.String reportName, java.lang.String[] elementsArray)
           Set the 'Elements' from the 'JReportData' instance for the 'reportName' TreeMap key...
static void setFooter(java.lang.String reportName, java.lang.String footer)
           Set the 'Footer' from the 'JReportData' instance for the 'reportName' TreeMap key...
static void setHeader(java.lang.String reportName, java.lang.String header)
           Set the 'Header' from the 'JReportData' instance for the 'reportName' TreeMap key...
static void setTitle(java.lang.String reportName, java.lang.String title)
           Set the 'Title' from the 'JReportData' instance for the 'reportName' TreeMap key...
static void setType(java.lang.String reportName, int type)
           Set the 'Type' from the 'JReportData' instance for the 'reportName' TreeMap key...
static void show()
           Display a message dialog that details the 'JReportWriter' parameters for each Report of the current 'jFormTK' Application...
static java.lang.String showReport(java.lang.String reportName, boolean showDialog)
           
static void XXXadd(java.lang.String reportName)
           Add a Key [reportName] to the 'reports' Map...
static void XXXadd(java.lang.String reportName, int type)
           Add a Key [reportName] and Report Type [type] to the 'reports' Map...
static void XXXadd(java.lang.String reportName, int type, java.lang.String title)
           Add a Key [reportName], Report Type [type] and Report Title to the 'reports' Map...
static void XXXadd(java.lang.String reportName, int type, java.lang.String title, int dateMode)
           Add a Key [reportName], Report Type [type], Report Title [title] and Date Mode [int] to the 'reports' Map...
static void XXXadd(java.lang.String reportName, int type, java.lang.String title, int dateMode, java.lang.String header, java.lang.String[] assignments)
           Add a Key [reportName], Report Type [type], Report Title [title], Date Mode [int], Report Header [String] and Report "Assignments' [String Array] to the 'reports' Map...
static void XXXadd(java.lang.String reportName, int type, java.lang.String title, int dateMode, java.lang.String header, java.lang.String[] assignments, java.lang.String[] elements)
           Add a Key [reportName], Report Type [type], Report Title [title], Date Mode [int], Report Header [String], Report "Assignments' [String Array] and Report "Elements" [String Array] to the 'reports' Map...
static void XXXadd(java.lang.String reportName, int type, java.lang.String title, int dateMode, java.lang.String header, java.lang.String[] assignments, java.lang.String[] elements, java.lang.String footer)
           Add a Key [reportName], Report Type [type], Report Title [title], Date Mode [int], Report Header [String], Report "Assignments' [String Array] and Report "Elements" [String Array] and Report Footer {String] to the 'reports' Map...
static java.lang.String[] XXXgetReferences()
           Return a String Array to represent a set of "References" for each 'jFormTK' Application report.
static java.lang.String XXXshowReferences(boolean dialog)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JReportWriter

JReportWriter()
Method Detail

addKey

public void addKey(java.lang.String key)

addReferences

public void addReferences(java.lang.String ref)

add

public static void add(java.lang.String reportName,
                       JReportData data)
        Add a Key, JReportData Ordered Pair to the 'reports' Map...

        Kernel Usage:
        1)      'Main.build_ReportWriter' Method while processing the
                'loadReportWriter_Parameters' OVERLOAD Method provided by the 'jFormTK'
                Application Developer...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
data - 'JReportData' instance that describes the associated report...

XXXadd

public static void XXXadd(java.lang.String reportName)
        Add a Key [reportName] to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...

XXXadd

public static void XXXadd(java.lang.String reportName,
                          int type)
        Add a Key [reportName] and Report Type [type] to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
type - Report Type 'int'...

XXXadd

public static void XXXadd(java.lang.String reportName,
                          int type,
                          java.lang.String title)
        Add a Key [reportName], Report Type [type] and Report Title to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
type - Report Type [int]...
title - Report Title [String]...

XXXadd

public static void XXXadd(java.lang.String reportName,
                          int type,
                          java.lang.String title,
                          int dateMode)
        Add a Key [reportName], Report Type [type], Report Title [title] and 
        Date Mode [int] to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
type - Report Type [int]...
title - Report Title [String]...
dateMode - Date ptresentation Mode [int]...

add

public static void add(java.lang.String reportName,
                       int type,
                       java.lang.String title,
                       int dateMode,
                       java.lang.String header)
        Add a Key [reportName], Report Type [type], Report Title [title], 
        Date Mode [int] and Report Header [String] to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
type - Report Type [int]...
title - Report Title [String]...
dateMode - Date ptresentation Mode [int]...
header - Report Header [String]...

XXXadd

public static void XXXadd(java.lang.String reportName,
                          int type,
                          java.lang.String title,
                          int dateMode,
                          java.lang.String header,
                          java.lang.String[] assignments)
        Add a Key [reportName], Report Type [type], Report Title [title], 
        Date Mode [int], Report Header [String] and Report "Assignments' [String Array]
        to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
type - Report Type [int]...
title - Report Title [String]...
dateMode - Date ptresentation Mode [int]...
header - Report Header [String]...
assignments - Report Assignments [String Array]...

XXXadd

public static void XXXadd(java.lang.String reportName,
                          int type,
                          java.lang.String title,
                          int dateMode,
                          java.lang.String header,
                          java.lang.String[] assignments,
                          java.lang.String[] elements)
        Add a Key [reportName], Report Type [type], Report Title [title], 
        Date Mode [int], Report Header [String], Report "Assignments' [String Array] and
        Report "Elements" [String Array] to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
type - Report Type [int]...
title - Report Title [String]...
dateMode - Date ptresentation Mode [int]...
header - Report Header [String]...
assignments - Report Assignments [String Array]...
elements - Report Elements [String Array]...

XXXadd

public static void XXXadd(java.lang.String reportName,
                          int type,
                          java.lang.String title,
                          int dateMode,
                          java.lang.String header,
                          java.lang.String[] assignments,
                          java.lang.String[] elements,
                          java.lang.String footer)
        Add a Key [reportName], Report Type [type], Report Title [title], 
        Date Mode [int], Report Header [String], Report "Assignments' [String Array] and
        Report "Elements" [String Array] and Report Footer  {String] to the 'reports' Map...

        Kernel Usage:
        1)      None...
        

Parameters:
reportName - Report Name, i.e.Map key [String]...
type - Report Type [int]...
title - Report Title [String]...
dateMode - Date ptresentation Mode [int]...
header - Report Header [String]...
assignments - Report Assignments [String Array]...
elements - Report Elements [String Array]...
footer - Report Footer [String]...

getAccessControl

public static java.lang.String getAccessControl(java.lang.String reportName)
        Get the 'Access Control' from the 'JReportData' instance of the given 'reportName'...
        

Parameters:
reportName - The Report Name String [key]...
Returns:
The 'reportName.ReportData' 'Access Control' String...

getDateMode

public static int getDateMode(java.lang.String reportName)
        Get the 'Date Mode' from the 'JReportData' instance of the given 'reportName'...
        

Parameters:
reportName - The Report Name String [key]...
Returns:
The 'reportName.ReportData' 'Date Mode' String...

getElements

public static java.lang.String[] getElements(java.lang.String reportName)
        Get the 'Elements' from the 'JReportData' instance of the given 'reportName'...
        

Parameters:
reportName - The Report Name String [key]...
Returns:
The 'reportName.ReportData' 'Elements' String...

getFooter

public static java.lang.String getFooter(java.lang.String reportName)
        Get the 'Footer' from the 'JReportData' instance of the given 'reportName'...
        

Parameters:
reportName - The Report Name String [key]...
Returns:
The 'reportName.ReportData' 'Footer' String...

getHeader

public static java.lang.String getHeader(java.lang.String reportName)
        Get the 'Header' from the 'JReportData' instance of the given 'reportName'...
        

Parameters:
reportName - The Report Name String [key]...
Returns:
The 'reportName.ReportData' 'Header' String...

getKeys

public java.lang.String[] getKeys()
        Return a String Array to represent a set of "Keys" for each 'jFormTK'
        Application report...

        Kernel Usage:
        1)      'this.show' to Get a collection of Report Name Keys to be used to
                traverse the 'reports' Tree whild building the 'show' display String...
        

Returns:
String Array to represent a set of "Keys"...

XXXgetReferences

public static java.lang.String[] XXXgetReferences()
        Return a String Array to represent a set of "References" for each 'jFormTK'
        Application report. These references were setup at load time by extracting
        each Dynamic Reference from the 'assignments' and 'elements' controls. These
        references are used to determine if the associated report may be requested by
        the 'jFormTK' Application End User...

        Kernel Usage:
        1)      'this.show' to Get a collection of Report Name Keys to be used to
                traverse the 'reports' Tree whild building the 'show' display String...
        

Returns:
String array with an element for each "Report". Each array element contains a list of Dynamic References using the JFormTKDB.itemsDelimiter.

getTitle

public static java.lang.String getTitle(java.lang.String reportName)
        Get the 'Title' from the 'JReportData' instance of the given 'reportName'...
        

Parameters:
reportName - The Report Name String [key]...
Returns:
The 'reportName.ReportData' 'Title' String...

getType

public static int getType(java.lang.String reportName)
        Get the 'Type' from the 'JReportData' instance of the given 'reportName'...
        

Parameters:
reportName - The Report Name String [key]...
Returns:
The 'reportName.ReportData' 'Type' String...

setAccessControl

public static void setAccessControl(java.lang.String reportName,
                                    java.lang.String accessControl)
        Set the 'Access Control' from the 'JReportData' instance for the 'reportName' TreeMap key...
        

Parameters:
reportName - The Report Name String [key]...
accessControl - Access Control Value [String]...

setDateMode

public static void setDateMode(java.lang.String reportName,
                               int dateMode)
        Set the 'Date Mode' from the 'JReportData' instance for the 'reportName' TreeMap key...
        

Parameters:
reportName - The Report Name String [key]...
dateMode - Date Mode Value [int]...

setElements

public static void setElements(java.lang.String reportName,
                               java.lang.String[] elementsArray)
        Set the 'Elements' from the 'JReportData' instance for the 'reportName' TreeMap key...
        

Parameters:
reportName - The Report Name String [key]...
elementsArray - Elements Value [String Array]...

setFooter

public static void setFooter(java.lang.String reportName,
                             java.lang.String footer)
        Set the 'Footer' from the 'JReportData' instance for the 'reportName' TreeMap key...
        

Parameters:
reportName - The Report Name String [key]...
footer - Footer Value [String]...

setHeader

public static void setHeader(java.lang.String reportName,
                             java.lang.String header)
        Set the 'Header' from the 'JReportData' instance for the 'reportName' TreeMap key...
        

Parameters:
reportName - The Report Name String [key]...
header - Header Value [String]...

setTitle

public static void setTitle(java.lang.String reportName,
                            java.lang.String title)
        Set the 'Title' from the 'JReportData' instance for the 'reportName' TreeMap key...
        

Parameters:
reportName - The Report Name String [key]...
title - Title Value [String]...

setType

public static void setType(java.lang.String reportName,
                           int type)
        Set the 'Type' from the 'JReportData' instance for the 'reportName' TreeMap key...
        

Parameters:
reportName - The Report Name String [key]...
type - Type Value [int]...

show

public static void show()
        Display a message dialog that details the 'JReportWriter' parameters for
        each Report of the current 'jFormTK' Application...

        Kernel Usage:
        1)      'BasejFormTK.Menu.actionPerformed' method when the End User has selected
                the "Show 'Report Wriiter' Parameters..." option from the Debug.Run-Time Status'
                Menu...
        2)      Used for DEBUG purposes as required...
        


XXXshowReferences

public static java.lang.String XXXshowReferences(boolean dialog)

showReport

public static java.lang.String showReport(java.lang.String reportName,
                                          boolean showDialog)