|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.ReferencableStructure
org.eclipse.birt.report.model.api.elements.structures.ConfigVariable
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:
Field Summary | |
static java.lang.String |
CONFIG_VAR_STRUCT
Name of this structure. |
static java.lang.String |
NAME_MEMBER
Name of the config variable name member. |
static java.lang.String |
VALUE_MEMBER
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 | |
ConfigVariable()
Constructs the config var with a required name. |
Method Summary | |
protected java.lang.Object |
getIntrinsicProperty(java.lang.String memberName)
|
java.lang.String |
getName()
Returns the config variable name. |
java.lang.String |
getReferencableProperty()
|
java.lang.String |
getStructName()
Returns the name of the structure definition. |
java.lang.String |
getValue()
Returns the config variable value. |
StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
|
boolean |
isReferencableProperty(java.lang.String memberName)
|
protected void |
setIntrinsicProperty(java.lang.String memberName,
java.lang.Object value)
|
void |
setName(java.lang.String name)
Sets the config variable name. |
void |
setValue(java.lang.String value)
Sets the config vatiable value. |
java.lang.String |
toString()
|
java.util.List |
validate(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
|
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 |
copy, equals, getContext, getDefn, getElement, getHandle, getHandle, getListMemberRef, getLocalProperty, getObjectDefn, getProperty, isDesignTime, setContext, setProperty, setProperty, updateReference |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String CONFIG_VAR_STRUCT
public static final java.lang.String NAME_MEMBER
public static final java.lang.String VALUE_MEMBER
Constructor Detail |
public ConfigVariable()
Method Detail |
public java.lang.String getStructName()
IStructure
protected java.lang.Object getIntrinsicProperty(java.lang.String memberName)
protected void setIntrinsicProperty(java.lang.String memberName, java.lang.Object value)
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name to setpublic java.lang.String getValue()
public void setValue(java.lang.String value)
value
- the config value to setpublic java.lang.String toString()
public StructureHandle handle(SimpleValueHandle valueHandle, int index)
public java.util.List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
public boolean isReferencableProperty(java.lang.String memberName)
public java.lang.String getReferencableProperty()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |