oracle.AWAction
Class BuildDatabase

java.lang.Object
  |
  +--oracle.AWAction.AWAction
        |
        +--oracle.AWAction.BuildDatabase

public class BuildDatabase

extends AWAction

Builds an analytic workspace by defining objects, loading data, and executing solves. The BuildDatabase class is used both by Java applications in an interactive environment and by XML-based applications in a batch environment. In either environment, you must instantiate a BuildDatabase object to load data from the mapped data source or execute calculations in the SolveGroup for the analytic workspace.

Batch applications must also use a BuildDatabase object to define the object containers in the analytic workspace. Interactive applications can use action methods of classes in the AWXML package to define the object containers. Action methods are denoted by an initial capital letter. For example the AWXML.Cube class has the methods Alter, Create, and Delete.

See Also:

AW, MappingGroup, SolveGroup

Constructor Summary

BuildDatabase()
Creates a BuildDatabase object.

BuildDatabase(Interaction input)
Creates a BuildDatabase in the specified Interaction.

Method Summary

void	addBuildList(BaseObject input) Adds a Cube, Dimension, or Measure to the list of objects to build in the analytic workspace.
void	Execute() Builds the analytic workspace.
java.lang.String	Execute(AWConnection connection) Builds the current analytic workspace in the specified database connection.
java.lang.String	ExecuteBuild() Builds the analytic workspace.
java.lang.String	getAWName() Gets the name of the analytic workspace associated with the BuildDatabase.
java.util.Vector	getBuildList() Gets the list of Cube, Dimension, and Measure objects to build in the analytic workspace.
java.util.GregorianCalendar	getBuildStartDate() Gets the start date of a scheduled analytic workspace build specified by the BuildDatabase.
java.lang.String	getBuildType() Gets the analytic workspace build type, which can be either serial or parallel.
boolean	getCleanAttrs() Indicates whether existing attributes in the analytic workspace are deleted before new attributes are loaded.
boolean	getCleanDim() Indicates whether dimension members in the analytic workspace are deleted before new members are loaded.
boolean	getCleanMeasures() Indicates whether existing measures in the analytic workspace are deleted before new measures are loaded.
int	getMaxJobQueues() Gets the maximum number of available job queues.
boolean	getRunSolve() Indicates whether to run solves when building the analytic workspace.
boolean	getTrackStatus() Indicates whether the BuildDatabase specifies the tracking of the loading of data into the analytic workspace.
static java.lang.String	ModifyJobProcesses(AWConnection connection, int jobid, int processes) Changes the number of processes allocated to the specified job.
void	removeBuildList(BaseObject input) Removes a Cube, Dimension, or Measure from the list of objects to build in the analytic workspace.
void	setActiveObject(BaseObject input) Makes the specified analytic workspace the active object.
void	setAWName(java.lang.String input) Makes the named analytic workspace the active object.
void	setBuildStartDate(java.util.GregorianCalendar input) Specifies a GregorianCalendar as the start date for a scheduled build of an analytic workspace.
void	setBuildStartDate(java.lang.String input) Specifies a String as the start date for a scheduled build of an analytic workspace.
void	setBuildType(java.lang.String input) Specifies the type of build of the analytic workspace, which can be either a serial build or a parallel build.
void	setCleanAttrs(boolean input) Specifies whether to delete the attributes in the analytic workspace before loading new attributes.
void	setCleanAttrs(java.lang.Boolean input) Specifies whether to delete the existing attributes in the analytic workspace before loading new attributes.
void	setCleanDim(boolean input) Specifies whether to delete the dimension members in the analytic workspace before loading new members.
void	setCleanDim(java.lang.Boolean input) Specifies whether to delete the dimension members in the analytic workspace before loading new members.
void	setCleanMeasures(boolean input) Specifies whether to delete the measures in the analytic workspace before loading new measures.
void	setCleanMeasures(java.lang.Boolean input) Specifies whether to delete the measures in the analytic workspace before loading new measures.
void	setMaxJobQueues(int input) Specifies the maximum number of available job queues.
void	setMaxJobQueues(java.lang.String input) Specifies the maximum number of available job queues.
void	setRunSolve(boolean input) Specifies whether to run solves when building the analytic workspace.
void	setRunSolve(java.lang.Boolean input) Specifies whether to run solves when building the analytic workspace.
void	setTrackStatus(boolean input) Specifies whether to track the loading of data into the analytic workspace.
void	setTrackStatus(java.lang.Boolean input) Specifies whether to track the loading of data into the analytic workspace.
static java.lang.String	StopBuildJob(AWConnection connection, int input) Stops the job process that specifies the building of the analytic workspace.
java.lang.String	WriteToXML() Gets an XML representation of the BuildDatabase.

Methods inherited from class oracle.AWAction.AWAction

getActiveObject, getOwner, setOwner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildDatabase

public BuildDatabase()

Creates a BuildDatabase object.

BuildDatabase

public BuildDatabase(Interaction input)

Creates a BuildDatabase in the specified Interaction.

Parameters:

input - The Interaction that owns the BuildDatabase object.

Method Detail

setMaxJobQueues

public void setMaxJobQueues(java.lang.String input)

Specifies the maximum number of available job queues.

Parameters:

input - A String that specifies the maximum number of job queues.

setMaxJobQueues

public void setMaxJobQueues(int input)

Specifies the maximum number of available job queues.

Parameters:

input - A integer that specifies the maximum number of job queues.

getMaxJobQueues

public int getMaxJobQueues()

Gets the maximum number of available job queues.

Returns:

An integer that indicates the maximum number of job queues.

setBuildStartDate

public void setBuildStartDate(java.lang.String input)

Specifies a String as the start date for a scheduled build of an analytic workspace. Specify the start date in the form of year, month, date, hour, minute, with the values separated by colons as in the following example.

 curInteraction = new Interaction();
 BuildDatabase myBuild = (BuildDatabase)
                         curInteraction.createAction("BUILDDATABASE");
 myBuild.setBuildStartDate("2005:5:14:6:30");

Parameters:

input - A String that specifies a start date for the build.

setBuildStartDate

public void setBuildStartDate(java.util.GregorianCalendar input)

Specifies a GregorianCalendar as the start date for a scheduled build of an analytic workspace. The following example creates a GregorianCalendar and uses it as the input parameter to the setBuildStartDate method.

 curInteraction = new Interaction();
 BuildDatabase myBuild = (BuildDatabase)
                         curInteraction.createAction("BUILDDATABASE");
 GregorianCalendar startDate = new GregorianCalendar(2005, 4, 12, 9, 30);
 myBuild.setBuildStartDate(startDate);

Parameters:

input - A GregorianCalendar that specifies a start date for the build.

getBuildStartDate

public java.util.GregorianCalendar getBuildStartDate()

Gets the start date of a scheduled analytic workspace build specified by the BuildDatabase.

Returns:

A GregorianCalendar that contains the start date of the build.

setActiveObject

public void setActiveObject(BaseObject input)

Makes the specified analytic workspace the active object. You can specify the analytic workspace to build by making it the active object or by providing its name to the setAWName method. An active object takes precedence over an object that you specify by name.

Overrides:

setActiveObject in class AWAction

Parameters:

input - The AW object you want to make the active object.

setAWName

public void setAWName(java.lang.String input)

Makes the named analytic workspace the active object. You can specify the analytic workspace to build by providing its name or by making it the active object with the setActiveObject method. An active object takes precedence over an object that you specify by name.

Parameters:

input - The name of the analytic workspace that you want to build.

getAWName

public java.lang.String getAWName()

Gets the name of the analytic workspace associated with the BuildDatabase.

Returns:

The name of the analytic workspace.

setBuildType

public void setBuildType(java.lang.String input)

Specifies the type of build of the analytic workspace, which can be either a serial build or a parallel build. For a serial build, the input value is EXECUTE; for a parallel build, the value is BACKGROUND.

Parameters:

input - A String that specifies the type of analytic workspace build.

getBuildType

public java.lang.String getBuildType()

Gets the analytic workspace build type, which can be either serial or parallel. For a serial build, this method returns EXECUTE; for a parallel build, it returns BACKGROUND.

Returns:

A String that indicates the type of analytic workspace build specified by the BuildDatabase.

addBuildList

public void addBuildList(BaseObject input)

Adds a Cube, Dimension, or Measure to the list of objects to build in the analytic workspace. The build list is used for serial builds.

Parameters:

input - The Cube, Dimension, or Measure to add to the build list.

removeBuildList

public void removeBuildList(BaseObject input)

Removes a Cube, Dimension, or Measure from the list of objects to build in the analytic workspace. The build list is used for serial builds.

Parameters:

input - The Cube, Dimension, or Measure to remove from the build list.

getBuildList

public java.util.Vector getBuildList()

Gets the list of Cube, Dimension, and Measure objects to build in the analytic workspace. The build list is used for serial builds.

Returns:

A Vector of the Cube, Dimension, and Measure objects to build.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the BuildDatabase.

Overrides:

WriteToXML in class AWAction

Returns:

A String that is an XML representation of the BuildDatabase.

Execute

public void Execute()

Builds the analytic workspace.

Overrides:

Execute in class AWAction

Execute

public java.lang.String Execute(AWConnection connection)

Builds the current analytic workspace in the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains the results of the operation.

setCleanDim

public void setCleanDim(boolean input)

Specifies whether to delete the dimension members in the analytic workspace before loading new members. To delete dimension members before loading new members, specify true as the input value. To load new members over the existing members, specify false.

Parameters:

input - A boolean that is true if you want to delete dimension members before loading new members or false otherwise.

setCleanDim

public void setCleanDim(java.lang.Boolean input)

Specifies whether to delete the dimension members in the analytic workspace before loading new members. To delete dimension members before loading new members, specify true as the value of the input object. To load new members over the existing members, specify false.

Parameters:

input - A Boolean that has true if you want to delete dimension members before loading new members or false otherwise.

