|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignVisitor
public class DesignVisitor
Applies logic customized to each type of report element. This is an implementation of the classic visitor pattern. The application creates a derived iterator, and overrides methods for the elements of interest. The visitor can also walk the design tree, performing actions on each element down the containment hierarchy.
By default, each method calls the method for its parent element. That is, a DataItem method calls the ReportItem method which calls the DesignElement method.
Nested Class Summary | |
---|---|
protected class |
DesignVisitor.Forwarder
A class forward the visit of an element to its handle. |
Field Summary | |
---|---|
protected DesignVisitor.Forwarder |
forwarder
The private internal element visitor. |
Constructor Summary | |
---|---|
DesignVisitor()
Constructs a DesignVisitor , which is not related with the
specific report. |
Method Summary | |
---|---|
void |
apply(DesignElementHandle handle)
Applies this visitor to the given element. |
protected void |
visitAutoText(AutoTextHandle obj)
Visits auto text element |
protected void |
visitCascadingParameterGroup(CascadingParameterGroupHandle obj)
Visits the cascading parameter group element. |
protected void |
visitCell(CellHandle obj)
Visits the cell element. |
protected void |
visitColumn(ColumnHandle obj)
Visits the column element. |
protected void |
visitContents(DesignElementHandle obj,
java.lang.String propName)
Visits the content of this property. |
protected void |
visitContents(SlotHandle slot)
Visits the content of the slot. |
protected void |
visitCube(CubeHandle obj)
Visits the cube element. |
protected void |
visitDataItem(DataItemHandle obj)
Visits the data element. |
protected void |
visitDataSet(DataSetHandle obj)
Visits the data set element. |
protected void |
visitDataSource(DataSourceHandle obj)
Visits the data source element. |
protected void |
visitDesignElement(DesignElementHandle obj)
Visits the design element. |
protected void |
visitDimension(DimensionHandle obj)
Visits the dimension element. |
protected void |
visitExtendedDataSet(OdaDataSetHandle obj)
Visits the extended data set element. |
protected void |
visitExtendedDataSource(OdaDataSourceHandle obj)
Visits the extended data source element. |
protected void |
visitExtendedItem(ExtendedItemHandle obj)
Visits the extended element. |
protected void |
visitFreeForm(FreeFormHandle obj)
Visits the free form element. |
protected void |
visitGraphicMasterPage(GraphicMasterPageHandle obj)
Visits the graphic master page element. |
protected void |
visitGrid(GridHandle obj)
Visits the grid element. |
protected void |
visitGroup(GroupHandle obj)
Visits the group element. |
protected void |
visitHierarchy(HierarchyHandle obj)
Visits the hierarchy element. |
protected void |
visitImage(ImageHandle obj)
Visits the image element. |
protected void |
visitJointDataSet(JointDataSetHandle obj)
Visits the joint data set element. |
protected void |
visitLabel(LabelHandle obj)
Visits the label element. |
protected void |
visitLevel(LevelHandle obj)
Visits the level element. |
protected void |
visitLibrary(LibraryHandle obj)
Visits the library element. |
protected void |
visitLine(LineHandle obj)
Visits the line element. |
protected void |
visitList(ListHandle obj)
Visits the list element. |
protected void |
visitListGroup(ListGroupHandle obj)
Visits the list group element. |
protected void |
visitMasterPage(MasterPageHandle obj)
Visits the master page element. |
protected void |
visitMeasure(MeasureHandle obj)
Visits the measure element. |
protected void |
visitMeasureGroup(MeasureGroupHandle obj)
Visits the measure element. |
protected void |
visitModule(ModuleHandle obj)
Visits the module element |
protected void |
visitOdaCube(OdaCubeHandle obj)
Visits the cube element. |
protected void |
visitOdaDimension(OdaDimensionHandle obj)
Visits the dimension element. |
protected void |
visitOdaHierarchy(OdaHierarchyHandle obj)
Visits the hierarchy element. |
protected void |
visitOdaLevel(OdaLevelHandle obj)
Visits the level element. |
protected void |
visitOdaMeasure(OdaMeasureHandle obj)
Visits the measure element. |
protected void |
visitOdaMeasureGroup(OdaMeasureGroupHandle obj)
Visits the measure element. |
protected void |
visitParameter(ParameterHandle obj)
Visits the parameter element. |
protected void |
visitParameterGroup(ParameterGroupHandle obj)
Visits the parameter group element. |
protected void |
visitRectangle(RectangleHandle obj)
Visits the rectangle element. |
protected void |
visitReportDesign(ReportDesignHandle obj)
Visits the report design element. |
protected void |
visitReportItem(ReportItemHandle obj)
Visits the report item. |
protected void |
visitRow(RowHandle obj)
Visits the row element. |
protected void |
visitScalarParameter(ScalarParameterHandle obj)
Visits the scalar parameter element. |
protected void |
visitScriptDataSet(ScriptDataSetHandle obj)
Visits the script data set element. |
protected void |
visitScriptDataSource(ScriptDataSourceHandle obj)
Visits the extended element. |
protected void |
visitSimpleDataSet(DataSetHandle obj)
Visits the simple data set element. |
protected void |
visitSimpleMasterPage(SimpleMasterPageHandle obj)
Visits the simple master page element. |
protected void |
visitStyle(StyleHandle obj)
Visits the style element. |
protected void |
visitStyledElement(ReportItemHandle obj)
Visits the styled element. |
protected void |
visitTable(TableHandle obj)
Visits the table element. |
protected void |
visitTableGroup(TableGroupHandle obj)
Visits the table group element. |
protected void |
visitTabularCube(TabularCubeHandle obj)
Visits the cube element. |
protected void |
visitTabularDimension(TabularDimensionHandle obj)
Visits the dimension element. |
protected void |
visitTabularHierarchy(TabularHierarchyHandle obj)
Visits the hierarchy element. |
protected void |
visitTabularLevel(TabularLevelHandle obj)
Visits the level element. |
protected void |
visitTabularMeasure(TabularMeasureHandle obj)
Visits the measure element. |
protected void |
visitTabularMeasureGroup(TabularMeasureGroupHandle obj)
Visits the measure element. |
protected void |
visitTemplateDataSet(TemplateDataSetHandle obj)
Visits the template data set. |
protected void |
visitTemplateElement(TemplateElementHandle obj)
Visits the template element. |
protected void |
visitTemplateParameterDefinition(TemplateParameterDefinitionHandle obj)
Visits the template parameter definition. |
protected void |
visitTemplateReportItem(TemplateReportItemHandle obj)
Visits the template report item. |
protected void |
visitTextDataItem(TextDataHandle obj)
Visits the multi-line data element. |
protected void |
visitTextItem(TextItemHandle obj)
Visits the text element. |
protected void |
visitTheme(ThemeHandle obj)
Visits the theme element. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected DesignVisitor.Forwarder forwarder
Constructor Detail |
---|
public DesignVisitor()
DesignVisitor
, which is not related with the
specific report.
Method Detail |
---|
public void apply(DesignElementHandle handle)
handle
- handle to the element to visit.protected void visitFreeForm(FreeFormHandle obj)
obj
- the handle of the free form to traverseprotected void visitAutoText(AutoTextHandle obj)
obj
- protected void visitDataSet(DataSetHandle obj)
obj
- the handle of the data set to traverseprotected void visitSimpleDataSet(DataSetHandle obj)
obj
- the handle of the simple data set to traverseprotected void visitScriptDataSet(ScriptDataSetHandle obj)
obj
- the handle of the script data set to traverseprotected void visitJointDataSet(JointDataSetHandle obj)
obj
- the handle of the joint data set to traverseprotected void visitDataSource(DataSourceHandle obj)
obj
- the handle of data source to traverseprotected void visitLabel(LabelHandle obj)
obj
- the handle of the label to traverseprotected void visitDataItem(DataItemHandle obj)
obj
- the handle of the data to traverseprotected void visitTextItem(TextItemHandle obj)
obj
- the handle of the text to traverseprotected void visitImage(ImageHandle obj)
obj
- the handle of the image to traverseprotected void visitList(ListHandle obj)
obj
- the handle of the list to traverseprotected void visitGroup(GroupHandle obj)
obj
- the handle of the group to traverseprotected void visitListGroup(ListGroupHandle obj)
obj
- the handle of the list group to traverseprotected void visitTable(TableHandle obj)
obj
- the handle of the table to traverseprotected void visitTableGroup(TableGroupHandle obj)
obj
- the handle of the table group to traverseprotected void visitCell(CellHandle obj)
obj
- the handle of the cell to traverseprotected void visitColumn(ColumnHandle obj)
obj
- the handle of the column to traverseprotected void visitRow(RowHandle obj)
obj
- the handle of the row to traverseprotected void visitGrid(GridHandle obj)
obj
- the handle of the grid to traverseprotected void visitLine(LineHandle obj)
obj
- the handle of the line to traverseprotected void visitMasterPage(MasterPageHandle obj)
obj
- the handle of the master page to traverseprotected void visitParameterGroup(ParameterGroupHandle obj)
obj
- the handle of the parameter group to traverseprotected void visitCascadingParameterGroup(CascadingParameterGroupHandle obj)
obj
- the handle of the cascading parameter group to traverseprotected void visitModule(ModuleHandle obj)
obj
- the handle of the module to traverseprotected void visitLibrary(LibraryHandle obj)
obj
- the handle of the library to traverseprotected void visitReportDesign(ReportDesignHandle obj)
obj
- the handle of the report design to traverseprotected void visitScalarParameter(ScalarParameterHandle obj)
obj
- the handle of the scalar parameter to traverseprotected void visitStyle(StyleHandle obj)
obj
- the handle of the style to traverseprotected void visitParameter(ParameterHandle obj)
obj
- the handle of the parameter to traverseprotected void visitReportItem(ReportItemHandle obj)
obj
- the handle of report item to traverseprotected void visitStyledElement(ReportItemHandle obj)
obj
- the handle of styled element to traverseprotected void visitDesignElement(DesignElementHandle obj)
obj
- the handle of design element to traverseprotected void visitRectangle(RectangleHandle obj)
obj
- the handle of rectangle to traverseprotected void visitContents(SlotHandle slot)
slot
- the handle of a slot to traverseprotected void visitContents(DesignElementHandle obj, java.lang.String propName)
obj
- the container element where the contents residepropName
- name of the property where the contents resideprotected void visitTextDataItem(TextDataHandle obj)
obj
- the handle of a multi-line data to traverseprotected void visitExtendedItem(ExtendedItemHandle obj)
obj
- the handle of an extended element to traverseprotected void visitScriptDataSource(ScriptDataSourceHandle obj)
obj
- the handle of an extended element to traverseprotected void visitGraphicMasterPage(GraphicMasterPageHandle obj)
obj
- the handle of a graphic master page to traverseprotected void visitSimpleMasterPage(SimpleMasterPageHandle obj)
obj
- the handle of a simple master page to traverseprotected void visitExtendedDataSource(OdaDataSourceHandle obj)
obj
- the handle of a extended data source to traverseprotected void visitExtendedDataSet(OdaDataSetHandle obj)
obj
- the extended data set to traverseprotected void visitTheme(ThemeHandle obj)
obj
- the theme to traverseprotected void visitTemplateParameterDefinition(TemplateParameterDefinitionHandle obj)
obj
- the template parameter definition to traverseprotected void visitTemplateElement(TemplateElementHandle obj)
obj
- the template element to traverseprotected void visitTemplateReportItem(TemplateReportItemHandle obj)
obj
- the template report item to traverseprotected void visitTemplateDataSet(TemplateDataSetHandle obj)
obj
- the template data set to traverseprotected void visitTabularCube(TabularCubeHandle obj)
obj
- the cube element to traverseprotected void visitTabularDimension(TabularDimensionHandle obj)
obj
- the dimension element to traverseprotected void visitTabularHierarchy(TabularHierarchyHandle obj)
obj
- the hierarchy element to traverseprotected void visitTabularLevel(TabularLevelHandle obj)
obj
- the level element to traverseprotected void visitTabularMeasure(TabularMeasureHandle obj)
obj
- the measure element to traverseprotected void visitTabularMeasureGroup(TabularMeasureGroupHandle obj)
obj
- the measure element to traverseprotected void visitOdaCube(OdaCubeHandle obj)
obj
- the cube element to traverseprotected void visitOdaDimension(OdaDimensionHandle obj)
obj
- the dimension element to traverseprotected void visitOdaHierarchy(OdaHierarchyHandle obj)
obj
- the hierarchy element to traverseprotected void visitOdaLevel(OdaLevelHandle obj)
obj
- the level element to traverseprotected void visitOdaMeasure(OdaMeasureHandle obj)
obj
- the measure element to traverseprotected void visitOdaMeasureGroup(OdaMeasureGroupHandle obj)
obj
- the measure element to traverseprotected void visitCube(CubeHandle obj)
obj
- the cube element to traverseprotected void visitDimension(DimensionHandle obj)
obj
- the dimension element to traverseprotected void visitHierarchy(HierarchyHandle obj)
obj
- the hierarchy element to traverseprotected void visitLevel(LevelHandle obj)
obj
- the level element to traverseprotected void visitMeasure(MeasureHandle obj)
obj
- the measure element to traverseprotected void visitMeasureGroup(MeasureGroupHandle obj)
obj
- the measure element to traverse
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |