BBJasperDesign

java.lang.Object
- BBJasper.BBJasperDesign

```
public class BBJasperDesign
extends Object
```
A BBj wrapper class for designing a dynamic BBJasper report.
There is also a CALL interface using ::bbjasperdesigner.bbj::generateReport with the following ENTER parameters: p_report! : (out) The generated JasperReport Object p_baseTemplate$: (in) Template file path used to generate the JRXML file p_jrxmlFile$ : (in) Name of the JRXML file to be generated (defaults to 'SampleDesign.jrxml') p_reportName$ : (in) The name of the report (defaults to 'SampleDesign') p_colMapVec! : (in) Vector of column hashmaps, each containing the column's attributes (NAME, LABEL, LENGTH, TYPE, MASK, JUSTIFICATION, EXPRESSION) p_templateType$: (in) Type of template, where P = Portrait tabular, L = Landscape tabular, C = Columnar, defaulting to 'P'

Field Summary

Fields
Modifier and Type Field and Description

JasperDesign JasperDesign!

Fields
Modifier and Type	Field and Description
`JasperDesign`	`JasperDesign!`

Constructor Summary

Constructors
Constructor and Description
`BBJasperDesign(BBJasperTemplate p_template!)` Constructs a BBJasperDesign object with a given BBJasperTemplate
`BBJasperDesign(BBJasperTemplate p_template!, BBjString p_connectString$, BBjString p_query$)` Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string and SQL query
`BBJasperDesign(BBJasperTemplate p_template!, BBjString p_connectString$, BBjString p_query$, BBjVector p_fields!)` Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string, SQL query and fields vector

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(BBjString column_name$)` Adds a column given just its name
`void`	`addColumn(BBjString column$, BBjString label$, BBjNumber length, BBjString type$, BBjString mask$, BBjString justification$, BBjString expression$)` Adds a column with all of its attributes
`void`	`addGroup(BBjString column_name$)` Adds a group given just its column name (ie.
`BBJasperReport`	`createReport(BBjString p_reportName$, BBjString p_reportFile$)` Creates and returns a BBJasperReport using no SQL result set
`BBJasperReport`	`createReport(BBjString p_reportName$, BBjString p_reportFile$, ResultSet p_rs!)` Creates and returns a BBJasperReport using an SQL result set
`JRDesignStaticText`	`findStaticTextElement(JRElementGroup parent!, String exp!)` Finds a static text element in the passed element group
`JRDesignTextField`	`findTextFieldElement(JRElementGroup band!, String exp!)` Finds a text field element in the passed element group
`BBjVector`	`getBands()` Returns all the bands in the JasperDesign object
`BBjVector`	`getColumns()` Returns the columns
`BBjString`	`getConnectString()` Returns the connect string
`BBjVector`	`getElements(JRElementGroup group!)` Returns all the design elements in the passed element group
`BBjVector`	`getGroups()` Returns the groups
`JasperDesign`	`getJasperDesign()` Returns the JasperDesign object
`BBjString`	`getQuery()` Returns the SQL query string
`BBjString`	`getQueryLanguage()` Returns the query language string, e.g.
`BBjString`	`getReportFile()` Returns the report file path
`BBjString`	`getReportName()` Returns the report name
`BBjString`	`getTable()` Returns the table name
`BBJasperTemplate`	`getTemplate()` Returns the BBJasperTemplate object
`static void`	`runDemo()` Run a demo of BBJasperDesign with user selected parameters
`static void`	`runDemo2()` Run a demo of BBJasperDesign with fixed fields and a memory record set
`static void`	`runDemo3()` Run a free-form demo of BBJasperDesign using hard-coded layout and the ChileCompany database
`void`	`setColumnAttributes(BBjString column$, BBjString label$, BBjNumber length, BBjString type$, BBjString mask$, BBjString justification$, BBjString expression$)` Sets all of a column's attributes
`void`	`setColumnExpression(BBjString column$, BBjString expression$)` Sets a column's expression
`void`	`setColumnJustification(BBjString column$, BBjString justification$)` Sets a column's justification
`void`	`setColumnLabel(BBjString column$, BBjString label$)` Sets a column's label
`void`	`setColumnLength(BBjString column$, BBjNumber length)` Sets a column's output length
`void`	`setColumnMask(BBjString column$, BBjString mask$)` Sets a column's output mask
`void`	`setColumnType(BBjString column$, BBjString type$)` Sets a column's type

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JasperDesign!
```
public JasperDesign JasperDesign!
```
- Constructor Detail
  - BBJasperDesign
```
public BBJasperDesign(BBJasperTemplate p_template!)
```
    Constructs a BBJasperDesign object with a given BBJasperTemplate
    
    Parameters:
    
    p_template! - BBJasperTemplate object
  - BBJasperDesign
```
public BBJasperDesign(BBJasperTemplate p_template!,
BBjString p_connectString$,
BBjString p_query$)
```
    Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string and SQL query
    
    Parameters:
    
    p_template! - BBJasperTemplate object
    
    p_connectString$ - Database connection string
    
    p_query$ - SQL query string
  - BBJasperDesign
```
public BBJasperDesign(BBJasperTemplate p_template!,
BBjString p_connectString$,
BBjString p_query$,
BBjVector p_fields!)
```
    Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string, SQL query and fields vector
    
    Parameters:
    
    p_template! - BBJasperTemplate object
    
    p_connectString$ - Database connection string
    
    p_query$ - SQL query string
    
    p_fields! - Fields vector
- Method Detail
  - runDemo
```
public static void runDemo()
```
    Run a demo of BBJasperDesign with user selected parameters
  - runDemo2
```
public static void runDemo2()
```
    Run a demo of BBJasperDesign with fixed fields and a memory record set
  - runDemo3
```
public static void runDemo3()
```
    Run a free-form demo of BBJasperDesign using hard-coded layout and the ChileCompany database
  - addColumn
```
public void addColumn(BBjString column_name$)
```
    Adds a column given just its name
    
    Parameters:
    
    column_name$ - Column name
  - addColumn
```
public void addColumn(BBjString column$,
BBjString label$,
BBjNumber length,
BBjString type$,
BBjString mask$,
BBjString justification$,
BBjString expression$)
```
    Adds a column with all of its attributes
    
    Parameters:
    
    column$ - Column name
    
    label$ - Label text (optional, defaults to column name)
    
    length - Output length in pixels (optional, defaults to field length * 8)
    
    type$ - Data type (optional, template field type or "DATE", defaults to "C")
    
    mask$ - Output mask (optional, defaults to "best guess" Java pattern based on type)
    
    justification$ - (optional "R", "L", "C", defaults to �L� for types �C� and �O�, �C� for type �DATE�, else �R�)
    
    expression$ - (optional JRDesignExpression, defaults to "$F{" + name$ + "}")
  - addGroup
```
public void addGroup(BBjString column_name$)
```
    Adds a group given just its column name (ie. group has to be a column)
    
    Parameters:
    
    column_name$ - Column name
  - setColumnLabel
```
public void setColumnLabel(BBjString column$,
BBjString label$)
```
    Sets a column's label
    
    Parameters:
    
    column$ - Column name
    
    label$ - Label text
  - setColumnLength
```
public void setColumnLength(BBjString column$,
BBjNumber length)
```
    Sets a column's output length
    
    Parameters:
    
    column$ - Column name
    
    length - Output length in pixels
  - setColumnType
```
public void setColumnType(BBjString column$,
BBjString type$)
```
    Sets a column's type
    
    Parameters:
    
    column$ - Column name
    
    type$ - Type (one-character template type or "DATE")
  - setColumnMask
```
public void setColumnMask(BBjString column$,
BBjString mask$)
```
    Sets a column's output mask
    
    Parameters:
    
    column$ - Column name
    
    mask$ - Output mask
  - setColumnJustification
```
public void setColumnJustification(BBjString column$,
BBjString justification$)
```
    Sets a column's justification
    
    Parameters:
    
    column$ - Column name
    
    justification$ - Justification ("R", "L" or "C")
  - setColumnExpression
```
public void setColumnExpression(BBjString column$,
BBjString expression$)
```
    Sets a column's expression
    
    Parameters:
    
    column$ - Column name
    
    expression$ - JRDesignExpression expression string
  - setColumnAttributes
```
public void setColumnAttributes(BBjString column$,
BBjString label$,
BBjNumber length,
BBjString type$,
BBjString mask$,
BBjString justification$,
BBjString expression$)
```
    Sets all of a column's attributes
    
    Parameters:
    
    column$ - Column name
    
    label$ - Label text
    
    length - Output length in pixels
    
    type$ - Data type
    
    mask$ - Output mask
    
    justification$ -
    
    expression$ -
  - createReport
```
public BBJasperReport createReport(BBjString p_reportName$,
BBjString p_reportFile$)
```
    Creates and returns a BBJasperReport using no SQL result set
    
    Parameters:
    
    p_reportName$ - Report name
    
    p_reportFile$ - Report file path
    
    Returns:
    
    BBJasperReport object
  - createReport
```
public BBJasperReport createReport(BBjString p_reportName$,
BBjString p_reportFile$,
ResultSet p_rs!)
```
    Creates and returns a BBJasperReport using an SQL result set
    
    Parameters:
    
    p_reportName$ - Report name
    
    p_reportFile$ - Report file path
    
    p_rs! - SQL result set object
    
    Returns:
    
    BBJasperReport object
  - findStaticTextElement
```
public JRDesignStaticText findStaticTextElement(JRElementGroup parent!,
String exp!)
```
    Finds a static text element in the passed element group
    
    Parameters:
    
    parent! - Parent JRElementGroup
    
    exp! - Search expression string
    
    Returns:
    
    JRDesignStaticText object
  - findTextFieldElement
```
public JRDesignTextField findTextFieldElement(JRElementGroup band!,
String exp!)
```
    Finds a text field element in the passed element group
    
    Parameters:
    
    band! - JRElementGroup band
    
    exp! - Search expression string
    
    Returns:
    
    JRDesignTextField object
  - getBands
```
public BBjVector getBands()
```
    Returns all the bands in the JasperDesign object
    
    Returns:
    
    Vector of bands
  - getElements
```
public BBjVector getElements(JRElementGroup group!)
```
    Returns all the design elements in the passed element group
    
    Parameters:
    
    group! - JRElementGroup group
    
    Returns:
    
    Vector of JRDesignElement objects
  - getJasperDesign
```
public JasperDesign getJasperDesign()
```
    Returns the JasperDesign object
    
    Returns:
    
    JasperDesign object
  - getTemplate
```
public BBJasperTemplate getTemplate()
```
    Returns the BBJasperTemplate object
    
    Returns:
    
    BBJasperTemplate object
  - getConnectString
```
public BBjString getConnectString()
```
    Returns the connect string
    
    Returns:
    
    Connect string
  - getQuery
```
public BBjString getQuery()
```
    Returns the SQL query string
    
    Returns:
    
    SQL Query string
  - getQueryLanguage
```
public BBjString getQueryLanguage()
```
    Returns the query language string, e.g. "SQL"
    
    Returns:
    
    Query language string
  - getColumns
```
public BBjVector getColumns()
```
    Returns the columns
    
    Returns:
    
    Vector of columns
  - getGroups
```
public BBjVector getGroups()
```
    Returns the groups
    
    Returns:
    
    Vector of groups
  - getReportFile
```
public BBjString getReportFile()
```
    Returns the report file path
    
    Returns:
    
    Report file path
  - getReportName
```
public BBjString getReportName()
```
    Returns the report name
    
    Returns:
    
    Report name
  - getTable
```
public BBjString getTable()
```
    Returns the table name
    
    Returns:
    
    Table name

Class BBJasperDesign

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JasperDesign!

Constructor Detail

BBJasperDesign

BBJasperDesign

BBJasperDesign

Method Detail

runDemo

runDemo2

runDemo3

addColumn

addColumn

addGroup

setColumnLabel

setColumnLength

setColumnType

setColumnMask

setColumnJustification

setColumnExpression

setColumnAttributes

createReport

createReport

findStaticTextElement

findTextFieldElement

getBands

getElements

getJasperDesign

getTemplate

getConnectString

getQuery

getQueryLanguage

getColumns

getGroups

getReportFile

getReportName

getTable