getCleanDim

public boolean getCleanDim()

Indicates whether dimension members in the analytic workspace are deleted before new members are loaded. This method returns true if dimension members are deleted before loading new members or false otherwise.

Returns:

A boolean that is true if dimension members are deleted before loading new members or false otherwise.

setCleanAttrs

public void setCleanAttrs(boolean input)

Specifies whether to delete the attributes in the analytic workspace before loading new attributes. To delete existing attributes before loading new attributes, specify true as the input value. To load new attributes over the existing attributes, specify false.

Parameters:

input - A boolean that is true if you want to delete existing attributes before loading new attributes or false otherwise.

setCleanAttrs

public void setCleanAttrs(java.lang.Boolean input)

Specifies whether to delete the existing attributes in the analytic workspace before loading new attributes. To delete attributes before loading new attributes, specify true as the value of the input object. To load new attributes over the existing attributes, specify false.

Parameters:

input - A Boolean that has true if you want to delete attributes before loading new attributes or false otherwise.

getCleanAttrs

public boolean getCleanAttrs()

Indicates whether existing attributes in the analytic workspace are deleted before new attributes are loaded. This method returns true if attributes are deleted before loading new attributes or false otherwise.

Returns:

A boolean that is true if existing attributes are deleted before loading new attributes or false otherwise.

setCleanMeasures

public void setCleanMeasures(boolean input)

Specifies whether to delete the measures in the analytic workspace before loading new measures. To delete existing measures before loading new measures, specify true as the input value. To load new measures over the existing measures, specify false.

Parameters:

input - A boolean that is true if you want to delete existing measures before loading new measures or false otherwise.

setCleanMeasures

public void setCleanMeasures(java.lang.Boolean input)

Specifies whether to delete the measures in the analytic workspace before loading new measures. To delete existing measures before loading new measures, specify true as the input value. To load new measures over the existing measures, specify false.

Parameters:

input - A Boolean that has true if you want to delete existing measures before loading new measures or false otherwise.

getCleanMeasures

public boolean getCleanMeasures()

Indicates whether existing measures in the analytic workspace are deleted before new measures are loaded. This method returns true if measures are deleted before loading new measures or false otherwise.

Returns:

A boolean that is true if existing measures are deleted before loading new measures or false otherwise.

setRunSolve

public void setRunSolve(boolean input)

Specifies whether to run solves when building the analytic workspace. To run solves when building the analytic workspace, specify true as the input value. To build the analytic workspace without running the solves, specify false.

Parameters:

input - A boolean that is true if you want to run the solves during a build or false otherwise.

setRunSolve

public void setRunSolve(java.lang.Boolean input)

Specifies whether to run solves when building the analytic workspace. To run solves when building the analytic workspace, specify true as the value of the input object. To build the analytic workspace without running the solves, specify false.

Parameters:

input - A Boolean that has true if you want to run the solves during a build or false otherwise.

getRunSolve

public boolean getRunSolve()

Indicates whether to run solves when building the analytic workspace. This method returns true if the BuildDatabase specifies the running of solves when building the analytic workspace or false otherwise.

Returns:

A boolean that is true if the BuildDatabase specifies the running of solves when building the analytic workspace or false otherwise.

setTrackStatus

public void setTrackStatus(boolean input)

Specifies whether to track the loading of data into the analytic workspace. To track the status of the data load, specify true as the input value. To not track the status, specify false.

Parameters:

input - A boolean that is true if you want to track the status of the data load or false otherwise.

setTrackStatus

public void setTrackStatus(java.lang.Boolean input)

Specifies whether to track the loading of data into the analytic workspace. To track the status of the data load, specify true as the input value. To not track the status, specify false.

Parameters:

input - A Boolean that has true if you want to track the status of the data load or false otherwise.

getTrackStatus

public boolean getTrackStatus()

Indicates whether the BuildDatabase specifies the tracking of the loading of data into the analytic workspace. This method returns true if the BuildDatabase specifies the tracking of the status of the data load or false otherwise.

Returns:

A boolean that is true if the BuildDatabase specifies the tracking of the status of the data load or false otherwise.

StopBuildJob

public static java.lang.String StopBuildJob(AWConnection connection,
                                            int input)

Stops the job process that specifies the building of the analytic workspace.

Parameters:

connection - An AWConnection that specifies a connection to an Oracle Database instance.

input - An integer that is the number of the job to stop.

Returns:

A String that indicates the results of attempting to stop the job.

ModifyJobProcesses

public static java.lang.String ModifyJobProcesses(AWConnection connection,
                                                  int jobid,
                                                  int processes)

Changes the number of processes allocated to the specified job.

Parameters:

connection - An AWConnection that specifies a connection to an Oracle Database instance.

jobid - An integer that is the indentification number of the job.

processes - An integer that specifies the number of processes to allocate to the job.

Returns:

A String that contains the results of modifying the job processes.

ExecuteBuild

public java.lang.String ExecuteBuild()

Builds the analytic workspace.

Returns:

A String that contains the results of the operation.