|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.syntax.SyntaxObject
oracle.olapi.syntax.BuildCommand
oracle.olapi.syntax.SimpleCommand
oracle.olapi.syntax.LoadCommand
public final class LoadCommand
A SimpleCommand
that loads data into the dimensions or measures of an analytic workspace from relational source tables during a build. Options to a load command affect the loading of the data. You get an instance of a LoadCommand
with an associated option by using one of static fields of this class or by using a constructor method.
The following table lists the load command options and describes them.
Load Option | Effect on Load |
---|---|
DEFAULT |
For an MdmPrimaryDimension , the default option is a synchronized load.
For an |
SYNCH |
For an MdmPrimaryDimension , adds new members to the dimension and removes members that no longer exist in the relational source tables.
For an |
NO_SYNCH |
For an MdmPrimaryDimension , adds new members but does not remove members that no longer exist in the relational source tables.
For an |
SERIAL |
For an MdmCube , loads the data into the measures using a single process. If a measure is partitioned, then this option loads the data of the partitions serially. If the partitioning of the cube does not match the partitioning of the source table, then a serial load is a good choice.
For an |
PARALLEL |
For an MdmCube , loads the data for partitioned measures using parallel processes. This option loads the data into the measures of the partitions simultaneously, using one process for each partition, or as many processes as are available.
For an |
PRUNE |
For an MdmCube with partitioned measures, spawns jobs only for the partitions for which measure data exists. Determining which partitions have data requires scanning the entire table. For tables that have terrabytes of data, a full table scan can be time comsuming.
For an |
If you want a LoadCommand
that only loads data from a single CubeMap
, then use a constructor that takes a cubeMapName
parameter. If you create a LoadCommand
without specifying a CubeMap
, then the LoadCommand
loads data from all of the CubeMap
objects of the MdmCube
.
For more information about partitioned cubes, see the
method of setPartitionLevel
AWCubeOrganization
, the
method of setParallelism
BuildProperties
, and Oracle OLAP User's Guide.
Field Summary | |
---|---|
static LoadCommand |
DEFAULT Produces a LoadCommand that executes a default load. |
static java.lang.String |
DEFAULT_OPTION A constant that represents a default load. |
static LoadCommand |
NO_SYNCH Produces a LoadCommand that has the NO_SYNCH option. |
static java.lang.String |
NO_SYNCH_OPTION A constant that represents an unsynchronized load. |
static LoadCommand |
PARALLEL Produces a LoadCommand that has the PARALLEL option. |
static java.lang.String |
PARALLEL_OPTION A constant that represents a parallel load. |
static LoadCommand |
PRUNE Produces a LoadCommand that has the PRUNE option. |
static java.lang.String |
PRUNE_OPTION A constant that represents a pruned load. |
static LoadCommand |
SERIAL Produces a LoadCommand that has the SERIAL option. |
static java.lang.String |
SERIAL_OPTION A constant that represents a serial load. |
static LoadCommand |
SYNCH Produces a LoadCommand that has the SYNCH option. |
static java.lang.String |
SYNCH_OPTION A constant that represents a synchronized load. |
Constructor Summary | |
---|---|
LoadCommand() Creates a LoadCommand with the default load command option. |
|
LoadCommand(java.lang.String option) Creates a LoadCommand with the specified load command option. |
|
LoadCommand(java.lang.String option, Condition whereCondition) Creates a LoadCommand with the specified load command option and WHERE Condition . |
|
LoadCommand(java.lang.String option, Condition whereCondition, java.lang.String cubeMapName) Creates a LoadCommand with the specified load command option, WHERE Condition , and CubeMap . |
|
LoadCommand(java.lang.String option, java.lang.String cubeMapName) Creates a LoadCommand with the specified load command option and CubeMap . |
Method Summary | |
---|---|
java.lang.String |
getCubeMapName() Gets the name of the CubeMap that is associated with this LoadCommand . |
java.lang.String |
getLoadOption() Gets the load command option of this LoadCommand . |
Condition |
getWhereCondition() Gets the Condition of this LoadCommand . |
java.lang.Object |
visit(SyntaxObjectVisitor visitor, java.lang.Object context) Calls the visitLoadCommand method of the SyntaxObjectVisitor and passes that method this LoadCommand and an Object . |
Methods inherited from class oracle.olapi.syntax.SyntaxObject |
---|
equals, equals, fromSyntax, fromSyntax, fromSyntax, fromSyntax, fromSyntax, isValid, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_OPTION
public static final java.lang.String SYNCH_OPTION
public static final java.lang.String NO_SYNCH_OPTION
public static final java.lang.String PRUNE_OPTION
public static final java.lang.String SERIAL_OPTION
public static final java.lang.String PARALLEL_OPTION
public static final LoadCommand DEFAULT
LoadCommand
that executes a default load.public static final LoadCommand SYNCH
LoadCommand
that has the SYNCH
option.public static final LoadCommand SERIAL
LoadCommand
that has the SERIAL
option.public static final LoadCommand PARALLEL
LoadCommand
that has the PARALLEL
option.public static final LoadCommand NO_SYNCH
LoadCommand
that has the NO_SYNCH
option.public static final LoadCommand PRUNE
LoadCommand
that has the PRUNE
option.Constructor Detail |
---|
public LoadCommand()
LoadCommand
with the default load command option.public LoadCommand(java.lang.String option)
LoadCommand
with the specified load command option.
option
- A String
that contains a load command option.public LoadCommand(java.lang.String option, Condition whereCondition)
LoadCommand
with the specified load command option and WHERE
Condition
.
option
- A String
that contains a load command option.whereCondition
- A Condition
that Oracle OLAP applies to the base table during the load.public LoadCommand(java.lang.String option, Condition whereCondition, java.lang.String cubeMapName)
LoadCommand
with the specified load command option, WHERE
Condition
, and CubeMap
. Use this contructor if you want to load data from a single CubeMap
and to apply a WHERE
Condition
.
option
- A String
that contains a load command option.whereCondition
- A Condition
that Oracle OLAP applies to the base table during the load.cubeMapName
- A String
that contains the name of a CubeMap
to use when loading the measure data for an MdmCube
.public LoadCommand(java.lang.String option, java.lang.String cubeMapName)
LoadCommand
with the specified load command option and CubeMap
. Use this contructor if you want to load data from a single CubeMap
.
option
- A String
that contains a load command option.cubeMapName
- A String
that contains the name of a CubeMap
to use when loading the measure data for an MdmCube
.Method Detail |
---|
public java.lang.Object visit(SyntaxObjectVisitor visitor, java.lang.Object context)
visitLoadCommand
method of the SyntaxObjectVisitor
and passes that method this LoadCommand
and an Object
.visit
in class SyntaxObject
visitor
- A SyntaxObjectVisitor
.context
- An Object
.Object
returned by the visitLoadCommand
method.public java.lang.String getCubeMapName()
CubeMap
that is associated with this LoadCommand
.String
that contains the name of the CubeMap
associated with this LoadCommand
.public java.lang.String getLoadOption()
LoadCommand
. For the default option, this method returns an empty string.String
that contains the load command option of this LoadCommand
.public Condition getWhereCondition()
Condition
of this LoadCommand
. Oracle OLAP applies the Condition
to the base table during the load.CONDITION
that Oracle OLAP applies while executing this LoadCommand
.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |