From torque-dev-return-11995-apmail-db-torque-dev-archive=db.apache.org@db.apache.org Thu Oct 11 09:06:38 2012 Return-Path: X-Original-To: apmail-db-torque-dev-archive@www.apache.org Delivered-To: apmail-db-torque-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 02269DD42 for ; Thu, 11 Oct 2012 09:06:38 +0000 (UTC) Received: (qmail 81286 invoked by uid 500); 11 Oct 2012 08:55:14 -0000 Delivered-To: apmail-db-torque-dev-archive@db.apache.org Received: (qmail 81236 invoked by uid 500); 11 Oct 2012 08:55:13 -0000 Mailing-List: contact torque-dev-help@db.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Help: List-Post: List-Id: "Apache Torque Developers List" Reply-To: "Apache Torque Developers List" Delivered-To: mailing list torque-dev@db.apache.org Received: (qmail 78041 invoked by uid 500); 11 Oct 2012 08:53:05 -0000 Received: (qmail 77959 invoked by uid 99); 11 Oct 2012 08:52:57 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 11 Oct 2012 08:52:57 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 11 Oct 2012 08:52:51 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id C82652388C63; Thu, 11 Oct 2012 08:51:21 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1396951 [16/23] - in /db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/torque/ apidocs/org/apache/torque/mojo/ apidocs/org/apache/torque/mojo/class-use/... Date: Thu, 11 Oct 2012 08:51:14 -0000 To: torque-commits@db.apache.org From: tfischer@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121011085121.C82652388C63@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sql-mojo.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sql-mojo.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sql-mojo.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sql-mojo.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,397 @@ + + + + + + + + + + + + + + + Torque Maven2 Plugin - torque:sql + + + + + + + +
+ +
+
+
+

torque:sql

+

Full name:

+

org.apache.torque:torque-maven-plugin:3.3.1-SNAPSHOT:sql

+

Description:

+
Generates SQL for creating the database from the schema.xml files.

Attributes:

+
  • Requires a Maven 2.0 project to be executed.
  • +
  • Binds by default to the lifecycle phase: generate-sources.
  • +
+

Required Parameters

+ + + + + + + + + + + + + + + + + + + + +
NameTypeSinceDescription
schemaDirString-The path to the directory where the schema files are located in.
+
schemaIncludesString-The schema files which should be included in generation (in +ant-style notation).
+
targetDatabaseString-The database type (e.g. mysql, oracle, ...) for the generated +persistence classes,
+
+
+

Optional Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeSinceDescription
outputDirString-The directory in which the SQL will be generated.
+
reportFileString-The location where the report file will be generated.
+
contextPropertiesPathString-The location where the context property file for velocity will be +generated.
+
schemaExcludesString-The schema files which should be excluded in generation (in +ant-style notation).
+
suffixString-The suffix of the generated sql files.
+
runOnlyOnSchemaChangeboolean-Determines if this task should run only if the schema has changed.
+
sqlDbMapString-The path to the properties file containing the mapping sql file +-> target database.
+
targetPackageString-The target package for the generated classes.
+
templatePathString-The base path where the templates are read from, if they are not +read from the classpath.
+
useClasspathboolean-Whether the templates should be loaded from the classpath.
+
userContextPropertiesMap-A map where all user-defined context properties can be set. +Overrides all other mojo configuration settings which are mapped to +context properties.
+
+
+

Parameter Details

+

outputDir:

+
The directory in which the SQL will be generated.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ${project.build.directory}/generated-sql/torque
  • +
+
+

reportFile:

+
The location where the report file will be generated.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ../../torque/report.${project.artifact.artifactId}.sql.generation
  • +
+
+

contextPropertiesPath:

+
The location where the context property file for velocity will be +generated.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ${project.build.directory}/torque/context.sql.properties
  • +
+
+

schemaExcludes:

+
The schema files which should be excluded in generation (in +ant-style notation).
  • Type: java.lang.String
  • +
  • Required: No
  • +
+
+

suffix:

+
The suffix of the generated sql files.
  • Type: java.lang.String
  • +
  • Required: No
  • +
