org.eclipse.birt.report.model.api.elements.structures
Class IncludeScript

java.lang.Object
  org.eclipse.birt.report.model.core.Structure
      org.eclipse.birt.report.model.api.elements.structures.IncludeScript

All Implemented Interfaces:

java.lang.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 ReportDesigngives 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

static java.lang.String	FILE_NAME_MEMBER Name of the "file-name" property.
protected java.lang.String	fileName Value of the file name property.
static java.lang.String	INCLUDE_SCRIPT_STRUCT Name of this structure.

Constructor Summary

IncludeScript()
Default constructor.

IncludeScript(java.lang.String fileName)
Constructs the script with the required file name.

Method Summary

java.lang.String	getFileName() Returns file name of the script.
protected java.lang.Object	getIntrinsicProperty(java.lang.String propName)
java.lang.String	getStructName() Returns the name of the structure definition.
protected StructureHandle	handle(SimpleValueHandle valueHandle, int index)
void	setFileName(java.lang.String fileName) Sets the file name of the script.
protected void	setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
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.Structure

copy, equals, getContext, getDefn, getElement, getHandle, getHandle, getListMemberRef, getLocalProperty, getLocalProperty, getObjectDefn, getProperty, getProperty, getReferencableProperty, isDesignTime, isReferencable, setContext, setProperty, setProperty, updateReference

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INCLUDE_SCRIPT_STRUCT

public static final java.lang.String INCLUDE_SCRIPT_STRUCT

Name of this structure. Matches the definition in the meta-data dictionary.

See Also:

Constant Field Values

FILE_NAME_MEMBER

public static final java.lang.String FILE_NAME_MEMBER

Name of the "file-name" property.

See Also:

Constant Field Values

fileName

protected java.lang.String fileName

Value of the file name property.

Constructor Detail

IncludeScript

public IncludeScript()

Default constructor.

IncludeScript

public IncludeScript(java.lang.String fileName)

Constructs the script with the required file name.

Parameters:

fileName - file name of the script

Method Detail

getStructName

public java.lang.String 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

protected java.lang.Object getIntrinsicProperty(java.lang.String propName)

Specified by:

getIntrinsicProperty in class org.eclipse.birt.report.model.core.Structure

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                                    java.lang.Object value)

Specified by:

setIntrinsicProperty in class org.eclipse.birt.report.model.core.Structure

getFileName

public java.lang.String getFileName()

Returns file name of the script.

Returns:

file name of the script

setFileName

public void setFileName(java.lang.String fileName)

Sets the file name of the script.

Parameters:

fileName - the file name to set

validate

public java.util.List validate(org.eclipse.birt.report.model.core.Module module,
                               org.eclipse.birt.report.model.core.DesignElement element)

Overrides:

validate in class org.eclipse.birt.report.model.core.Structure

handle

protected StructureHandle handle(SimpleValueHandle valueHandle,
                                 int index)

Specified by:

handle in class org.eclipse.birt.report.model.core.Structure