oracle.dss.util.format

Class BaseViewFormatHandle

java.lang.Object

oracle.dss.util.format.BaseMergeableHandle

oracle.dss.util.format.BaseViewFormatHandle

Direct Known Subclasses:

ViewFormatHandle

public class BaseViewFormatHandle
extends BaseMergeableHandle

Wrapper class for returning a BaseViewFormat to a view from the data source, through the DataAccess interface.

When DataMap.DATA_VIEWFORMAT is passed as the type parameter of the DataAccess.getValue method, the DataAccess returns a BaseViewFormatHandle. The view uses the BaseViewFormat that this handle wraps, to format numbers in a cell. The settings in the wrapped BaseViewFormat take precedence over those in the default BaseViewFormat for a view component.

The RunRulesForViewFormat property of this BaseViewFormatHandle determines whether the view runs rules on the wrapped BaseViewFormat. If the view does not run rules, then the wrapped BaseViewFormat specifies all of the number formatting for the cell.

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseViewFormat	m_baseViewFormat
protected int	m_runRulesForViewFormat
protected java.lang.String	m_viewFormatID

Fields inherited from class oracle.dss.util.format.BaseMergeableHandle

DO_NOT_RUN_RULES, RUN_RULES

Constructor Summary

Constructors

Constructor and Description
BaseViewFormatHandle() Constructor that takes no arguments.
BaseViewFormatHandle(BaseViewFormat baseViewFormat, java.lang.String id, int runRules) Constructor that specifies a BaseViewFormat, an ID, and whether rules apply to the cell.

Method Summary

Modifier and Type	Method and Description
BaseViewFormat	getBaseViewFormat() Retrieves the BaseViewFormat that this object wraps.
int	getRunRulesForViewFormat() Indicates whether the view should run rules on the cell for which the BaseViewFormat provides formatting.
java.lang.String	getViewFormatID() Retrieves the ID of the BaseViewFormat that this BaseViewFormatHandle wraps.
void	setBaseViewFormat(BaseViewFormat baseViewFormat) Specifies the BaseViewFormat that this object wraps.
void	setRunRulesForViewFormat(int runRules) Specifies whether the view should run rules on the cell for which the BaseViewFormat provides formatting.
void	setViewFormatID(java.lang.String id) Specifies a unique ID for BaseViewFormat that this BaseViewFormatHandle wraps.

Methods inherited from class java.lang.Object

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

Field Detail

m_baseViewFormat

protected BaseViewFormat m_baseViewFormat

For internal use only. Application developers should not use this

member variable for BaseViewFormat property

m_viewFormatID

protected java.lang.String m_viewFormatID

For internal use only. Application developers should not use this

member variable for ViewFormatID property

m_runRulesForViewFormat

protected int m_runRulesForViewFormat

For internal use only. Application developers should not use this

member variable for RunRulesForViewFormat property

Constructor Detail

BaseViewFormatHandle

public BaseViewFormatHandle()

Constructor that takes no arguments. If you use this constructor, you must set the BaseViewFormat for this BaseViewFormatHandle to wrap, and you must specify whether rules apply to the cell. You can also set a unique ID for the BaseViewFormat.

See Also:

setBaseViewFormat(oracle.dss.util.format.BaseViewFormat), setRunRulesForViewFormat(int), setViewFormatID(java.lang.String)

BaseViewFormatHandle

public BaseViewFormatHandle(BaseViewFormat baseViewFormat,
                            java.lang.String id,
                            int runRules)

Constructor that specifies a BaseViewFormat, an ID, and whether rules apply to the cell.

Parameters:

baseViewFormat - The BaseViewFormat for this object to wrap.

id - A unique ID for the BaseViewFormat.

runRules - A constant that indicates whether rules set on the view should be run for a cell that uses baseViewFormat. Valid constants are listed in the See Also section.

See Also:

BaseMergeableHandle.RUN_RULES, BaseMergeableHandle.DO_NOT_RUN_RULES

Method Detail

getBaseViewFormat

public BaseViewFormat getBaseViewFormat()

Retrieves the BaseViewFormat that this object wraps. The BaseViewFormat that this method returns is merged with the default BaseViewFormat for the view component. The settings in the returned BaseViewFormat take precedence over the default BaseViewFormat.

Returns:

The BaseViewFormat that this object wraps, or null if no BaseViewFormat has been set.

setBaseViewFormat

public void setBaseViewFormat(BaseViewFormat baseViewFormat)

Specifies the BaseViewFormat that this object wraps. The settings in the BaseViewFormat that you pass to this method take precedence over the default BaseViewFormat for a view component.

Parameters:

baseViewFormat - The BaseViewFormat for this BaseViewFormatHandle.

getViewFormatID

public java.lang.String getViewFormatID()

Retrieves the ID of the BaseViewFormat that this BaseViewFormatHandle wraps.

Returns:

The ID for the wrapped BaseViewFormat, or null if no ID has been specified.

setViewFormatID

public void setViewFormatID(java.lang.String id)

Specifies a unique ID for BaseViewFormat that this BaseViewFormatHandle wraps.

Parameters:

id - An ID for the BaseViewFormat.

getRunRulesForViewFormat

public int getRunRulesForViewFormat()

Indicates whether the view should run rules on the cell for which the BaseViewFormat provides formatting. If the view runs rules, then the format settings in the BaseViewFormat can be overridden by those specified in the rules. If the view does not run rules, then the format settings in the BaseViewFormat determine the number formatting for the cell.

Returns:

A constant that indicates whether the view should run rules that can override settings in the BaseViewFormat that this BaseViewFormatHandle wraps. Valid constants are listed in the See Also section.

See Also:

BaseMergeableHandle.RUN_RULES, BaseMergeableHandle.DO_NOT_RUN_RULES

setRunRulesForViewFormat

public void setRunRulesForViewFormat(int runRules)

Specifies whether the view should run rules on the cell for which the BaseViewFormat provides formatting. If the view runs rules, then the format settings in the BaseViewFormat can be overridden by those specified in the rules. If the view does not run rules, then the format settings in the BaseViewFormat determine the number formatting for the cell.

Parameters:

runRules - A constant that indicates whether the view should run rules that can override settings in the BaseViewFormat that this BaseViewFormatHandle wraps. Valid constants are listed in the See Also section.

See Also:

BaseMergeableHandle.RUN_RULES, BaseMergeableHandle.DO_NOT_RUN_RULES