Class FormatValue
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.FormatValue
- All Implemented Interfaces:
Cloneable,IStructure,org.eclipse.birt.report.model.core.IPropertySet
- Direct Known Subclasses:
DateFormatValue,DateTimeFormatValue,NumberFormatValue,ParameterFormatValue,StringFormatValue,TimeFormatValue
public class FormatValue
extends org.eclipse.birt.report.model.core.Structure
The abstract value for the format of string, data-time and number.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the variable name.getHandle(SimpleValueHandle valueHandle) Gets the specific handle of this structure.protected ObjectgetIntrinsicProperty(String memberName) Returns the value of a structure property represented as a member variable.com.ibm.icu.util.ULocaleGets the ULocale.Returns the variable value.Returns the name of the structure definition.protected StructureHandlehandle(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.voidsetCategory(String name) Sets the variable name.protected voidsetIntrinsicProperty(String memberName, Object value) Sets the value of of a structure property represented as a member variable.voidsetLocale(com.ibm.icu.util.ULocale value) Sets the ULocale.voidsetPattern(String value) Sets the variable value.toString()Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference, validate
-
Field Details
-
FORMAT_VALUE_STRUCT
Name of the format value structure.- See Also:
-
CATEGORY_MEMBER
Name of the config variable category member.- See Also:
-
PATTERN_MEMBER
Name of the config variable pattern member.- See Also:
-
LOCALE_MEMBER
Name of the config variable locale member.- See Also:
-
-
Constructor Details
-
FormatValue
public FormatValue()
-
-
Method Details
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.StructureReturns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- Parameters:
memberName- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.StructureSets the value of of a structure property represented as a member variable.- Specified by:
setIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- Parameters:
memberName- the name of the property to setvalue- the property value
-
getCategory
Returns the variable name.- Returns:
- the variable name
-
setCategory
Sets the variable name.- Parameters:
name- the name to set
-
getPattern
Returns the variable value.- Returns:
- the variable value
-
setPattern
Sets the variable value.- Parameters:
value- the value to set
-
getLocale
public com.ibm.icu.util.ULocale getLocale()Gets the ULocale.- Returns:
- the ULocale.
-
setLocale
public void setLocale(com.ibm.icu.util.ULocale value) Sets the ULocale.- Parameters:
value- the value of the ULocale.
-
toString
-
getStructName
Description copied from interface:IStructureReturns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
handle
Description copied from class:org.eclipse.birt.report.model.core.StructureCreates the specific handle of this structure. This handle is always created.- Specified by:
handlein classorg.eclipse.birt.report.model.core.Structure- Parameters:
valueHandle- the value handle of this structure list property this structure is inindex- the position of this structure in structure list- Returns:
- the handle of this structure.
-
getHandle
Description copied from class:org.eclipse.birt.report.model.core.StructureGets the specific handle of this structure. This structure must be in the element's structure list. The structure handle is transient because the position in the structure list is kept. The position changes if any structure is added, or dropped. So this handle should not be kept.- Overrides:
getHandlein classorg.eclipse.birt.report.model.core.Structure- Parameters:
valueHandle- the value handle of this structure list property this structure is in- Returns:
- the handle of this structure. If this structure is not in the
valueHandle,nullis returned.
-