oracle.dss.dataView
Class ViewFormatHandle

java.lang.Object
  oracle.dss.util.format.BaseMergeableHandle
      oracle.dss.util.format.BaseViewFormatHandle
          oracle.dss.dataView.ViewFormatHandle

All Implemented Interfaces:

Formattable

public class ViewFormatHandle
extends BaseViewFormatHandle
implements Formattable

Wrapper class for returning a ViewFormat 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 ViewFormatHandle. The view uses the ViewFormat that this handle wraps, to format numbers in a cell. The settings in the wrapped ViewFormat take precedence over those in the default ViewFormat for a view component.

The RunRulesForViewFormat property of this ViewFormatHandle determines whether the view runs rules that can modify the wrapped ViewFormat. If the view does not run rules, then the wrapped ViewFormat specifies all of the number formatting for the cell.

Field Summary

protected ViewFormat

m_viewFormat

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

m_baseViewFormat, m_runRulesForViewFormat, m_viewFormatID

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

DO_NOT_RUN_RULES, RUN_RULES

Constructor Summary

ViewFormatHandle()
Constructor that takes no arguments.

ViewFormatHandle(ViewFormat vf, java.lang.String id, int runRules)
Constructor that specifies a ViewFormat, an ID, and whether rules apply to the cell.

Method Summary

ViewFormat	getViewFormat() Retrieves the ViewFormat that this object wraps.
oracle.dss.util.xml.ObjectNode	getXML(java.lang.String name, boolean allProperties) Retrieves XML that represents properties and their values in the form of and ObjectNode.
void	setBaseViewFormat(BaseViewFormat baseViewFormat) Specifies the BaseViewFormat that this object wraps.
void	setViewFormat(ViewFormat vf) Specifies the ViewFormat that this object wraps.
void	setXML(oracle.dss.util.xml.ObjectNode node) Specifies XML that represents properties and values.

Methods inherited from class oracle.dss.util.format.BaseViewFormatHandle

getBaseViewFormat, getRunRulesForViewFormat, getViewFormatID, setRunRulesForViewFormat, setViewFormatID

Methods inherited from class java.lang.Object

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

Field Detail

m_viewFormat

protected ViewFormat m_viewFormat

For internal use only. Application developers should not use this

member variable for ViewFormat property

Constructor Detail

ViewFormatHandle

public ViewFormatHandle()

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

See Also:

setViewFormat(oracle.dss.dataView.managers.ViewFormat), BaseViewFormatHandle.setViewFormatID(java.lang.String), BaseViewFormatHandle.setRunRulesForViewFormat(int)

ViewFormatHandle

public ViewFormatHandle(ViewFormat vf,
                        java.lang.String id,
                        int runRules)

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

Parameters:

vf - The ViewFormat for this object to wrap.

id - A unique ID for the ViewFormat.

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

getViewFormat

public ViewFormat getViewFormat()

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

Specified by:

getViewFormat in interface Formattable

Returns:

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

setViewFormat

public void setViewFormat(ViewFormat vf)

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

Specified by:

setViewFormat in interface Formattable

Parameters:

vf - The ViewFormat for this ViewFormatHandle.

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.

Overrides:

setBaseViewFormat in class BaseViewFormatHandle

Parameters:

baseViewFormat - The BaseViewFormat for this BaseViewFormatHandle.

getXML

public oracle.dss.util.xml.ObjectNode getXML(java.lang.String name,
                                             boolean allProperties)

Retrieves XML that represents properties and their values in the form of and ObjectNode.

Parameters:

allProperties - true to store all property values in XML, false to store only values that are different from default values.

Returns:

XML for the properties and values.

setXML

public void setXML(oracle.dss.util.xml.ObjectNode node)

Specifies XML that represents properties and values.

Parameters:

node - ObjectNode that has the properties and their values.