+
+

runOnlyOnSchemaChange:

+
Determines if this task should run only if the schema has changed.
  • Type: boolean
  • +
  • Required: No
  • +
  • Expression: true
  • +
+
+

schemaDir:

+
The path to the directory where the schema files are located in.
  • Type: java.lang.String
  • +
  • Required: Yes
  • +
  • Expression: ${basedir}/src/main/torque/schema
  • +
+
+

schemaIncludes:

+
The schema files which should be included in generation (in +ant-style notation).
  • Type: java.lang.String
  • +
  • Required: Yes
  • +
  • Expression: *schema.xml
  • +
+
+

sqlDbMap:

+
The path to the properties file containing the mapping sql file +-> target database.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ${project.build.directory}/torque/sqldbmap.properties
  • +
+
+

targetDatabase:

+
The database type (e.g. mysql, oracle, ...) for the generated +persistence classes,
  • Type: java.lang.String
  • +
  • Required: Yes
  • +
+
+

targetPackage:

+
The target package for the generated classes.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: torque.generated
  • +
+
+

templatePath:

+
The base path where the templates are read from, if they are not +read from the classpath.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ${basedir}/src/main/torque/templates
  • +
+
+

useClasspath:

+
Whether the templates should be loaded from the classpath.
  • Type: boolean
  • +
  • Required: No
  • +
  • Expression: true
  • +
+
+

userContextProperties:

+
A map where all user-defined context properties can be set. +Overrides all other mojo configuration settings which are mapped to +context properties.
  • Type: java.util.Map
  • +
  • Required: No
  • +
+
+
+ +
+
+
+
+
+ + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sqlExec-mojo.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sqlExec-mojo.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sqlExec-mojo.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/sqlExec-mojo.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,339 @@ + + + + + + + + + + + + + + + Torque Maven2 Plugin - torque:sqlExec + + + + + + + +
+ +
+
+
+

torque:sqlExec

+

Full name:

+

org.apache.torque:torque-maven-plugin:3.3.1-SNAPSHOT:sqlExec

+

Description:

+
Executes the generated SQL.

Attributes:

+
  • Requires a Maven 2.0 project to be executed.
  • +
  • Binds by default to the lifecycle phase: generate-sources.
  • +
+

Required Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeSinceDescription
driverString-The fully qualified class name of the database driver.
+
onErrorString-Tells the Mojo what to do if an sql error occurs during execution. +Can be either "continue", "stop" or "abort".
+
urlString-The connect URL of the database.
+
userString-The user name to connect to the database.
+
+
+

Optional Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeSinceDescription
autocommitboolean-Autocommit flag. Default value is true.
+
delimiterString-The SQL Statement delimiter.
+
delimiterTypeString-Whether the delimiter can be anywhere in the sql ("normal") or +needs to be in an extra row ("row").
+
passwordString-The password for the database user.
+
sqlDbMapString-The path to the properties file containing the mapping sql file +-> target database.
+
srcDirString-The source directory where to find the SQL files.
+
+
+

Parameter Details

+

autocommit:

+
Autocommit flag. Default value is true.
  • Type: boolean
  • +
  • Required: No
  • +
  • Expression: true
  • +
+
+

delimiter:

+
The SQL Statement delimiter.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ;
  • +
+
+

delimiterType:

+
Whether the delimiter can be anywhere in the sql ("normal") or +needs to be in an extra row ("row").
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: normal
  • +
+
+

driver:

+
The fully qualified class name of the database driver.
  • Type: java.lang.String
  • +
  • Required: Yes
  • +
+
+

onError:

+
Tells the Mojo what to do if an sql error occurs during execution. +Can be either "continue", "stop" or "abort".
  • Type: java.lang.String
  • +
  • Required: Yes
  • +
  • Expression: continue
  • +
+
+

password:

+
The password for the database user.
  • Type: java.lang.String
  • +
  • Required: No
  • +
+
+

sqlDbMap:

+
The path to the properties file containing the mapping sql file +-> target database.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ${project.build.directory}/torque/sqldbmap.properties
  • +
+
+

srcDir:

+
The source directory where to find the SQL files.
  • Type: java.lang.String
  • +
  • Required: No
  • +
  • Expression: ${project.build.directory}/generated-sql/torque
  • +
+
+

url:

+
The connect URL of the database.
  • Type: java.lang.String
  • +
  • Required: Yes
  • +
+
+

user:

+
The user name to connect to the database.
  • Type: java.lang.String
  • +
  • Required: Yes
  • +
+
+
+ +
+
+
+
+
+ + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/surefire-report.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/surefire-report.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/surefire-report.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/surefire-report.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,376 @@ + + + + + + + + + + + + + + + Torque Maven2 Plugin - Surefire Report + + + + + + + +
+ +
+
+
+

Surefire Report

+
+

Summary

+

[Summary] [Package List] [Test Cases]

+
+ + + + + + + + + + + + + + +
TestsErrors FailuresSkippedSuccess RateTime
201050%1.812
+
+

Note: failures are anticipated and checked for with assertions while errors are unanticipated.

+
+
+

Package List

+

[Summary] [Package List] [Test Cases]

+
+ + + + + + + + + + + + + + + + +
PackageTestsErrors FailuresSkippedSuccess RateTime
org.apache.torque.mojo201050%1.812
+
+

Note: package statistics are not computed recursively, they only sum up all of its testsuites numbers.

+

org.apache.torque.mojo

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClassTestsErrors FailuresSkippedSuccess RateTime
TorqueOMMojoTest10100%0.878
TorqueSQLMojoTest1000100%0.934
+
+
+
+

Test Cases

+

[Summary] [Package List] [Test Cases]

+

TorqueOMMojoTest

+ + + + + + + + + + + + +
testExecute 0.875
Project does not contain F:\java\torque3\maven2-plugin\target\test-classes\projects\TorqueOMMojoTest\target/generated-sources/torque as compile source
+
+

TorqueSQLMojoTest

+ + + + +
testExecute0.917
+
+
+
+

Failure Details

+

[Summary] [Package List] [Test Cases]

+
+ + + + + + + + + +
testExecute
junit.framework.AssertionFailedError: Project does not contain F:\java\torque3\maven2-plugin\target\test-classes\projects\TorqueOMMojoTest\target/generated-sources/torque as compile source
+
+
+ +
+
+
+
+
+ + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/taglist.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/taglist.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/taglist.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/taglist.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + Torque Maven2 Plugin - Tag List report + + + + + + + +
+ +
+
+
+

Tag List Report

+

The following document contains the listing of user tags found in the code. Below is the summary of the occurrences per tag.

+ + + + + + + + + +
TagTotal number of occurrences
@todo0
TODO0
+

Each tag is detailed below:

+
+ +
+
+
+
+
+ + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/team-list.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/team-list.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/team-list.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/team-list.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,462 @@ + + + + + + + + + + + + + + + Torque Maven2 Plugin - Team list + + + + + + + +
+ +
+
+
+

The Team

+

A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.

+

The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.

+

Members

+

The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IdNameEmailOrganizationRolesTime ZoneActual Time (GMT)
brekkeJeffrey D. Brekkebrekke@apache.org-Java Developer--
dobbsEric Dobbsdobbs@apache.org-Java Developer--
seadeScott Eadeseade@backstagetech.com.auBackstage Technologies Pty. Ltd.Java Developer+10+10
tfischerThomas Fischerfischer@seitenbau.deSeitenbau GmbHJava Developer+1+1
stephenhStephen Habermanstephenh@chase3000.com-Java Developer--
hhernandezHumberto Hernandezhhernandez@itweb.com.mxIntegrated Technology S.C.Java Developer--
fedorFedor Karpelevitchfedor@karpelevitch.net-Java Developer--
quintonmQuinton McCombsquintonm@bellsouth.netNEqualsOneJava Developer--
jmcnallyJohn McNallyjmcnally@collab.netCollabNetJava Developer--
gmonroeGreg Monroegreg.monroe@dukece.comDuke Corporate EducationJava Developer-5-5
mpoeschlMartin Poeschlmpoeschl@marmot.atTucana.atJava Developer+18+18
dlrDaniel Ralldlr@finemaltcoding.comCollabNet, Inc.Java Developer--
henningHenning P. Schmiedehausenhps@intermeta.deINTERMETA - Gesellschaft fuer Mehrwertdienste mbHJava Developer+2+2
kschraderKurt Schraderkschrader@karmalab.org-Java Developer--
jonJon Scott Stevensjon@latchkey.comCollabNet, Inc.Java Developer--
jtaylorJames Taylorjames@jamestaylor.org-Java Developer--
tvThomas Vandahltv@apache.orgTeWiSoft GmbHJava Developer+1+1
+
+

