Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## jet.bean
Class JRPrepareViewer

    java.lang.Object
      jet.bean.JRPrepareViewer

All Implemented Interfaces:
  java.io.Externalizable, java.io.Serializable

    public class JRPrepareViewer

extends java.lang.Object
implements java.io.Externalizable

See Also:
  Serialized Form

Field Summary
`static int` | `vDebug` Indicates to open the debug.
`static int` | `vError` Indicates to open the error.
`static int` | `vOff` Indicates to close the debug.

Constructor Summary
`JRPrepareViewer()` The default constructor.

Method Summary
`java.lang.String` | `getCatName()` Gets the catalog name.
`java.lang.String` | `getFullPath()` Gets the full path for JReport Enterprise Servlet.
`java.lang.String` | `getLoadReport()`
`java.util.Locale` | `getLocale()` Gets the locale.
`java.lang.String` | `getPassword()` Gets the password to log in JReport Enterprise Server.
`boolean` | `getPopupErrorDialog()` Get the value about whether popup error message dialog.
`boolean` | `getPopupParamDialog()` Gets the status whether to pop up the parameter dialog or not when running a report.
`java.lang.String` | `getPort()` Gets the port number.
`java.lang.String` | `getProxyHost()` Returns the proxy host name or IP address.
`java.lang.String` | `getProxyPassword()` Returns the password to log in the proxy server if needed.
`java.lang.String` | `getProxyPort()` Returns the proxy port number.
`java.lang.String` | `getProxyUser()` Returns the user name to log in the proxy server.
`java.lang.String` | `getReportName()` Gets the report name.
`java.util.Vector` | `getReportParams()` Gets the parameters of the current report.
`java.util.Vector` | `getReports()` Returns all reports under the current catalog directory in JReport Enterprise Server.
`java.lang.String` | `getServerName()` Gets the server name or IP address where the report runs.
`boolean` | `getSSL()` Get current SSL states
`java.lang.String` | `getStatus()` Gets the status after an action.
`java.lang.String` | `getUserName()` Gets the user name to log in JReport Enterprise Server.
`void` | `logout()` Enables to log out from JReport Enterprise Server.
`void` | `prepareRun()` Launches to run JReport Viewer Bean.
`void` | `readExternal(java.io.ObjectInput in)`
`void` | `setCatalogVersion(int verNumber)` Sets the catalog version number.
`void` | `setCatName(java.lang.String catName)` Sets the catalog name.
`void` | `setConnection(java.lang.String strURL, java.lang.String strUID, java.lang.String strPSWD, java.lang.String strJdbcDriver)` Sets the connection required to run the engine.
`void` | `setFullPath(java.lang.String fullPath)` Sets the full path for JReport Enterprise Servlet.
`void` | `setLanguage(java.lang.String rptLanguage)` Sets language and converts to a Locale object.
`void` | `setLoadReport(java.lang.String loadReport)` Enables/disables to run the report.
`void` | `setLocale(java.util.Locale loc)` Sets the locale.
`boolean` | `setLogFile(java.lang.String fileName)` Sets the log file.
`void` | `setPassword(java.lang.String password)` Sets the password to log in JReport Enterprise Server.
`void` | `setPopupErrorDialog(boolean isPopup)` Allow user to set whether popup the error message dialog while Exception occur.
`void` | `setPopupParamDialog(boolean bPopupDialog)` Indicates whether to pop up the parameter dialog when running a report.
`void` | `setPort(java.lang.String port)` Sets the port number.
`void` | `setProxyHost(java.lang.String proxyHost)` Sets the proxy host name or IP address if needed.
`void` | `setProxyPassword(java.lang.String proxyPassword)` Sets the password to log in the proxy server if needed.
`void` | `setProxyPort(java.lang.String proxyPort)` Sets the proxy port number.
`void` | `setProxyUser(java.lang.String proxyUserName)` Sets the user name to log in the proxy server if needed.
`void` | `setReportName(java.lang.String reportName)` Sets the report name.
`void` | `setReportVersion(int verNumber)` Sets the report version number.
`void` | `setServerName(java.lang.String serverName)` Sets the server name or IP address.
`void` | `setShowInfoLevel(int level)` Enables/disables output error and debug message.
`void` | `setSSL(boolean SSL)` Set the connection to use SSL or not
`void` | `setUserName(java.lang.String userName)` Sets the user name to log in JReport Enterprise Server.
`void` | `writeExternal(java.io.ObjectOutput out)`

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

Field Detail

### vOff

    public static final int vOff

  Indicates to close the debug.

### vDebug

    public static final int vDebug

  Indicates to open the debug.

### vError

    public static final int vError

  Indicates to open the error.

Constructor Detail

### JRPrepareViewer

    public JRPrepareViewer()

  The default constructor.

Method Detail

### setPopupParamDialog

    public void setPopupParamDialog(boolean bPopupDialog)

  Indicates whether to pop up the parameter dialog when running a report.

  Parameters:
    `bPopupDialog` - if it is true, then the parameter dialog will be activated.

### getPopupParamDialog

    public boolean getPopupParamDialog()

  Gets the status whether to pop up the parameter dialog or not when running a report.

### setPopupErrorDialog

    public void setPopupErrorDialog(boolean isPopup)

  Allow user to set whether popup the error message dialog while Exception occur.

  Parameters:
    `isPopup,` - the value is "true" indicate to popup error message dialog, otherwise don't popup.

### getPopupErrorDialog

    public boolean getPopupErrorDialog()

  Get the value about whether popup error message dialog.

  Parameters:
    `isPopup,` - the value is "true" indicate to popup error message dialog, otherwise don't popup.

### setServerName

    public void setServerName(java.lang.String serverName)

  Sets the server name or IP address.

  Parameters:
    `serverName` - the name of the server where the report runs.

### getServerName

    public java.lang.String getServerName()

  Gets the server name or IP address where the report runs.

  Returns:
    serverName the name or address of the current server.

### setPort

    public void setPort(java.lang.String port)

  Sets the port number.

  Parameters:
    `port` - the port number.

### getPort

    public java.lang.String getPort()

  Gets the port number.

  Returns:
    the port number.

### setLocale

    public void setLocale(java.util.Locale loc)

  Sets the locale.

### setLanguage

    public void setLanguage(java.lang.String rptLanguage)

  Sets language and converts to a Locale object.

### getLocale

    public java.util.Locale getLocale()

  Gets the locale.

### setFullPath

    public void setFullPath(java.lang.String fullPath)

  Sets the full path for JReport Enterprise Servlet.

  Parameters:
    `fullPath` - if you access JReport Enterprise Servlet, you must set the servlet path also, for example: setFullPath("/Jinfonet_Sybase/JReport");

### getFullPath

    public java.lang.String getFullPath()

  Gets the full path for JReport Enterprise Servlet.

  Returns:
    the full path.

### setConnection

    public void setConnection(java.lang.String strURL,
                              java.lang.String strUID,
                              java.lang.String strPSWD,
                              java.lang.String strJdbcDriver)

  Sets the connection required to run the engine.

  Parameters:
    `strURL,` - the URL of the database.
    `strUID,` - the user id for the JDBC driver.
    `strPSWD,` - the password for the JDBC driver.
    `strJdbcDriver,` - the JdbcDriver.

### getReportName

    public java.lang.String getReportName()

  Gets the report name.

  Returns:
    the report name.

### setReportName

    public void setReportName(java.lang.String reportName)

  Sets the report name.

  Parameters:
    `reportName` - the report name.

### setReportVersion

    public void setReportVersion(int verNumber)

  Sets the report version number.

  Parameters:
    `verNumber` - the report version number. The default value is '-1', it means the last report version.

### setCatName

    public void setCatName(java.lang.String catName)

  Sets the catalog name.

  Parameters:
    `catName` - the catalog name.

### setCatalogVersion

    public void setCatalogVersion(int verNumber)

  Sets the catalog version number.

  Parameters:
    `verNumber` - the catalog version number. The default value is '-1', it means the last catalog version.

### getCatName

    public java.lang.String getCatName()

  Gets the catalog name.

  Returns:
    the catalog name

### setUserName

    public void setUserName(java.lang.String userName)

  Sets the user name to log in JReport Enterprise Server.

  Parameters:
    `userName` - the user name to log in JReport Enterprise Server.

### getUserName

    public java.lang.String getUserName()

  Gets the user name to log in JReport Enterprise Server.

  Returns:
    the user name to log in JReport Enterprise Server.

### setPassword

    public void setPassword(java.lang.String password)

  Sets the password to log in JReport Enterprise Server.

  Parameters:
    `password` - the password to log in JReport Enterprise Server.

### getPassword

    public java.lang.String getPassword()

  Gets the password to log in JReport Enterprise Server.

  Returns:
    the password to log in JReport Enterprise Server.

### setProxyUser

    public void setProxyUser(java.lang.String proxyUserName)

  Sets the user name to log in the proxy server if needed.

  Parameters:
    `proxyUserName` - the user name to log in the proxy server if needed.
  See Also:
    `setProxyPassword(java.lang.String)`

### getProxyUser

    public java.lang.String getProxyUser()

  Returns the user name to log in the proxy server.

  See Also:
    `getProxyPassword()`

### setProxyPassword

    public void setProxyPassword(java.lang.String proxyPassword)

  Sets the password to log in the proxy server if needed.

  Parameters:
    `proxyPassword` - the password to log in the proxy server if needed.
  See Also:
    `setProxyUser(java.lang.String)`

### getProxyPassword

    public java.lang.String getProxyPassword()

  Returns the password to log in the proxy server if needed.

  See Also:
    `getProxyUser()`

### setProxyHost

    public void setProxyHost(java.lang.String proxyHost)

  Sets the proxy host name or IP address if needed.

  Parameters:
    `proxyHost` - the proxy host name or IP address if needed.
  See Also:
    `setProxyPort(java.lang.String)`

### getProxyHost

    public java.lang.String getProxyHost()

  Returns the proxy host name or IP address.

  See Also:
    `getProxyPort()`

### setProxyPort

    public void setProxyPort(java.lang.String proxyPort)

  Sets the proxy port number.

  Parameters:
    `proxyPort` - the proxy port number.
  See Also:
    `setProxyHost(java.lang.String)`

### getProxyPort

    public java.lang.String getProxyPort()

  Returns the proxy port number.

  See Also:
    `getProxyHost()`

### getLoadReport

    public java.lang.String getLoadReport()

### setLoadReport

    public void setLoadReport(java.lang.String loadReport)

  Enables/disables to run the report.

  Parameters:
    `loadReport` - a String, if it equals "yes"(case insensitive) then the report will be run.

### prepareRun

    public void prepareRun()

  Launches to run JReport Viewer Bean.

### getReports

    public java.util.Vector getReports()

  Returns all reports under the current catalog directory in JReport Enterprise Server.

  Returns:
    a Vector, each element is a String -- report name.

### writeExternal

    public void writeExternal(java.io.ObjectOutput out)
                       throws java.io.IOException

  Specified by:
    `writeExternal` in interface `java.io.Externalizable`
  Throws:
    `java.io.IOException`

### readExternal

    public void readExternal(java.io.ObjectInput in)
                      throws java.io.IOException,
                             java.lang.ClassNotFoundException

  Specified by:
    `readExternal` in interface `java.io.Externalizable`
  Throws:
    `java.io.IOException`
    `java.lang.ClassNotFoundException`

### getReportParams

    public java.util.Vector getReportParams()

  Gets the parameters of the current report.

  Returns:
    a Vector, each element in this Vector is a jet.cs.Param.

### logout

    public void logout()

  Enables to log out from JReport Enterprise Server.

### getStatus

    public java.lang.String getStatus()

  Gets the status after an action.

### setShowInfoLevel

    public void setShowInfoLevel(int level)

  Enables/disables output error and debug message.

  Parameters:
    `level` - the debug level, for example: vDebug | vError

### setLogFile

    public boolean setLogFile(java.lang.String fileName)

  Sets the log file.

  Parameters:
    `fileName` - the log file name

    LogFileName specifies where the debug, error and other information will go. LogFileName contains both the path and the file name. If no path is specified, the current path is used. If no file name is specified, the file jreport.log is used

  Returns:
    true if successful

### setSSL

    public void setSSL(boolean SSL)

  Set the connection to use SSL or not

  Parameters:
    `SSL` - boolean, indicate whether to use SSL connection

### getSSL

    public boolean getSSL()

  Get current SSL states

  Returns:
    boolean, indicate the current SSL states

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD