| Package | Description | 
|---|---|
| oracle.javatools.db | 
 Contains a metadata API for describing database objects, and retrieving them
from a provider of database objects - for example a database. 
 | 
| oracle.javatools.db.datatypes | 
 Classes related to datatypes in the database API. 
 | 
| oracle.javatools.db.hive | |
| oracle.javatools.db.ora | 
 Contains the database api implementation for Oracle databases, and additional
DBObject implementations for objects specific to Oracle. 
 | 
| oracle.javatools.db.ora.bigdata | |
| oracle.javatools.db.plsql | 
 Classes for dealing with PL/SQL objects. 
 | 
| oracle.javatools.db.sql | 
 Contains an API for declaratively parsing SQL queries (SELECT statements). 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractBuildableObject
Provides methods for lazy loading and building AbstractDBObjects. 
 | 
class  | 
AbstractChildBuildableObject
Abstract DBObject implementation that is buildable (support lazy loading)
 and is a ChildDBObject implementation. 
 | 
class  | 
AbstractChildDBObject
Extension of DBObject used by child object in the API. 
 | 
class  | 
AbstractIncrementer
Abstract superclass of Sequence to allow for other implementations that use a
 Sequence (or similar) but not as a SchemaObject to re-use these properties. 
 | 
class  | 
AbstractSchemaObject
Provides a base implementation of the  
SchemaObject interface. | 
class  | 
AbstractSystemObject
Abstract superclass for all SystemObject implementations. 
 | 
class  | 
Alias
Model of a database alias. 
 | 
class  | 
AutoExtendProperties
Model of properties for auto extend behavior used by  
Tablespaces | 
class  | 
CheckConstraint
A  
CheckConstraint constrains a table or view based on a
 conditional expression. | 
class  | 
Column
Model of a database column. 
 | 
class  | 
ColumnConstraint
Abstract model of a Constraint that constrains Columns in the database. 
 | 
class  | 
Constraint
A  
Constraint represents a constraint on a table or view. | 
class  | 
FileSpecification
Model of  
File Specification properties. | 
class  | 
FKConstraint
A  
FKConstraint represents a Foreign Key Constraint. | 
class  | 
IdentityColumnProperties
Properties of an Identity Column defining how the values of that column are generated. 
 | 
class  | 
Index
Model of a database index. 
 | 
class  | 
Java
Abstract SchemaObject implementation for the different Java objects available
 in a database. 
 | 
class  | 
JavaClass
Model of a Java Class. 
 | 
class  | 
JavaResource
Model of a Java Resource object. 
 | 
class  | 
JavaSource
Model of a Java Source object. 
 | 
class  | 
PKConstraint
A  
PKConstraint represents a Primary Key constraint. | 
class  | 
Relation
A  
Relation represents the basic entity of a relational
 database. | 
class  | 
Schema
Model of a database schema. 
 | 
class  | 
Sequence
Model of a database sequence. 
 | 
class  | 
Synonym
Model of a database synonym. 
 | 
class  | 
Table
Model of a database table. 
 | 
class  | 
Tablespace
Model of a Tablespace in a database. 
 | 
class  | 
UniqueConstraint
A  
UniqueConstraint prohibits multiple rows from having the
 same value in the same column or combination of columns but allows some
 values to be null. | 
