*** This interface is subject to change. ***

com.sas.iquery.metadata.serverprop.formats
Interface SASFormatDescription

public interface SASFormatDescription

Provides information about a SAS data server format.

Information available from this interface includes:

• The base format name -- in the form of a String. This base name is the attribute used when setting a data item's format via DataItem.setFormat()
• A description of the format
• An example usage of the format
• The type (a.k.a. category) of the format
• Width information about the format

See Also:

DataItem.setFormat(String)

Method Summary

java.lang.String	getBaseFormatName() Returns the base format name.
int	getDefaultDecimalWidth() Returns the default decimal width for the format described.
int	getDefaultWidth() Returns the default width for the format described.
java.lang.String	getDescription() Returns description of the format.
java.lang.String	getDescription(java.util.Locale locale) Returns description of the format for the specified locale.
java.lang.String	getExample() Returns an Example String for this format description
java.lang.String	getExample(java.util.Locale userLocale, boolean dualExample) Returns the format example for the locale specified.
int	getMaxDecimalWidth() Returns the maximum decimal value for the format described.
int	getMaxWidth() Returns the maximum width for the format described.
int	getMinDecimalWidth() Returns the minimum decimal value for the format described.
int	getMinWidth() Returns the minimum width for the format described.
SASFormatCategory	getType() Returns the type.
boolean	isDecimalWidthSupported() Returns true if the format being described has a decimal width (d value) parameter.
boolean	isLocalized() Returns true if the format is a locale based format, i.e., the output of this format will be localized based on the locale.

Method Detail

*** This method is subject to change. ***

getType

SASFormatCategory getType()

Returns the type.

Returns:

SASFormatCategory type

*** This method is subject to change. ***

getBaseFormatName

java.lang.String getBaseFormatName()

Returns the base format name.

Returns:

the base format name

*** This method is subject to change. ***

getDescription

java.lang.String getDescription()

Returns description of the format. A null string is returned if the resource bundle cannot be loaded.

Returns:

description

*** This method is subject to change. ***

getDescription

java.lang.String getDescription(java.util.Locale locale)

Returns description of the format for the specified locale. A null string is returned if the resource bundle cannot be loaded.

Parameters:

locale -

Returns:

description

*** This method is subject to change. ***

getMaxWidth

int getMaxWidth()

Returns the maximum width for the format described.

Returns:

max width -1 if not defined

*** This method is subject to change. ***

getMinWidth

int getMinWidth()

Returns the minimum width for the format described.

Returns:

min width -1 if not defined

*** This method is subject to change. ***

getDefaultWidth

int getDefaultWidth()

Returns the default width for the format described.

Returns:

the default width -1 if not defined

*** This method is subject to change. ***

getDefaultDecimalWidth

int getDefaultDecimalWidth()

Returns the default decimal width for the format described. If the format does not support a decimal value -1 is returned.

Returns:

defaultDecimalWidth -1 if not defined

*** This method is subject to change. ***

getMaxDecimalWidth

int getMaxDecimalWidth()

Returns the maximum decimal value for the format described. If the format does not support a d value -1 is returned.

Returns:

maxDecimalWidth -1 if not defined

*** This method is subject to change. ***

getMinDecimalWidth

int getMinDecimalWidth()

Returns the minimum decimal value for the format described. If the format does not support a d value -1 is returned.

Returns:

minDecimalWidth -1 if not defined

*** This method is subject to change. ***

isDecimalWidthSupported

boolean isDecimalWidthSupported()

Returns true if the format being described has a decimal width (d value) parameter.

*** This method is subject to change. ***

getExample

java.lang.String getExample()

Returns an Example String for this format description

Returns:

example String empty String if none available

*** This method is subject to change. ***

isLocalized

boolean isLocalized()

Returns true if the format is a locale based format, i.e., the output of this format will be localized based on the locale. The locale based formats are also referred as NL formats. Examples of locale based formats are NLBEST, NLTIME, etc.

Returns:

true if the format is a locale based format.

*** This method is subject to change. ***

getExample

java.lang.String getExample(java.util.Locale userLocale,
                            boolean dualExample)

Returns the format example for the locale specified. The format is applied to a format value and the formatted value is returned as example string.

Parameters:

userLocale - Locale in which user would like to get the example string.

dualExample - boolean indicating if two examples needs to be returned in two different locales.

Returns:

Localized example string.

*** This interface is subject to change. ***