oracle.dss.gridView
Class UIFormat

java.lang.Object
  |
  +--oracle.dss.gridView.UIFormat

All Implemented Interfaces:

Persistable, StringXMLizable

public class UIFormat

extends java.lang.Object

implements Persistable

An object to define a Crosstab/Table format, which aggregates ViewStyle or ViewFormat or both and a discriminator. Format is used by our UI panels and toolbar.

Field Summary

static int	DATABODY This format will be added to "DATA FORMAT"
static int	DATABODY_VIEWFORMAT format is for databody format only
static int	DATABODY_VIEWSTYLE format is for databody viewstyle only
static int	DATE_CUSTOM Custom date format
static int	DATE_DATETIME Use defined date and time format
static int	DATE_DEFAULT Use default date format
static int	DATE_GENERAL Use defined date format
static int	DATE_NONE No date format
static int	DATE_TIME Use defined time format
static int	FT_APP_DEFINED format type is application added default format
static int	FT_DEFAULT format type is default format
static int	FT_END_USER_DEFINED format type is user defined format
static int	HEADER This format will be added to "HEADER FORMAT"
static int	HEADER_VIEWSTYLE format is for header viewstyle only
static int	NO_NUMBER_DATE No number or date format.
static int	NUMBER_CURRENCY Number format to currecy
static int	NUMBER_CUSTOM Custom number format
static int	NUMBER_DEFAULT Use default number format set by applications
static int	NUMBER_GENERAL Use default number format set by applications
static int	NUMBER_NONE No number format
static int	NUMBER_PERCENT Number format to percent
static java.lang.String	TYPE

Constructor Summary

UIFormat()
This constructor creates default UI format.

UIFormat(java.lang.String name, int mergeableType, int formatType, int group, Discriminator discriminator, ViewStyle viewStyle, ViewFormat viewFormat, java.util.Vector conditions, boolean negativeRed, int numberOrDate, java.lang.String numberFormatString)
This constructor creates a UI format.

Method Summary

java.util.Vector	getConditions() Returns the conditions associated with the format
Discriminator	getDiscriminator() Returns discriminator of this format
int	getFormatType() Returns the type of the object.
int	getGroup() Returns the group of format.
int	getMergeableType() Returns the mergeable type of the format.
java.lang.String	getName() Returns the display name of the format.
int	getNumberOrDateCategory() Returns whether selection is number or date and the category of number or date formatting
java.lang.String	getNumberOrDateFormatString() Get the customized number format string
PersistableAttributes	getPersistableAttributes(PersistableAttributes oldAttrs) Retrieves the attributes of the component, for searching.
ViewFormat	getViewFormat() Returns ViewFormat of this format
ViewStyle	getViewStyle() Returns view style of this format
java.lang.String	getXMLAsString() Return XML string
boolean	isNegativeRed() Returns negative numbers are red or not by default
void	setConditions(java.util.Vector conditions) Sets the conditions associated with the format
void	setDiscriminator(Discriminator discriminator) Sets the discriminator of this format
void	setFormatType(int type) Sets the format type of the object.
void	setGroup(int group) Sets the group of the format.
void	setMergeableType(int type) Sets the mergeable type of the format.
void	setName(java.lang.String name) Sets the name of format, i.e.
void	setNegativeRed(boolean red) Sets if negative numbers are red or not by default
void	setNumberOrDateCategory(int type) Sets whether selection is number or date and the category of number or date formatting
void	setNumberOrDateFormatString(java.lang.String patternString) Set the customized number format string
void	setPersistableAttributes(PersistableAttributes attrs) Specifies attributes that can be used for searching in the BI Beans Catalog.
void	setViewFormat(ViewFormat viewFormat) Sets the ViewFormat of this format
void	setViewStyle(ViewStyle viewStyle) Sets the view style of this format
boolean	setXMLAsString(java.lang.String xml) Set XML String on UIFormats

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.util.persistence.Persistable

