Preface

This user's guide describes the Oracle JPublisher utility, which translates user-defined SQL object types and PL/SQL packages to Java classes. SQLJ and JDBC programmers who need to have Java classes in their applications to correspond to object types, VARRAY types, nested table types, object reference types, or PL/SQL packages can use the JPublisher utility.

Intended Audience

This manual assumes that you are an experienced Java programmer with knowledge of Oracle databases, SQL, PL/SQL, JDBC, and SQLJ.

Structure

This manual contains the following chapters:

• Chapter 1, "Understanding and Using JPublisher"--Introduces the JPublisher utility and provides an overview of its operations, including details regarding datatype mappings, generation of output classes, and support for inheritance.

• Chapter 2, "Command-Line Options and Input Files"--Describes the JPublisher command line, command line options, and input files.

• Chapter 3, "JPublisher Examples"--Presents examples of JPublisher output for object types and wrapper methods.

Related Documents

See the following additional documents available from the Oracle Java Platform group:

• Oracle9i JDBC Developer's Guide and Reference

  This book covers programming syntax and features of Oracle's implementation of the JDBC standard (for Java Database Connectivity). This includes an overview of the Oracle JDBC drivers, details of Oracle's implementation of JDBC 1.22 and 2.0 features, and discussion of Oracle JDBC type extensions and performance extensions.

• Oracle9i SQLJ Developer's Guide and Reference

  This book covers the use of SQLJ to embed static SQL operations directly into Java code, covering SQLJ language syntax and SQLJ translator options and features. Both standard SQLJ features and Oracle-specific SQLJ features are described.

• Oracle9i Java Developer's Guide

  This book introduces the basic concepts of Java in Oracle9i and provides general information about server-side configuration and functionality. Information that pertains to the Oracle Java platform as a whole, rather than to a particular product (such as JDBC, SQLJ, or EJBs), is in this book.

• Oracle9i Servlet Engine Developer's Guide

  This book documents use of the Oracle9i Servlet Engine, the servlet container in Oracle9i.

• Oracle JavaServer Pages Developer's Guide and Reference

  This book covers the use of JavaServer Pages technology to embed Java code and JavaBean invocations inside HTML pages. Both standard JSP features and Oracle-specific features are described.

• Oracle9i Java Tools Reference

  This book documents Java-related tools and utilities for use with Oracle9i or in deploying applications to Oracle9i (such as the session shell and loadjava tools).

• Oracle9i Java Stored Procedures Developer's Guide

  This book discusses Java stored procedures--programs that run directly in Oracle9i. With stored procedures (functions, procedures, triggers, and SQL methods), Java developers can implement business logic at the server level, thereby improving application performance, scalability, and security.

• Oracle9i Enterprise JavaBeans Developer's Guide and Reference

  This book describes Oracle's Enterprise JavaBeans implementation and extensions.

• Oracle9i CORBA Developer's Guide and Reference

  This book describes Oracle's CORBA implementation and extensions.

The following documents from the Oracle Server Technologies group also contain information of interest and are referred to.

• Oracle9i SQL Reference

  This reference book contains a complete description of the content and syntax of the Structured Query Language (SQL) used to manage information in an Oracle database.

• PL/SQL User's Guide and Reference

  PL/SQL is Oracle's procedural extension to SQL. An advanced fourth-generation programming language, PL/SQL offers seamless SQL access, tight integration with the Oracle server and tools, portability, security, and features such as data encapsulation, overloading, exception handling, and information hiding. This guide explains the concepts behind PL/SQL and illustrates facets of the language.

Information about JDBC is also available at the following Sun Microsystems Web site:

http://java.sun.com/products/jdk/1.2/docs/guide/jdbc/

In particular, refer to the following Sun Microsystems specifications:

• JDBC 2.0 API

• JDBC 2.0 Standard Extension API

Conventions

This book uses Solaris syntax. However, file names and directory names for Windows NT are the same, unless otherwise noted.

The term [ORACLE_HOME] indicates the full path of the Oracle home directory.

Additionally, this manual uses the following conventions.

Convention	Meaning
italicized regular text	Italicized regular text is used for emphasis or to indicate a term that is being defined or will be defined shortly.
. . .	Horizontal ellipsis points in sample code indicate the omission of a statement or statements or part of a statement. This is done when you would normally expect additional statements or code to appear, but such statements or code would not be related to the example.
code text	Code text within regular text indicates class names, object names, method names, variable names, Java types, Oracle datatypes, file names, and directory names.
italicized_code_text	Italicized code text in a program statement indicates something that must be provided by the user.
<italicized_code_text >	Angle brackets enclosing italicized code text in a program statement indicates something that can optionally be provided by the user.

For more information, see "Notational Conventions".

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at:

http://www.oracle.com/accessibility/

JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.