Class IncludeScript
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.IncludeScript
- All Implemented Interfaces:
Cloneable
,IStructure
,org.eclipse.birt.report.model.core.IPropertySet
public class IncludeScript
extends org.eclipse.birt.report.model.core.Structure
This class represents a include script. The class gives the file name of the
include script. Used when a report design
ReportDesign
gives a file
name of include script in the report design. Each script in report design has
the following properties:
- File Name
- a include script structure in the report design has a required file name to load the script.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.IncludeScript
(String fileName) Constructs the script with the required file name. -
Method Summary
Modifier and TypeMethodDescriptionReturns file name of the script.protected Object
getIntrinsicProperty
(String propName) Returns the value of a structure property represented as a member variable.Returns the name of the structure definition.protected StructureHandle
handle
(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.void
setFileName
(String fileName) Sets the file name of the script.protected void
setIntrinsicProperty
(String propName, Object value) Sets the value of of a structure property represented as a member variable.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.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference
-
Field Details
-
INCLUDE_SCRIPT_STRUCT
Name of this structure. Matches the definition in the meta-data dictionary.- See Also:
-
FILE_NAME_MEMBER
Name of the "file-name" property.- See Also:
-
fileName
Value of the file name property.
-
-
Constructor Details
-
IncludeScript
public IncludeScript()Default constructor. -
IncludeScript
Constructs the script with the required file name.- Parameters:
fileName
- file name of the script
-
-
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.- Specified by:
getIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- 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.- Specified by:
setIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- the name of the property to setvalue
- the property value
-
getFileName
Returns file name of the script.- Returns:
- file name of the script
-
setFileName
Sets the file name of the script.- Parameters:
fileName
- the file name to set
-
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.Structure
- Parameters:
module
- the moduleelement
- the element contains this structure- Returns:
- the semantic error list
-
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.
-