class  | 
View
Represents a database View. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected int | 
AbstractDBObject.compareToImpl(AbstractDBObject target)  | 
protected void | 
AbstractBuildableObject.copyToImpl(AbstractDBObject copy,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected void | 
CheckConstraint.copyToImpl(AbstractDBObject copy,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected void | 
AbstractDBObject.copyToImpl(AbstractDBObject copy,
          DBObject copyParent,
          IDPolicy idPolicy)
Implementation method for making a copy of this object. 
 | 
protected void | 
Index.copyToImpl(AbstractDBObject copy,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected boolean | 
AbstractDBObject.equalsImpl(AbstractDBObject other)
Equals implementation for testing equality with another AbstractDBObject. 
 | 
protected static AbstractDBObject.ChildSupport | 
AbstractDBObject.getChildSupport(AbstractDBObject obj,
               java.lang.String propName)
Gets (creating if missing) the ChildSupport wrapper for a property that
 is a child list. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
DataTypeAttribute
A data type can have a number of attributes that define its behaviour -
 size, precision, scale etc. 
 | 
class  | 
DataTypeSynonym
DataType implementation that delegates all calls to an underlying DataType
 that it is a "synonym" for. 
 | 
class  | 
DataTypeUsage
To "use" a DataType is to refer to it by ID and store values for any
 attributes that DataType may have (precision, scale, size etc). 
 | 
class  | 
PredefinedDataType
Default DataType implementation for simple (built-in) data types in a
 database. 
 | 
class  | 
PredefinedDataTypeUsage
Deprecated.  
 | 
class  | 
UserDataType
Defines a data type that we 'discovered' when importing or navigating a
  database, usually from a foreign database, or for un-imported object types. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
DataTypeSynonym.copyToImpl(AbstractDBObject other,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected void | 
DataTypeUsage.copyToImpl(AbstractDBObject target,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected boolean | 
DataTypeSynonym.equalsImpl(AbstractDBObject other)  | 
protected boolean | 
DataTypeUsage.equalsImpl(AbstractDBObject target)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HiveBucketProperties
Bean that encapsulates the properties specific to a Hive Bucketed Table. 
 | 
class  | 
HivePartition
Bean that represents a partition in Hive. 
 | 
class  | 
HivePartitionProperties
Bean to reprsent the partition model of a Hive table. 
 | 
class  | 
HiveSkewProperties
Bean to represent the properties that control the skewing of a Hive table
 or table partition. 
 | 
class  | 
HiveStorageProperties
Collection of properties for a Table definition that are specific to the
 Hive Metastore. 
 | 
class  | 
TblProperty
Simple DBObject implementation for a key/value pair in a property map
 (like TBLPROPERTIES or SERDEPROPERTIES). 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
TblProperty.setTblProperty(AbstractDBObject obj,
              java.lang.String name,
              java.lang.String value)
Utility method to add/change/remove a new TblProperty to the
 TBLPROPERTIES for an object. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
DatabaseLink
Model of a database DatabaseLink. 
 | 
class  | 
Directory
Model of an Oracle Directory object. 
 | 
class  | 
IndexPartition
Model of an Oracle index partition. 
 | 
class  | 
Indextype  | 
class  | 
LOBDescriptor
LOBDescriptor encapsulates the partitioning properties of LOB and VARRAY
 columns. 
 | 
class  | 
MaterializedView
A MaterializedView represents a Materialized View in the database. 
 | 
class  | 
MaterializedViewLog  | 
class  | 
OracleColumnProperties
DBObject that wraps all the properties that a Column can have that are
 Oracle specific. 
 | 
class  | 
OracleExternalTableProperties
This object represents the "external table clause" syntax for creating an
 external table. 
 | 
static class  | 
OracleExternalTableProperties.LocationSpecifier
The LOCATION clause lets you specify one or more external data sources. 
 | 
class  | 
OracleIndexOrganizedTableProperties
Property object to hold the index organized specific properties for an IOT. 
 | 
class  | 
OracleIndexPartitions
Model of the partitioning scheme on an Oracle index. 
 | 
class  | 
OracleInMemoryColumnProperties
Child object that represents a component of the in-memory column clause
 for a Table. 
 | 
class  | 
OracleInMemoryProperties
Child object that represents Oracle Database In-Memory properties. 
 | 
class  | 
OracleNestedTableProperties  | 
class  | 
OracleSQLQuery
Deprecated. 
 
- folded in to SQLQuery 
 | 
class  | 
OracleStorageProperties  | 
class  | 
OracleTablePartitions
OracleTablePartitions encapsulate the properties of an Oracle table's partitions
 and subpartitions. 
 | 
class  | 
OracleTableProperties
Extra properties for Oracle Tables 
 | 
class  | 
OracleTablespaceProperties
Model of properties for an Oracle  
Tablespace | 
class  | 
RecycledObject
Model of an object that has been dropped and is now in the Oracle recycle
 bin. 
 | 
class  | 
TablePartition
TablePartition encapsulate the properties of an individual partition or subpartition. 
 | 
class  | 
XMLSchema
Object to represent an XML Schema held in the database. 
 | 
class  | 
XMLSchemaElement  | 
class  | 
XMLTypeColumnProperties  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
BigDataAccessParameter
SQLFragment that represents an access parameter for an Oracle "Big
 Data" access driver. 
 | 
class  | 
BigDataAccessParameters
SQLFragment that represents the access parameters for the Oracle "Big
 Data" external table access drivers. 
 | 
class  | 
BigDataField
Representation of a Big Data field object. 
 | 
class  | 
BigDataFields
Object that represents the value of the com.oracle.bigdata.fields access
 parameter. 
 | 
class  | 
BigDataJsonArray
Array construct for use in big data access parameter values. 
 | 
class  | 
BigDataJsonEntry
Entry (or element) construct for use in big data access parameter values. 
 | 
class  | 
BigDataJsonObject
Object construct for use in big data access parameter values. 
 | 
class  | 
BigDataTableProperties
Object that represents the value of the com.oracle.bigdata.tblproperties
 access parameter. 
 | 
class  | 
BigDataTableProperty
Representation of a big data "table property", which is a name/value
 property pair. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
DBObjectPlSqlFragment
Top-most PL/SQL specific superclass of all PL/SQL DBObject classes
 in this package. 
 | 
class  | 
Package
Representation of a PL/SQL Package Spec 
 | 
class  | 
PackageBody
Representation of a PL/SQL Package Body 
 | 
class  | 
PlSqlAttribute
A representation of a Attribute within a  
Type. | 
class  | 
PlSqlBlock
When instantiated as a concrete class, this represents a PL/SQL Block. 
 | 
class  | 
PlSqlCodeFragment
Any non whitespace/comment fragment of PL/SQL code 
 | 
class  | 
PlSqlComment
Class representing a comment within PL/SQL. 
 | 
class  | 
PlSqlDatatype
Representation of a PL/SQL Datatype such as a record, varray table etc. 
 | 
class  | 
PlSqlDatum
An abstract representation of a PL/SQL object that may contain data, and as such
 has a reference to a datatype or datatype usage 
 | 
class  | 
PlSqlMethod
Representation of a method within a  
Type. | 
class  | 
PlSqlParameter
Representation of a parameter (argument) to any PL/SQL procedure, function
 or method. 
 | 
class  | 
PlSqlReference
A reference from some PL/SQL to another DBObject. 
 | 
class  | 
PlSqlSchemaObject
Abstract superclass of all Schema level PL/SQL objects (ie  
PlSqlSourceObjects)
 other than Procedure and Function as they extend PlSqlSubProgram. | 
class  | 
PlSqlSchemaObjectBody
Abstract superclass of  
PackageBody and  TypeBody. | 
class  | 
PlSqlSchemaObjectSpec
 | 
class  | 
PlSqlStatement
A represtation of a PL/SQL statement, or compound construct that can be
 used where a simple statement could (eg a block, if, loop etc). 
 | 
class  | 
PlSqlSubProgram
A representation of a PL/SQL procedure or function. 
 | 
class  | 
PlSqlVariable
A representation of a PL/SQL variable (or constant) defined at any scope
 in a PL/SQL object. 
 | 
class  | 
Procedure
Representation of a PL/SQL Procedure. 
 | 
class  | 
Trigger
Representation of a Database Trigger 
 | 
class  | 
Type
Representation of a PL/SQL Object Type. 
 | 
class  | 
TypeBody
Representation of a Type Body 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
DBObjectPlSqlFragment.copyToImpl(AbstractDBObject copy,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractAliasFragment
SQLFragment that consists of an expression and an alias. 
 | 
class  | 
AbstractDBObjectUsage
Abstract implementation for a SQLFragment that uses another DBObject (e.g
 a Column) through a FromObject in the query. 
 | 
class  | 
AbstractFromObjectUsage
Abstract SQLFragment implementation of FromObjectUsage. 
 | 
class  | 
AbstractProviderUsageSQLFragment
Abstract SQLFragment implementation that is also a ProviderUsage. 
 | 
class  | 
AbstractSchemaObjectUsage
Abstract class for usages that reference a SchemaObject (e.g. 
 | 
class  | 
AbstractSQLFragment
Abstract superclass for SQLFragment implementations. 
 | 
class  | 
AbstractSQLQuery
Deprecated. 
 
- folded in to SQLQuery 
 | 
class  | 
ArithmeticOperation
Concrete subclass of Operation for arithmetic operations - ADD, SUBTRACT,
 MULTIPLY and DIVIDE. 
 | 
class  | 
AsteriskUsage
Deprecated. 
 
- use ColumnKeywordUsage 
 | 
class  | 
BuiltInFunction
Class used for defining built in functions for the database. 
 | 
class  | 
BuiltInFunctionArgument
An argument to a SQL Built-in Function 
 | 
class  | 
CaseStatement
Class to represent a case statement in a sql query. 
CASE [expression] WHEN condition THEN thenExpression WHEN condition THEN thenExpression ...  | 
static class  | 
CaseStatement.WhenThen  | 
class  | 
ColumnKeywordUsage
A FromObjectUsage that has a keyword for the Column name, rather than an
 actual column. 
 | 
class  | 
ColumnUsage
SQL fragment that is a use of a Column. 
 | 
class  | 
Comparison
Subclass of Operation for comparisons. 
 | 
class  | 
ConnectByRoot
SQLFragment representing the unary operator CONNECT_BY_ROOT. 
 | 
class  | 
DataMiningFunction
Subclass of Operation for data mining functions. 
 | 
static class  | 
DataMiningFunction.DataMiningArguments
Deprecated. 
 
no longer required, use get/setDmSpecificArgs directly. 
 | 
static class  | 
DataMiningFunction.DataMiningCostValues
An array of values 
 | 
class  | 
ExpressionList
List of expressions. 
 | 
class  | 
FKUsage
SQLFragment for the usage of a FKConstraint. 
 | 
class  | 
FromObject
Object that represents a clause in the FROM statement of a SQL query. 
 | 
class  | 
Function
Subclass of Operation for functions. 
 | 
class  | 
FunctionUsage  | 
class  | 
GroupByExpression
Expression for a part of a group by that isn't a simple column (e.g. 
 | 
class  | 
GroupByObject
SQLFragment for the GROUP BY ... 
 | 
class  | 
HierarchicalQueryObject
SQLFragment for the Hierarchical Query clause in a SQLQuery. 
 | 
class  | 
IndexObject
Object to wrap a column expression (usually just a name, but could be any
 sql expression) with an optional order type (ASC/DESC). 
 | 
class  | 
JoinObject
Object that represent the JOIN clause of a SELECT statement (part of the
 FROM clause). 
 | 
class  | 
ModelObject
SQLFragment for the MODEL clause in a SQLQuery. 
 | 
static class  | 
ModelObject.CellAssignment  | 
static class  | 
ModelObject.CellReferenceOptions  | 
static class  | 
ModelObject.ModelColumnClauses  | 
static class  | 
ModelObject.ModelRulesCellAssignmentExpr  | 
static class  | 
ModelObject.ModelRulesClause  | 
static class  | 
ModelObject.MultiColumnForLoop  | 
static class  | 
ModelObject.ReferenceModel  | 
static class  | 
ModelObject.SingleColumnForLoop  | 
class  | 
NonDeclarativeSQLQuery
Deprecated. 
 
folded into SQLQuery 
 | 
class  | 
OnJoinCondition
Object to represent the ON condition of a JOIN clause. 
 | 
class  | 
Operation
Abstract class for operations. 
 | 
class  | 
OrderByObject
Object to wrap each part of the ORDER BY clause of a SQLQuery. 
 | 
class  | 
PlSqlUsage
Fragment that represents a usage of a piece of PlSql. 
 | 
class  | 
RelationUsage
SQL fragment that is a use of a Relation. 
 | 
class  | 
SelectObject
Object that represents a clause in the SELECT statement of a SQL query. 
 | 
class  | 
SelectObjectUsage
Class that represents the usage of a SelectObject. 
 | 
class  | 
SequenceUsage
SQL fragment that is a use of a Sequence. 
 | 
class  | 
SetOperation
SQLFragment for dealing with operations to do with sets and ranges like
 IN and BETWEEN. 
 | 
class  | 
SetOperator
SQLFragment for dealing with queries that are linked using one of the SET
 operators INTERSECT, UNION, MINUS and UNION ALL. 
 | 
class  | 
SimpleSQLFragment
SQLFragment that we can't break down any more. 
 | 
class  | 
SQLQuery
Object that represents a SQL query. 
 | 
class  | 
SynonymUsage
SQLFragment for using a Synonym or Alias in a SQL query. 
 | 
class  | 
UsingJoinCondition
Object to represent the condition part of a JOIN that has a USING clause. 
 | 
class  | 
WhereObject
Object that represents a clause in the WHERE statement of a SQL query. 
 | 
class  | 
WindowFunction
Subclass of Function for windowing functions (using the OVER syntax). 
 | 
static class  | 
WindowFunction.WindowFunctionBound  | 
class  | 
WithClauseUsage
FromObjectUsage which represents the usage of a WITH clause in the FROM
 clause. 
 | 
class  | 
XMLFunctionUsage
Use spaces as argument seperators. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
AbstractProviderUsageSQLFragment.copyToImpl(AbstractDBObject target,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected void | 
Operation.copyToImpl(AbstractDBObject target,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected void | 
ColumnUsage.copyToImpl(AbstractDBObject target,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected void | 
FunctionUsage.copyToImpl(AbstractDBObject target,
          DBObject copyParent,
          IDPolicy idPolicy)  | 
protected boolean | 
Operation.equalsImpl(AbstractDBObject other)  | 
protected boolean | 
ArithmeticOperation.equalsImpl(AbstractDBObject target)  |