oracle.dss.calculation.client.calcStepView
Interface StepView

All Known Implementing Classes:

DefaultCalcStepView, RelationshipCalcStepView, RelationshipShareStepView, TimeCalcStepView, TimeCumulativeTotalStepView, RelationshipIndexStepView, RankStepView, SimpleMathCalcStepView

public interface StepView

The interface for all calculation step views.

Method Summary

void	cleanup() Cleans up any resources allocated by the panel.
BuilderContext	getBuilderContext() Retrieves the BuilderContext instance associated with the panel.
java.awt.Component	getComponent() Gets the component for the step view.
java.awt.Component	getContainer() Retrieves the container for the StepView.
boolean	initStepView() Init the data in the StepView.
void	setBuilderContext(BuilderContext builderContext) Specifies the BuilderContext instance for the panel.
void	setContainer(java.awt.Component container) Sets the container for the StepView.
boolean	updateData(boolean bUpdateUI) Updates information from the StepView to the Step or vice versa.
boolean	validateContents(java.lang.Object hintValidate) Validate the contents of the step view.

Method Detail

cleanup

public void cleanup()

Cleans up any resources allocated by the panel.

getBuilderContext

public BuilderContext getBuilderContext()

Retrieves the BuilderContext instance associated with the panel.

Returns:

The BuilderContext instance associated with the panel.

getContainer

public java.awt.Component getContainer()

Retrieves the container for the StepView.

Returns:

The specified container for the step view.

getComponent

public java.awt.Component getComponent()

Gets the component for the step view.

Returns:

Component for the step view.

initStepView

public boolean initStepView()
                     throws DataUtilException

Init the data in the StepView. Subclasses must override the this class to provide their own implementation.

setBuilderContext

public void setBuilderContext(BuilderContext builderContext)

Specifies the BuilderContext instance for the panel.

Parameters:

The - BuilderContext instance for the panel.

setContainer

public void setContainer(java.awt.Component container)

Sets the container for the StepView.

Parameters:

container - The specified container for the step view.

updateData

public boolean updateData(boolean bUpdateUI)
                   throws DataUtilException

Updates information from the StepView to the Step or vice versa.

Parameters:

bUpdateUI - true to transfer data from the Step to the StepView, false otherwise.

validateContents

public boolean validateContents(java.lang.Object hintValidate)

Validate the contents of the step view.

Parameters:

hintValidate - A hint object to help in the validation process.

Returns:

true<\code> if the operation was successful, false<\code> otherwise.