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

java.lang.Object
  extended byorg.eclipse.birt.report.model.core.Structure
      extended byorg.eclipse.birt.report.model.api.elements.structures.AggregationArgument
All Implemented Interfaces:
java.lang.Cloneable, org.eclipse.birt.report.model.core.IPropertySet, IStructure

public class AggregationArgument
extends org.eclipse.birt.report.model.core.Structure

AggregationArgument.


Field Summary
static java.lang.String NAME_MEMBER
          Name of the argument name member.
static java.lang.String STRUCTURE_NAME
          Name of this structure.
static java.lang.String VALUE_MEMBER
          Name of the value member.
 
Constructor Summary
AggregationArgument()
           
 
Method Summary
protected  java.lang.Object getIntrinsicProperty(java.lang.String propName)
          Returns the value of a structure property represented as a member variable.
 java.lang.String getName()
          Returns the argument name.
 java.lang.String getStructName()
          Returns the name of the structure definition.
 java.lang.String getValue()
          Returns the argument value.
 StructureHandle handle(SimpleValueHandle valueHandle, int index)
          Creates the specific handle of this structure.
protected  void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
          Sets the value of of a structure property represented as a member variable.
 void setName(java.lang.String argumentName)
          Sets the argument name.
 void setValue(java.lang.String argumentValue)
          Sets the argument value.
 java.util.List 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
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

STRUCTURE_NAME

public static final java.lang.String STRUCTURE_NAME
Name of this structure. Matches the definition in the meta-data dictionary.

See Also:
Constant Field Values

NAME_MEMBER

public static final java.lang.String NAME_MEMBER
Name of the argument name member.

See Also:
Constant Field Values

VALUE_MEMBER

public static final java.lang.String VALUE_MEMBER
Name of the value member.

See Also:
Constant Field Values
Constructor Detail

AggregationArgument

public AggregationArgument()
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)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.

Parameters:
propName - name of the property
Returns:
the value of the property, or null if the property is not set

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                                    java.lang.Object value)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.

Parameters:
propName - the name of the property to set
value - the property value

getName

public java.lang.String getName()
Returns the argument name.

Returns:
the argument name.

setName

public void setName(java.lang.String argumentName)
Sets the argument name.

Parameters:
argumentName - the argument name to set

getValue

public java.lang.String getValue()
Returns the argument value.

Returns:
the argument value.

setValue

public void setValue(java.lang.String argumentValue)
Sets the argument value.

Parameters:
argumentValue - the argument value to set

handle

public StructureHandle handle(SimpleValueHandle valueHandle,
                              int index)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.

Parameters:
valueHandle - the value handle of this structure list property this structure is in
index - the position of this structure in structure list
Returns:
the handle of this structure.

validate

public java.util.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 of PropertyValueException.

Parameters:
module - the module
element - the element contains this structure
Returns:
the semantic error list


Copyright © 2005 Actuate Corp. All rights reserved.