BBJasper

java.lang.Object
- BBJasper.BBJasper

```
public class BBJasper
extends Object
```
Provides utility functions for BBJasper modules

Since:

9.0

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjNumber`	`BUFFER_SIZE` Buffer size use to read in jrxml and jasper report files, default is 10 K
`static BBjNumber`	`MAX_FILE_SIZE` Max file size of jrxml and jasper report files, default is 10 MB

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`centerWindow(BBjWindow p_window!)` Centers the passed window on either the MDI window or client desktop
`static void`	`centerWindow(BBjWindow p_window!, BBjNumber p_centerOnActiveWindow)` Centers the passed window on either the MDI window, client desktop, or optionally on the active window (if there is one)
`static BBjNumber`	`clientFileExists(BBjString p_clientFileName$)` Determines is a client file exists or not
`static BBjNumber`	`copyToClient(BBjString p_serverFileName$, BBjString p_clientFileName$)` Copies the passed server file to the passed client file
`static void`	`createFileFromStream(BBjString p_filepath$, ByteArrayOutputStream p_baos!)` Creates a file given a filename and output stream
`static Locale`	`createLocale(BBjString p_localeString!)` Creates a java Locale object from the passed string
`static BBjString`	`createTempDir()` Creates a temp directory and returns the path
`static BBjVector`	`createVector(Object p_object!)` Creates and returns a BBjVector for the passed object
`static Locale`	`getClientLocale()` Returns the locale used by the client
`static void`	`moveDir(BBjString p_localDir$, BBjString p_destDirectory$)` Moves a local directory.
`static void`	`moveFile(BBjString p_localFile$, BBjString p_destFile$)` Moves a local file.
`static void`	`run()` Runs bbjasper with the passed program args
`static void`	`runDemo()` Runs a demo of BBJasper
`static void`	`showUsage()` Shows the BBJasper usage
`static void`	`throwError(BBjString p_errorMessage$, BBjNumber p_errorNumber)` Throws the passed error message and error number
`static void`	`throwError(BBjString p_errorMessage$, BBjNumber p_errorNumber, BBjNumber p_lineNumber)` Throws the passed error message and error number.

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

- Field Detail
  - MAX_FILE_SIZE
```
public static BBjNumber MAX_FILE_SIZE
```
    Max file size of jrxml and jasper report files, default is 10 MB
  - BUFFER_SIZE
```
public static BBjNumber BUFFER_SIZE
```
    Buffer size use to read in jrxml and jasper report files, default is 10 K
- Method Detail
  - createVector
```
public static BBjVector createVector(Object p_object!)
```
    Creates and returns a BBjVector for the passed object
    
    Parameters:
    
    p_object! - object to create the vector for
    
    BBjVector - containing the passed object
    
    Since:
    
    16.0
  - throwError
```
public static void throwError(BBjString p_errorMessage$,
BBjNumber p_errorNumber)
```
    Throws the passed error message and error number
    
    Parameters:
    
    p_errorMessage$ - Error message to include in the error message
    
    p_errorNumber - Error number to include in the error message
  - throwError
```
public static void throwError(BBjString p_errorMessage$,
BBjNumber p_errorNumber,
BBjNumber p_lineNumber)
```
    Throws the passed error message and error number. Adds the line number, line code, and last exception (if available)
    
    Parameters:
    
    p_errorMessage$ - Error message to include in the error message
    
    p_errorNumber - Error number to include in the error message
    
    p_lineNumber - Program Line number of the line to include in the error message
  - getClientLocale
```
public static Locale getClientLocale()
```
    Returns the locale used by the client
    
    Returns:
    
    Client's Locale
  - createLocale
```
public static Locale createLocale(BBjString p_localeString!)
```
    Creates a java Locale object from the passed string
    
    Parameters:
    
    p_localeString! - Locale string. This string should be in the following format: LANGUAGE, LANGUAGE_COUNTRY, or LANGUAGE_COUNTRY_VARIANT
    
    Returns:
    
    If valid, returns the Locale object, otherwise null() is returned
  - createTempDir
```
public static BBjString createTempDir()
```
    Creates a temp directory and returns the path
    
    Returns:
    
    Created temp directory name
  - createFileFromStream
```
public static void createFileFromStream(BBjString p_filepath$,
ByteArrayOutputStream p_baos!)
```
    Creates a file given a filename and output stream
    
    Parameters:
    
    p_filepath$ - Name of file to create
    
    p_baos! - ByteArrayOutputStream object which contains the contents of the file
  - moveDir
```
public static void moveDir(BBjString p_localDir$,
BBjString p_destDirectory$)
```
    Moves a local directory. The directory can be moved accross machines when DS syntax is used for a destination directory
    
    Parameters:
    
    p_localDir$ - Name of directory to move
    
    p_destDirectory$ - Name of destination directory
  - moveFile
```
public static void moveFile(BBjString p_localFile$,
BBjString p_destFile$)
```
    Moves a local file. The file can be moved accross machines when DS syntax is used for a destination directory
    
    Parameters:
    
    p_localFile$ - Name of local to move
    
    p_destFile$ - Name of destination file
  - clientFileExists
```
public static BBjNumber clientFileExists(BBjString p_clientFileName$)
```
    Determines is a client file exists or not
    
    Parameters:
    
    p_clientFileName$ - Name of client file to determine existance
    
    Returns:
    
    TRUE if the client file exists, otherwise FALSE
  - copyToClient
```
public static BBjNumber copyToClient(BBjString p_serverFileName$,
BBjString p_clientFileName$)
```
    Copies the passed server file to the passed client file
    
    Parameters:
    
    p_serverFileName$ - Name of source server file
    
    p_clientFileName$ - Name of target client file
    
    Returns:
    
    TRUE if the files is copied to the client, otherwise FALSE
  - centerWindow
```
public static void centerWindow(BBjWindow p_window!)
```
    Centers the passed window on either the MDI window or client desktop
    
    Parameters:
    
    p_window! - BBjWindow to center
  - centerWindow
```
public static void centerWindow(BBjWindow p_window!,
BBjNumber p_centerOnActiveWindow)
```
    Centers the passed window on either the MDI window, client desktop, or optionally on the active window (if there is one)
    
    Parameters:
    
    p_window! - BBjWindow to center
    
    p_centerOnActiveWindow - Specify TRUE if the window is to be centered on the currently active window, otheriwse FALSE
  - run
```
public static void run()
```
    Runs bbjasper with the passed program args
    Args are the following:
    arg1 (required) = report source file name
    arg2 (required) = connect string
    arg3 (optional) = locale
    arg4 (optional) = report params key/value pairs
  - showUsage
```
public static void showUsage()
```
    Shows the BBJasper usage
  - runDemo
```
public static void runDemo()
```
    Runs a demo of BBJasper

Class BBJasper

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_FILE_SIZE

BUFFER_SIZE

Method Detail

createVector

throwError

throwError

getClientLocale

createLocale

createTempDir

createFileFromStream

moveDir

moveFile

clientFileExists

copyToClient

centerWindow

centerWindow

run

showUsage

runDemo