BBJasperDesign

```
public class BBJasperDesign
```
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'

See Also:
[]

Field Summary
Fields
Modifier and Type Field and Description
net.sf.jasperreports.engine.design.JasperDesign JasperDesign!

Fields
Modifier and Type	Field and Description
`net.sf.jasperreports.engine.design.JasperDesign`	`JasperDesign!`

Constructor Summary

Constructors
Constructor and Description
`BBJasperDesign(BBJasperTemplate p_template!)` Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate
`BBJasperDesign(BBJasperTemplate p_template!, BBjString p_connectString$, BBjString p_query$)` Constructor 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!)` Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string, SQL query and fields vector

Method Summary

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

Field Detail

JasperDesign!

public net.sf.jasperreports.engine.design.JasperDesign JasperDesign!

Constructor Detail
- BBJasperDesign
```
public BBJasperDesign(BBJasperTemplate p_template!)
```
  Constructor 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$)
```
  Constructor 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!)
```
  Constructor 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
  - addColumn
```
public void addColumn(BBjString column_name$)
```
    addColumn 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$)
```
    addColumn 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$)
```
    addGroup Adds a group given just its column name (ie. group has to be a column)
    
    Parameters:
    column_name$ Column name
  - createReport
```
public BBJasperReport createReport(BBjString p_reportName$, BBjString p_reportFile$)
```
    createReport 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$, java.sql.ResultSet p_rs!)
```
    createReport 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 net.sf.jasperreports.engine.design.JRDesignStaticText findStaticTextElement(net.sf.jasperreports.engine.JRElementGroup parent!, java.lang.String exp!)
```
    findStaticTextElement Finds a static text element in the passed element group
    
    Parameters:
    parent! Parent JRElementGroup
    exp! Search expression string
    Returns:
    JRDesignStaticText object
  - findTextFieldElement
```
public net.sf.jasperreports.engine.design.JRDesignTextField findTextFieldElement(net.sf.jasperreports.engine.JRElementGroup band!, java.lang.String exp!)
```
    findTextFieldElement 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()
```
    getBands Returns all the bands in the JasperDesign object
    
    Returns:
    Vector of bands
  - getColumns
```
public BBjVector getColumns()
```
    getColumns Returns the columns
    
    Returns:
    Vector of columns
  - getConnectString
```
public BBjString getConnectString()
```
    getConnectString Returns the connect string
    
    Returns:
    Connect string
  - getElements
```
public BBjVector getElements(net.sf.jasperreports.engine.JRElementGroup group!)
```
    getElements Returns all the design elements in the passed element group
    
    Parameters:
    group! JRElementGroup group
    Returns:
    Vector of JRDesignElement objects
  - getGroups
```
public BBjVector getGroups()
```
    getGroups Returns the groups
    
    Returns:
    Vector of groups
  - getJasperDesign
```
public net.sf.jasperreports.engine.design.JasperDesign getJasperDesign()
```
    getJasperDesign Returns the JasperDesign object
    
    Returns:
    JasperDesign object
  - getQuery
```
public BBjString getQuery()
```
    getQuery Returns the SQL query string
    
    Returns:
    SQL Query string
  - getQueryLanguage
```
public BBjString getQueryLanguage()
```
    getQueryLanguage Returns the query language string, e.g. "SQL"
    
    Returns:
    Query language string
  - getReportFile
```
public BBjString getReportFile()
```
    getReportFile Returns the report file path
    
    Returns:
    Report file path
  - getReportName
```
public BBjString getReportName()
```
    getReportName Returns the report name
    
    Returns:
    Report name
  - getTable
```
public BBjString getTable()
```
    getTable Returns the table name
    
    Returns:
    Table name
  - getTemplate
```
public BBJasperTemplate getTemplate()
```
    getTemplate Returns the BBJasperTemplate object
    
    Returns:
    BBJasperTemplate object
  - runDemo
```
public static void runDemo()
```
    runDemo Run a demo of BBJasperDesign with user selected parameters
  - runDemo2
```
public static void runDemo2()
```
    runDemo2 Run a demo of BBJasperDesign with fixed fields and a memory record set
  - runDemo3
```
public static void runDemo3()
```
    runDemo3 Run a free-form demo of BBJasperDesign using hard-coded layout and the ChileCompany database
  - setColumnAttributes
```
public void setColumnAttributes(BBjString column$, BBjString label$, BBjNumber length, BBjString type$, BBjString mask$, BBjString justification$, BBjString expression$)
```
    setColumnAttributes 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$
  - setColumnExpression
```
public void setColumnExpression(BBjString column$, BBjString expression$)
```
    setColumnExpression Sets a column's expression
    
    Parameters:
    column$ Column name
    expression$ JRDesignExpression expression string
  - setColumnJustification
```
public void setColumnJustification(BBjString column$, BBjString justification$)
```
    setColumnJustification Sets a column's justification
    
    Parameters:
    column$ Column name
    justification$ Justification ("R", "L" or "C")
  - setColumnLabel
```
public void setColumnLabel(BBjString column$, BBjString label$)
```
    setColumnLabel Sets a column's label
    
    Parameters:
    column$ Column name
    label$ Label text
  - setColumnLength
```
public void setColumnLength(BBjString column$, BBjNumber length)
```
    setColumnLength Sets a column's output length
    
    Parameters:
    column$ Column name
    length Output length in pixels
  - setColumnMask
```
public void setColumnMask(BBjString column$, BBjString mask$)
```
    setColumnMask Sets a column's output mask
    
    Parameters:
    column$ Column name
    mask$ Output mask
  - setColumnType
```
public void setColumnType(BBjString column$, BBjString type$)
```
    setColumnType Sets a column's type
    
    Parameters:
    column$ Column name
    type$ Type (one-character template type or "DATE")

Class BBJasperDesign

Field Summary

Constructor Summary

Method Summary

Field Detail

JasperDesign!

Constructor Detail

BBJasperDesign

BBJasperDesign

BBJasperDesign

Method Detail

addColumn

addColumn

addGroup

createReport

createReport

findStaticTextElement

findTextFieldElement

getBands

getColumns

getConnectString

getElements

getGroups

getJasperDesign

getQuery

getQueryLanguage

getReportFile

getReportName

getTable

getTemplate

runDemo

runDemo2

runDemo3

setColumnAttributes

setColumnExpression

setColumnJustification

setColumnLabel

setColumnLength

setColumnMask

setColumnType