getPersistableComponents, initialize, setPersistableComponents

Field Detail

HEADER_VIEWSTYLE

public static final int HEADER_VIEWSTYLE

format is for header viewstyle only

DATABODY_VIEWSTYLE

public static final int DATABODY_VIEWSTYLE

format is for databody viewstyle only

DATABODY_VIEWFORMAT

public static final int DATABODY_VIEWFORMAT

format is for databody format only

FT_DEFAULT

public static final int FT_DEFAULT

format type is default format

FT_APP_DEFINED

public static final int FT_APP_DEFINED

format type is application added default format

FT_END_USER_DEFINED

public static final int FT_END_USER_DEFINED

format type is user defined format

NO_NUMBER_DATE

public static final int NO_NUMBER_DATE

No number or date format. No number or date panel will show on FormatPanel dialog

NUMBER_NONE

public static final int NUMBER_NONE

No number format

NUMBER_DEFAULT

public static final int NUMBER_DEFAULT

Use default number format set by applications

NUMBER_GENERAL

public static final int NUMBER_GENERAL

Use default number format set by applications

NUMBER_CURRENCY

public static final int NUMBER_CURRENCY

Number format to currecy

NUMBER_PERCENT

public static final int NUMBER_PERCENT

Number format to percent

NUMBER_CUSTOM

public static final int NUMBER_CUSTOM

Custom number format

DATE_NONE

public static final int DATE_NONE

No date format

DATE_DEFAULT

public static final int DATE_DEFAULT

Use default date format

DATE_GENERAL

public static final int DATE_GENERAL

Use defined date format

DATE_TIME

public static final int DATE_TIME

Use defined time format

DATE_DATETIME

public static final int DATE_DATETIME

Use defined date and time format

DATE_CUSTOM

public static final int DATE_CUSTOM

Custom date format

HEADER

public static final int HEADER

This format will be added to "HEADER FORMAT"

DATABODY

public static final int DATABODY

This format will be added to "DATA FORMAT"

TYPE

public static final java.lang.String TYPE

Constructor Detail

UIFormat

public UIFormat()

This constructor creates default UI format.

UIFormat

public UIFormat(java.lang.String name,
                int mergeableType,
                int formatType,
                int group,
Discriminator discriminator,
ViewStyle viewStyle,
ViewFormat viewFormat,
                java.util.Vector conditions,
                boolean negativeRed,
                int numberOrDate,
                java.lang.String numberFormatString)

This constructor creates a UI format.

Parameters:

name - Name of a format, i.e., "MyFormat 1".

mergeableType - this type describes whether this format aggregates ViewStyle or ViewFormat mergeables.

formatType - describes the format type, if it's a default format, or an application added default format or user defined format

group - an integer describes which group this format will be added to Format panel. HEADER is reserved for HeaderFormat group, DATABODY is reserved for DataFormat group. Application can add their own group.

discriminator - the Discriminator of the view style rule and view format rule for this format, for example, if this format says first row color it red, then first row is the discriminator

viewStyle - a ViewStyle mergeable of this format, if this format does not include a ViewStyle mergeable, set it null

viewFormat - a ViewFormat mergeableof this format, if this format does not include a ViewFormat mergeable, set it null

conditions - a vector of ConditionElement describes conditions on RulesPanel

negativeRed - a boolean indicates whether to color negative number red or not, true is red

numberOrDate - show number or date panel, and the category on each panel. to calculate the numberOrDate , use (number panel category << 4 ) | date panel category

numberFormatString - customized number format string, i.e. "$0"

See Also:

HEADER_VIEWSTYLE, DATABODY_VIEWSTYLE, DATABODY_VIEWFORMAT, FT_DEFAULT, FT_APP_DEFINED, FT_END_USER_DEFINED, HEADER, DATABODY

Method Detail

setName

public void setName(java.lang.String name)

Sets the name of format, i.e. "MyFormat 1"

getName

public java.lang.String getName()