Contributors

+

The following additional people have contributed to this project through the way of suggestions, patches or documentation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameEmail
Patrick Carlpatrick.carl@coi.de
Roger A. Caronroger.caron@pw.utc.com
Martin Gouletmartin.goulet@sungard.com
M. Sean GilliganSean_Gilligan@catalla.com
James Hillyerdjames@hillyerd.com
Thierry Lachthierry.lach@bbdodetroit.com
Johnny Macchionejohnnymac@tiscali.be
Markus M. Maymmay@javafreedom.org
Raphael Pieronirafale_at_codehaus.org
Jonathan Purvisjon@reeltwo.com
Thoralf Rickertthoralf.rickert@cadooz.de
J. Russell Smythdrfish@cox.net
Tarlika Elisabeth Schmitztes@numerixtechnology.de
Hilco Wijbengahilco.wijbenga@elasticpath.com
Christoph ZengerChristoph.Zenger@jentro.com
+
+
+ +
+
+
+
+
+ + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-frame.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-frame.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-frame.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-frame.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,34 @@ + + + + + + + +All Classes (Torque Maven2 Plugin 3.3.1-SNAPSHOT Test API) + + + + + + + + + + + +All Classes +
+ + + + + +
TorqueOMMojoTest +
+TorqueSQLMojoTest +
+
+ + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-noframe.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-noframe.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-noframe.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/allclasses-noframe.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,34 @@ + + + + + + + +All Classes (Torque Maven2 Plugin 3.3.1-SNAPSHOT Test API) + + + + + + + + + + + +All Classes +
+ + + + + +
TorqueOMMojoTest +
+TorqueSQLMojoTest +
+
+ + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/constant-values.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/constant-values.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/constant-values.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/constant-values.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (Torque Maven2 Plugin 3.3.1-SNAPSHOT Test API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Constant Field Values

+
+
+Contents
    +
+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved. + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/deprecated-list.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/deprecated-list.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/deprecated-list.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/deprecated-list.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (Torque Maven2 Plugin 3.3.1-SNAPSHOT Test API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Deprecated API

+
+
+Contents
    +
+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved. + + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/help-doc.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/help-doc.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/help-doc.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/testapidocs/help-doc.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,216 @@ + + + + + + + +API Help (Torque Maven2 Plugin 3.3.1-SNAPSHOT Test API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

    +
  • Interfaces (italic)
  • Classes
  • Enums
  • Exceptions
  • Errors
  • Annotation Types
+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
  • Class inheritance diagram
  • Direct Subclasses
  • All Known Subinterfaces
  • All Known Implementing Classes
  • Class/interface declaration
  • Class/interface description +

    +

  • Nested Class Summary
  • Field Summary
  • Constructor Summary
  • Method Summary +

    +

  • Field Detail
  • Constructor Detail
  • Method Detail
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

    +
  • Annotation Type declaration
  • Annotation Type description
  • Required Element Summary
  • Optional Element Summary
  • Element Detail
+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

    +
  • Enum declaration
  • Enum description
  • Enum Constant Summary
  • Enum Constant Detail
+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
    +
  • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
  • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved. + + --------------------------------------------------------------------- To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org For additional commands, e-mail: torque-dev-help@db.apache.org