oracle.olapi.syntax (Oracle OLAP Java API Reference)

Interface Summary
Interface	Description
Buildable	A marker interface for metadata objects that an application can specify when it creates a `BuildItem`.
ConsistentSolveCommand	A marker interface implemented by some `SimpleCommand` classes.
FunctionArgument	A marker interface for the `Expression` and other objects that can be function arguments.

Class Summary
Class	Description
AggregateOverClause	The base class for an object that specifies values for the `OVER` clause in an `AggregationFunctionExpression`.
AggregateOverMembersClause	An `AggregateOverClause` that specifies a list of dimension members as the `OVER` clause for an `AggregationFunctionExpression`.
AggregationCase	A `SyntaxObject` that represents an aggregation case for an `AggregationCommand`.
AggregationCommand	A `SolveStepCommand` that represents an aggregation command in a `BuildSpecification`.
AggregationFunctionExpression	A `TypedExpression` that represents an aggregation function.
AnalyzeCommand	A `SimpleCommand` that directs Oracle OLAP to analyze the procedures that a `BuildProcess` performs as it builds an `MdmCube` or an `MdmPrimaryDimension`.
AssignmentCommand	A `SimpleCommand` that represents the assignment of values for a measure of an `MdmCube` or an attribute of an `MdmPrimaryDimension` in a `BuildSpecification`.
BaseQuery	A `Query` for an object that implements the `MdmQuery` interface, such as an `MdmCube` or an `MdmPrimaryDimension`.
BetweenCondition	A `Condition` that represents a `BETWEEN` condition, which determines whether a value is in a specific range of values.
BinaryOperatorCondition	A `Condition` that represents a logical `AND` or `OR` condition that operates on two component `Condition` objects.
BinaryOperatorExpression	A `RowExpression` that represents a binary operator and two expressions that are the operands of the expression.
BuildCommand	An abstract base class that represents a command in a `BuildSpecification`.
BuildItem	A `SyntaxObject` that specifies a `Buildable` object and optionally a `BuildSpecification`, or a system change number (SCN), or both.
BuildProcess	A `SyntaxObject` that contains one or more `BuildItem` objects, each of which specifies a database object to build and how to build it.
BuildSpecification	A `SyntaxObject` that contains commands that specify how to build a `BuildItem`.
CaseExpression	A `RowExpression` that is the abstract base for classes that represent expressions that are similar to `CASE` expressions in SQL.
ClearCommand	A `SimpleCommand` that clears data from the measures of a cube during a build process.
ColumnExpression	A `TypedExpression` that represents a column in a relational table or view.
ComparisonCondition	An abstract base class for a `Condition` that represents a comparison condition, which compares one expression to another expression or to a list of expressions.
CompileCommand	A `SimpleCommand` that causes the build process to determine and validate relationships, such as the attributes of a dimension, and to store information about the relationships.
Condition	An abstract base class for an `Expression` that represents a condition, which specifies a combination of one or more expressions and logical (Boolean) operators and evaluates to `true`, `false`, `null`, or `UNKNOWN`.
ConsistentSolveSpecification	A `SyntaxObject` that specifies how Oracle OLAP generates solved data for an `MdmBaseMeasure` or for all of the `MdmBaseMeasure` objects of an `MdmCube`.
DataObject	An abstract base class for `Query`, `Expression` and other classes.
DataType	An object that represents an Oracle Database data type without precision information.
DateExpression	A `LiteralExpression` that represents a date.
DimensionArgument	A `DataObject` that represents an `MdmDimension` as a function argument.
Expression	An abstract base class for the `Condition` and `TypedExpression` classes.
FromClause	A `DataObject` that represents a list of relational tables.
FromClauseElement	A `DataObject` that contains a `Query` and is an element of a `FromClause`.
FunctionCondition	A `Condition` that represents a condition that evaluates a `FunctionArgument` that produces a Boolean value.
FunctionDescriptor	An object that describes the structure of an `Expression` function.
FunctionDescriptorArgument	The abstract base for classes that represent descriptors for the arguments for a `FunctionDescriptor`.
FunctionDescriptorCatalog	A catalog of functions that are represented by `Expression` objects.
FunctionDescriptorChoiceArgument	A `FunctionDescriptorArgument` that represents arguments that are alternative choices for arguments to a function.
FunctionDescriptorConditionArgument	A `FunctionDescriptorArgument` that represents an argument to a condition function.
FunctionDescriptorDimensionArgument	A `FunctionDescriptorArgument` for a function argument that is a `DimensionArgument`.
FunctionDescriptorGroupArgument	A `FunctionDescriptorArgument` that is a container for the `FunctionDescriptorArgument` objects for a function that takes a group of arguments.
FunctionDescriptorIdentifierArgument	A `FunctionDescriptorArgument` for an function argument that is an `IdentifierArgument`.
FunctionDescriptorKeywordArgument	A `FunctionDescriptorArgument` for an function argument that is a `KeywordArgument`.
FunctionDescriptorTypedExpressionArgument	A `FunctionDescriptorArgument` for a function that takes a `TypedExpression` as an argument.
GroupCommand	A `BuildCommand` that represents a group of `SimpleCommand` objects that operate on the specified `MdmBaseMeasure` objects when the condition specified by a `SymmetricCondition` is true.
HierarchicalCondition	A `Condition` that tests whether a member of a hierarchy has the specified hierarchical relationship to itself or to another member of the hierarchy.
IdentifierArgument	A `DataObject` that represents a `SQLDataType` as a function argument.
IntervalExpression	A `RowExpression` that represents an interval expression, which is similar to a SQL interval expression.
IntervalLiteralExpression	A `RowExpression` that represents an interval literal expression, which is similar to a SQL interval literal expression.
IsCondition	A `Condition` that represents a special condition.
KeywordArgument	A `DataObject` that represents a keyword as a function argument.
KeywordCatalog	A catalog of keywords that an application can use as arguments to `Expression` functions.
LikeCondition	A `Condition` that represents a pattern-matching condition that compares the values of `StringExpression` objects.
ListComparisonCondition	A `ComparisonCondition` that represents a group comparison condition, which compares one expression to a list of expressions.
LiteralExpression	A `TypedExpression` that is the abstract base for classes that represent a literal expression.
LoadCommand	A `SimpleCommand` that loads data into the dimensions or measures of an analytic workspace from relational source tables during a build.
ModelCommand	A `SimpleCommand` that represents an `MdmDimensionCalculationModel` in a `BuildSpecification`.
NotCondition	A `Condition` that represents a `NOT` condition, which negates, or reverses, the Boolean value of the base condition.
NullExpression	A `LiteralExpression` that represents `null`.
NumberExpression	A `LiteralExpression` that represents a number.
OLAPDMLCommand	A `SimpleCommand` that represents an OLAP DML command in a `BuildSpecification`.
OLAPDMLExpression	A `TypedExpression` that represents an Oracle OLAP DML expression.
OLAPFunctionExpression	A `TypedExpression` that represents an Oracle OLAP function.
OrderByClause	A `DataObject` that represents an ordering of the results of the evaluation of an `Expression`.
OrderByElement	A `DataObject` that represents an expression of an `OrderByClause`.
PlaceholderExpression	A `TypedExpression` that represents a placeholder for a measure value.
PLSQLCommand	A `SimpleCommand` that represents a PL/SQL command in a `BuildSpecification`.
QDRExpression	A `TypedExpression` that represents a qualified data reference (QDR).
Qualifier	A `DataObject` that represents a dimension member for a `QDRExpression`.
Query	A `DataObject` that represents a multirow, multicolumn result set that is similar to a relational table, a SQL `SELECT` statement, or an OLAP function.
RowExpression	A `TypedExpression` that is the abstract base for classes that represent a row-based expression.
RowFunctionExpression	A `RowExpression` that represents a row function, which is similar to a SQL single-row function.
SearchedCase	A `DataObject` that contains a `WHEN` condition and a `THEN` expression for a `SearchedCaseExpression`.
SearchedCaseExpression	A `CaseExpression` that represents an expression that is similar to the searched case expression clause and the `ELSE` clause of a `CASE` expression in SQL.
SimpleCase	A `DataObject` that contains a pair of `WHEN` and `THEN` expressions for a `SimpleCaseExpression`.
SimpleCaseExpression	A `CaseExpression` that represents an expression that is similar to the simple case expression and the `ELSE` clauses of a `CASE` expression in SQL.
SimpleCommand	An abstract base class for simple build commands.
SolveCommand	A `SimpleCommand` that initiates the operations that calculate the data for the measures of an `MdmCube`.
SolveStepCommand	An abstract `SimpleCommand` that specifes a function that is one step in the operations that calculate the data for the measures of an `MdmCube`.
SQLDataType	An object that represents an Oracle Database data type with precision information.
StarArgument	A `DataObject` that represents a `*` (asterisk) argument.
StringExpression	A `LiteralExpression` that represents a literal text expression.
SymmetricCondition	A `SyntaxObject` that specifies a collection of the members one or more dimensions.
SymmetricConditionElement	A `SyntaxObject` that specifies a collection of the members of a dimension for a `SymmetricCondition`.
SyntaxObject	An abstract base class for objects that specify tables or columns in an Oracle Database instance, and that represent selections of data and operations on the data.
SyntaxObjectVisitor	A visitor class for the `SyntaxObject` class hierarchy.
TimeZoneExpression	A `RowExpression` that represents a date with a time zone.
TypedExpression	An `Expression` that is a combination of one or more values, operators, and functions that evaluates to a value.
UnaryOperatorExpression	A `RowExpression` that represents a unary operator and an operand.
UnresolvedDimensionArgument	A `DimensionArgument` that represents an invalid or unresolvable identifier.
UnresolvedExpression	A `TypedExpression` that represents an invalid or unresolvable identifier.
UnresolvedQuery	A `Query` that represents an invalid or unresolvable identifier.
ValueComparisonCondition	A `ComparisonCondition` that represents a simple comparison condition, which compares one expression to another expression.

Exception Summary
Exception Description

SyntaxException
Indicates that part of the specification of an SyntaxObject is invalid.

Exception Summary
Exception	Description
SyntaxException	Indicates that part of the specification of an `SyntaxObject` is invalid.

Package oracle.olapi.syntax Description

Contains classes that represent data types, functions, commands, and data objects. Data objects include classes that represent arguments, conditions, and other expressions.

Subclasses of SyntaxObject have methods that convert the object to or from text in Oracle OLAP expression syntax. The text can be SQL statements, or PL/SQL or OLAP DML functions or commands.

An application uses instances of objects from this package in mapping metadata objects to data in the database. Some objects, such as subclasses of Query and Expression, have a getSource method that returns an oracle.olapi.data.source.Source for which an oracle.olapi.data.cursor.Cursor can retrieve data.

BuildCommand objects specify actions that affect an analytic workspace. An application associates a BuildCommand object with a BuildItem and a BuildProcess.