Returns the display name of the format.

setMergeableType

public void setMergeableType(int type)

Sets the mergeable type of the format.

See Also:

HEADER_VIEWSTYLE, DATABODY_VIEWSTYLE, DATABODY_VIEWFORMAT

getMergeableType

public int getMergeableType()

Returns the mergeable type of the format.

See Also:

HEADER_VIEWSTYLE, DATABODY_VIEWSTYLE, DATABODY_VIEWFORMAT

setFormatType

public void setFormatType(int type)

Sets the format type of the object.

See Also:

FT_DEFAULT, FT_APP_DEFINED, FT_END_USER_DEFINED

getFormatType

public int getFormatType()

Returns the type of the object.

See Also:

FT_DEFAULT, FT_APP_DEFINED, FT_END_USER_DEFINED

setGroup

public void setGroup(int group)

Sets the group of the format.

See Also:

HEADER, DATABODY

getGroup

public int getGroup()

Returns the group of format.

See Also:

HEADER, DATABODY

setNegativeRed

public void setNegativeRed(boolean red)

Sets if negative numbers are red or not by default

isNegativeRed

public boolean isNegativeRed()

Returns negative numbers are red or not by default

setNumberOrDateCategory

public void setNumberOrDateCategory(int type)

Sets whether selection is number or date and the category of number or date formatting

getNumberOrDateCategory

public int getNumberOrDateCategory()

Returns whether selection is number or date and the category of number or date formatting

setNumberOrDateFormatString

public void setNumberOrDateFormatString(java.lang.String patternString)

Set the customized number format string

getNumberOrDateFormatString

public java.lang.String getNumberOrDateFormatString()

Get the customized number format string

setViewStyle

public void setViewStyle(ViewStyle viewStyle)

Sets the view style of this format

getViewStyle

public ViewStyle getViewStyle()

Returns view style of this format

setViewFormat

public void setViewFormat(ViewFormat viewFormat)

Sets the ViewFormat of this format

getViewFormat

public ViewFormat getViewFormat()

Returns ViewFormat of this format

setDiscriminator

public void setDiscriminator(Discriminator discriminator)

Sets the discriminator of this format

getDiscriminator

public Discriminator getDiscriminator()

Returns discriminator of this format

setConditions

public void setConditions(java.util.Vector conditions)

Sets the conditions associated with the format

getConditions

public java.util.Vector getConditions()

Returns the conditions associated with the format

getPersistableAttributes

public PersistableAttributes getPersistableAttributes(PersistableAttributes oldAttrs)

Description copied from interface: Persistable

Retrieves the attributes of the component, for searching. The attributes are used by the persistence service, when users search the BI Beans Catalog for components that have particular attribute values.

Specified by:

getPersistableAttributes in interface Persistable

Following copied from interface: oracle.dss.util.persistence.Persistable

Parameters:

attrs - The searchable attributes that the application has defined for this component.

Returns:

The full set of attributes for the component.

setPersistableAttributes

public void setPersistableAttributes(PersistableAttributes attrs)

Description copied from interface: Persistable

Specifies attributes that can be used for searching in the BI Beans Catalog.

Specified by:

setPersistableAttributes in interface Persistable

Following copied from interface: oracle.dss.util.persistence.Persistable

Parameters:

attrs - PersistableAttributes that specify search attributes for the component.

getXMLAsString

public java.lang.String getXMLAsString()
                                throws BIPersistenceException

Return XML string

Specified by:

getXMLAsString in interface StringXMLizable

Following copied from interface: oracle.dss.util.persistence.StringXMLizable

Returns:

The XML representation of this component.

Throws:

BIPersistenceException - If a problem occurs in getting the XML.

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws BIPersistenceException

Set XML String on UIFormats

Specified by:

setXMLAsString in interface StringXMLizable

Following copied from interface: oracle.dss.util.persistence.StringXMLizable

Parameters:

name - The XML representation of the component.

Returns:

true the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.