Class ConfigVariable
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.ReferencableStructure
org.eclipse.birt.report.model.api.elements.structures.ConfigVariable
- All Implemented Interfaces:
Cloneable
,IStructure
,org.eclipse.birt.report.model.core.IPropertySet
,org.eclipse.birt.report.model.core.IReferencable
public class ConfigVariable
extends org.eclipse.birt.report.model.core.ReferencableStructure
This class represents a configuration variable in the report's config
variable list. Reports frequently have deployment-specific dependencies. For
example, developers often use a test database during development, but target
a production database once the report is deployed. Or, an OEM may use a
different company name in report titles for each of their customers.A
configuration variable is simply a name/value pair very similar to an
environment variable on Unix. Indeed, configuration variables include
environment variables, along with other BIRT-specific values.
This is a managed object, meaning that all changes should be made though the command layer so that they can be undone and redone. Each config variable has the following properties:
- Name
- a config variable has a unique and required name, so the report design can use the variable name to identify a config variable.
- Value
- value of the config variable.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Name of this structure.static final String
Name of the config variable name member.static final String
Name of the config variable value member.Fields inherited from class org.eclipse.birt.report.model.core.ReferencableStructure
clients, clientStructures, LIB_REFERENCE_MEMBER, libReference
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Object
getIntrinsicProperty
(String memberName) Returns the value of a structure property represented as a member variable.getName()
Returns the config variable name.Gets the value of the referencable member.Returns the name of the structure definition.getValue()
Returns the config variable value.handle
(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.boolean
isReferencableProperty
(String memberName) Checks whether the member of the input name is the referencable member or not.protected void
setIntrinsicProperty
(String memberName, Object value) Sets the value of of a structure property represented as a member variable.void
Sets the config variable name.void
Sets the config vatiable value.toString()
validate
(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validate whether this structure is valid.Methods inherited from class org.eclipse.birt.report.model.core.ReferencableStructure
addClient, addClientStructure, broadcast, clone, dropClient, dropClientStructure, getClientList, getClientStructures, getLocalProperty, getProperty, hasReferences, isReferencable, updateReference
Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getStringProperty, isDesignTime, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference
-
Field Details
-
CONFIG_VAR_STRUCT
Name of this structure. Matches the definition in the meta-data dictionary.- See Also:
-
NAME_MEMBER
Name of the config variable name member.- See Also:
-
VALUE_MEMBER
Name of the config variable value member.- See Also:
-
-
Constructor Details
-
ConfigVariable
public ConfigVariable()Constructs the config var with a required name.
-
-
Method Details
-
getStructName
Description copied from interface:IStructure
Returns 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.
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.- Overrides:
getIntrinsicProperty
in classorg.eclipse.birt.report.model.core.ReferencableStructure
- 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.Structure
Sets the value of of a structure property represented as a member variable.- Overrides:
setIntrinsicProperty
in classorg.eclipse.birt.report.model.core.ReferencableStructure
- Parameters:
memberName
- the name of the property to setvalue
- the property value
-
getName
Returns the config variable name.- Returns:
- the config variable name.
-
setName
Sets the config variable name.- Parameters:
name
- the name to set
-
getValue
Returns the config variable value.- Returns:
- the config variable value.
-
setValue
Sets the config vatiable value.- Parameters:
value
- the config value to set
-
toString
-
handle
Description copied from class:org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.- Specified by:
handle
in 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.
-
validate
public List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Description copied from class:org.eclipse.birt.report.model.core.Structure
Validate whether this structure is valid. The derived class should override this method if semantic check is needed. The each error is the instance ofPropertyValueException
.- Overrides:
validate
in classorg.eclipse.birt.report.model.core.ReferencableStructure
- Parameters:
module
- the moduleelement
- the element contains this structure- Returns:
- the semantic error list
-
isReferencableProperty
Description copied from class:org.eclipse.birt.report.model.core.ReferencableStructure
Checks whether the member of the input name is the referencable member or not.- Specified by:
isReferencableProperty
in classorg.eclipse.birt.report.model.core.ReferencableStructure
- Parameters:
memberName
- the member name to check- Returns:
- true if the member with the given name is referencable, otherwise false
-
getReferencableProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Gets the value of the referencable member.- Overrides:
getReferencableProperty
in classorg.eclipse.birt.report.model.core.Structure
- Returns:
- the value of the referencable member
-