Deprecated API


Contents
Deprecated Classes
org.eclipse.birt.report.model.api.validators.DataSetResultSetValidator
          since birt 2.2 
org.eclipse.birt.report.model.api.MultiLineDataHandle
          by TextDataHandle 
org.eclipse.birt.report.model.api.command.NameSpaceEvent
          Since BIRT 2.1, there will no such event send by BIRT 
 

Deprecated Fields
org.eclipse.birt.report.model.api.elements.structures.ComputedColumn.AGGREGRATEON_MEMBER
            
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.COLUMN_DATA_TYPE_ANY
          this choice is removed since 2.3 
org.eclipse.birt.report.model.api.elements.structures.ComputedColumn.COLUMN_NAME_MEMBER
          using ComputedColumn.NAME_MEMBER instead. 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.DATE_TIME_LEVEL_TYPE_DAY
          This is replaced by DATE_TIME_LEVEL_TYPE_DAY_OF_YEAR, DATE_TIME_LEVEL_TYPE_DAY_OF_MONTH and DATE_TIME_LEVEL_TYPE_DAY_OF_WEEK, and not used anymore. 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.DATE_TIME_LEVEL_TYPE_WEEK
          This is replaced by DATE_TIME_LEVEL_TYPE_WEEK_OF_YEAR and DATE_TIME_LEVEL_TYPE_WEEK_OF_MONTH, and not used anymore. 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_CANT_EXTEND
          pushed down to sub class ExtendsForbiddenException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_CIRCULAR
          pushed down to sub class CircularExtendsException 
org.eclipse.birt.report.model.api.command.NameException.DESIGN_EXCEPTION_DOT_FORBIDDEN
          replaced by NameException.DESIGN_EXCEPTION_INVALID_NAME 
org.eclipse.birt.report.model.api.metadata.PropertyValueException.DESIGN_EXCEPTION_DOT_FORBIDDEN
            
org.eclipse.birt.report.model.api.command.ContentException.DESIGN_EXCEPTION_DROP_FORBIDDEN
          since birt 2.2 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_EXTENDS_FORBIDDEN
          pushed down to sub class ExtendsForbiddenException 
org.eclipse.birt.report.model.api.elements.SemanticError.DESIGN_EXCEPTION_IMAGE_FILE_NOT_EXIST
            
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_NO_PARENT
          pushed down to sub class InvalidParentException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_PARENT_NOT_FOUND
          pushed down to sub class InvalidParentException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_PARENT_NOT_IN_COMPONENT
          pushed down to sub class ExtendsForbiddenException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_PARENT_NOT_INCLUDE
          pushed down to sub class InvalidParentException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_SELF_EXTEND
          pushed down to sub class CircularExtendsException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_UNNAMED_PARENT
          pushed down to sub class InvalidParentException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_WRONG_EXTENSION_TYPE
          pushed down to sub class WrongTypeException 
org.eclipse.birt.report.model.api.command.ExtendsException.DESIGN_EXCEPTION_WRONG_TYPE
          pushed down to sub class WrongTypeException 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FILTER_OPERATOR_ANY
          in BIRT 2.1. This operator is not supported. 
org.eclipse.birt.report.model.api.elements.structures.DataSetParameter.IS_NULLABLE_MEMBER
            
org.eclipse.birt.report.model.api.elements.ReportDesignConstants.MULTI_LINE_DATA_ITEM
          by ReportDesignConstants.TEXT_DATA_ITEM 
org.eclipse.birt.report.model.api.activity.NotificationEvent.NAME_SPACE_EVENT
          since BIRT 2.1 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.PARAM_TYPE_ANY
          Now any is not supported. 
org.eclipse.birt.report.model.api.command.LibraryEvent.RELOAD
          by LibraryLoadedEvent 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.VERTICAL_ALIGN_BASELINE
          Now Engine is not support it. 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.VERTICAL_ALIGN_SUB
          Now Engine is not support it. 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.VERTICAL_ALIGN_SUPER
          Now Engine is not support it. 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.VERTICAL_ALIGN_TEXT_BOTTOM
          Now Engine is not support it. 
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.VERTICAL_ALIGN_TEXT_TOP
          Now Engine is not support it. 
 

Deprecated Methods
org.eclipse.birt.report.model.api.SlotHandle.add(DesignElement)
          by the method SlotHandle.add(DesignElementHandle) 
org.eclipse.birt.report.model.api.SlotHandle.add(DesignElement, int)
          by the method SlotHandle.add(DesignElementHandle, int) 
org.eclipse.birt.report.model.api.GroupHandle.addColumnBinding(ComputedColumn, boolean)
          since BIRT 2.1 RC2 
org.eclipse.birt.report.model.api.ScalarParameterHandle.allowBlank()
          by ScalarParameterHandle.isRequired() 
org.eclipse.birt.report.model.api.ScalarParameterHandle.allowNull()
          by ScalarParameterHandle.isRequired() 
org.eclipse.birt.report.model.api.GroupHandle.columnBindingsIterator()
          since BIRT 2.1 RC2 
org.eclipse.birt.report.model.api.StructureFactory.createEmbeddedImage(EmbeddedImageHandle)
          by StructureFactory.newEmbeddedImageFrom(EmbeddedImageHandle, String, ModuleHandle) 
org.eclipse.birt.report.model.api.ModuleHandle.dropConfigVariable(String)
            
org.eclipse.birt.report.model.api.ModuleHandle.dropImage(String)
            
org.eclipse.birt.report.model.api.metadata.IMetaDataDictionary.enableElementID()
            
org.eclipse.birt.report.model.api.ComputedColumnHandle.getAggregrateOn()
          by ComputedColumnHandle.getAggregateOn() 
org.eclipse.birt.report.model.api.elements.structures.ComputedColumn.getAggregrateOn()
          by ComputedColumn.getAggregateOn() 
org.eclipse.birt.report.model.api.ColumnHandle.getAlignment()
          by the StyleHandle.getTextAlign() 
org.eclipse.birt.report.model.api.ActionHandle.getBookmarkLink()
          use ActionHandle.getTargetBookmark()instead. 
org.eclipse.birt.report.model.api.DataSetHandle.getCachedRowCount()
          by getDataSetRowLimit method 
org.eclipse.birt.report.model.api.FilterConditionHandle.getColumn()
          This property has been removed. 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.getColumn()
          This property has been removed. 
org.eclipse.birt.report.model.api.GroupHandle.getColumnBindings()
          since BIRT 2.1 RC2 
org.eclipse.birt.report.model.api.ComputedColumnHandle.getColumnName()
          using ComputedColumnHandle.getName() instead. 
org.eclipse.birt.report.model.api.SortKeyHandle.getColumnName()
          This property has been removed. See the method SortKeyHandle.getKey(). 
org.eclipse.birt.report.model.api.elements.structures.SortKey.getColumnName()
          This property has been removed. See the method SortKey.getKey(). 
org.eclipse.birt.report.model.api.elements.structures.ComputedColumn.getColumnName()
          using ComputedColumn.getName() instead. 
org.eclipse.birt.report.model.api.TextDataHandle.getContentTypeExpr()
          by the method TextDataHandle.getContentType() 
org.eclipse.birt.report.model.api.DataSetHandle.getDataSetRowLimit()
          duplicate with method getRowFetchLimit() 
org.eclipse.birt.report.model.api.ElementDetailHandle.getDesign()
            
org.eclipse.birt.report.model.api.DesignElementHandle.getDesign()
          replaced by getModule() 
org.eclipse.birt.report.model.api.DesignElementHandle.getDesignHandle()
          replaced by getModuleHandle() 
org.eclipse.birt.report.model.api.DataItemHandle.getDistinct()
          by the drop function of Cell element. 
org.eclipse.birt.report.model.api.DataItemHandle.getDistinctReset()
          by the drop function of Cell element. 
org.eclipse.birt.report.model.api.ActionHandle.getDrillThroughReportName()
          use ActionHandle.getReportName()instead. 
org.eclipse.birt.report.model.api.OdaDataSourceHandle.getDriverName()
          This property is removed. 
org.eclipse.birt.report.model.api.MasterPageHandle.getEffectiveHeight()
            
org.eclipse.birt.report.model.api.MasterPageHandle.getEffectiveWidth()
            
org.eclipse.birt.report.model.api.OdaDataSourceHandle.getExtensionName()
          use getExtensioID() 
org.eclipse.birt.report.model.api.OdaDataSetHandle.getExtensionName()
          use getExtensionID() 
org.eclipse.birt.report.model.api.FilterConditionHandle.getFilterExpr()
          Replaced by the method FilterConditionHandle.getExpr() 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.getFilterExpr()
          Replaced by the method FilterCondition.getExpr() 
org.eclipse.birt.report.model.api.ScalarParameterHandle.getFormat()
          replaced by getPattern and getCategory. 
org.eclipse.birt.report.model.api.GroupHandle.getGroupStart()
          by GroupHandle.getIntervalBase() 
org.eclipse.birt.report.model.api.StyleHandle.getHighlightTestExpr()
            
org.eclipse.birt.report.model.api.ActionHandle.getHyperlink()
          use ActionHandle.getURI()instead. 
org.eclipse.birt.report.model.api.ScalarParameterHandle.getLabelColumn()
          Replaced by the method ScalarParameterHandle.getLabelExpr() 
org.eclipse.birt.report.model.api.ModuleHandle.getLineNoByID(long)
          new method see ModuleHandle.getLineNo(Object) 
org.eclipse.birt.report.model.api.DesignElementHandle.getListProperty(Module, String)
            
org.eclipse.birt.report.model.api.SessionHandle.getLocale()
          to use ICU4J, replaced by: public ULocale getLocale() 
org.eclipse.birt.report.model.api.core.IStructure.getLocalProperty(Module, PropertyDefn)
          by IStructure.getProperty(Module, String) 
org.eclipse.birt.report.model.api.StyleHandle.getMapTestExpr()
            
org.eclipse.birt.report.model.api.extension.IMessages.getMessage(String, Locale)
          to support ICU4J, replaced by : getMessage(String key, ULocale lcoale) 
org.eclipse.birt.report.model.api.DesignEngine.getMetaDataDictionary()
            
org.eclipse.birt.report.model.api.ExtendedItemHandle.getMethods()
          by ExtendedItemHandle.getMethods(String) 
org.eclipse.birt.report.model.api.extension.IReportItem.getMethods()
          by IReportItem.getMethods(String) 
org.eclipse.birt.report.model.api.OdaDataSetHandle.getPrivateDriverDesignState()
            
org.eclipse.birt.report.model.api.OdaDataSetHandle.getQueryScript()
          to be removed. 
org.eclipse.birt.report.model.api.extension.IResourceBundleProvider.getResourceBundle(Locale)
          to support ICU4J, replaced by : getResourceBundle(ULocale locale) 
org.eclipse.birt.report.model.api.LibraryHandle.getStyles()
          uses the theme instead 
org.eclipse.birt.report.model.api.ReportItemHandle.getTocExpression()
            
org.eclipse.birt.report.model.api.GroupHandle.getTocExpression()
            
org.eclipse.birt.report.model.api.ScalarParameterHandle.getType()
          Replaced by the method ScalarParameterHandle.getDataType() 
org.eclipse.birt.report.model.api.OdaDataSetHandle.getType()
          type has been replaced by extension ID 
org.eclipse.birt.report.model.api.FilterConditionHandle.getValue1Expr()
          Replaced by the method FilterConditionHandle.getValue1() 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.getValue1Expr()
          Replaced by the method FilterCondition.getValue1() 
org.eclipse.birt.report.model.api.FilterConditionHandle.getValue2Expr()
          Replaced by the method FilterConditionHandle.getValue2() 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.getValue2Expr()
          Replaced by the method FilterCondition.getValue2() 
org.eclipse.birt.report.model.api.ScalarParameterHandle.getValueColumn()
          Replaced by the method ScalarParameterHandle.getValueExpr() 
org.eclipse.birt.report.model.api.DataItemHandle.getValueExpr()
          As of BIRT version 2.1.0, replaced by getResultSetColumn( ) 
org.eclipse.birt.report.model.api.DataSetParameterHandle.isNullable()
          Use allowNull() 
org.eclipse.birt.report.model.api.elements.structures.DataSetParameter.isNullable()
          Use allowNull() 
org.eclipse.birt.report.model.api.metadata.IElementPropertyDefn.isReadOnly()
          by the method IElementDefn.isPropertyReadOnly(String) 
org.eclipse.birt.report.model.api.ReportElementHandle.isValidReferenceForCompoundElement()
            
org.eclipse.birt.report.model.api.metadata.IElementPropertyDefn.isVisible()
          by the method IElementDefn.isPropertyVisible(String) 
org.eclipse.birt.report.model.api.ElementFactory.newOdaDataSet(String)
          see newOdaDataSet( String name, String extensionID ) 
org.eclipse.birt.report.model.api.ElementFactory.newOdaDataSource(String)
          see newOdaDataSource( String name, String extensionID ) 
org.eclipse.birt.report.model.api.ElementFactory.newOdaLevel(String)
          replaced by ElementFactory.newOdaLevel(org.eclipse.birt.report.model.api.olap.DimensionHandle, String) 
org.eclipse.birt.report.model.api.DesignEngine.newSession(ULocale)
            
org.eclipse.birt.report.model.api.ElementFactory.newTabularLevel(String)
          replaced by ElementFactory.newTabularLevel(org.eclipse.birt.report.model.api.olap.DimensionHandle, String) 
org.eclipse.birt.report.model.api.metadata.DimensionValue.parse(String)
          replaced by StringUtil.parse(String) 
org.eclipse.birt.report.model.api.metadata.DimensionValue.parseInput(String)
          replaced by StringUtil.parseInput(String, com.ibm.icu.util.ULocale) 
org.eclipse.birt.report.model.api.ScriptDataSetHandle.resultSetIterator()
          by {#resultSetHintsIterator()} 
org.eclipse.birt.report.model.api.ComputedColumnHandle.setAggregrateOn(String)
          by ComputedColumnHandle.setAggregateOn(String) 
org.eclipse.birt.report.model.api.elements.structures.ComputedColumn.setAggregrateOn(String)
          by ComputedColumn.setAggregateOn(String) 
org.eclipse.birt.report.model.api.ColumnHandle.setAlignment(String)
          by the StyleHandle.setTextAlign(String) 
org.eclipse.birt.report.model.api.ScalarParameterHandle.setAllowBlank(boolean)
          by ScalarParameterHandle.setIsRequired(boolean) 
org.eclipse.birt.report.model.api.ScalarParameterHandle.setAllowNull(boolean)
          by ScalarParameterHandle.setIsRequired(boolean) 
org.eclipse.birt.report.model.api.ActionHandle.setBookmarkLink(String)
          use ActionHandle.setTargetBookmark(String)instead. 
org.eclipse.birt.report.model.api.DataSetHandle.setCachedRowCount(int)
          by setDataSetRowLimit method 
org.eclipse.birt.report.model.api.FilterConditionHandle.setColumn(String)
          This property has been removed. 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.setColumn(String)
          This property has been removed. 
org.eclipse.birt.report.model.api.ComputedColumnHandle.setColumnName(String)
          using ComputedColumnHandle.setName(String) instead. 
org.eclipse.birt.report.model.api.SortKeyHandle.setColumnName(String)
          This property has been removed. See the method SortKeyHandle.setKey(String). 
org.eclipse.birt.report.model.api.elements.structures.SortKey.setColumnName(String)
          This property has been removed. See the method SortKey.setKey(String). 
org.eclipse.birt.report.model.api.elements.structures.ComputedColumn.setColumnName(String)
          using ComputedColumn.setName(String) instead. 
org.eclipse.birt.report.model.api.TextDataHandle.setContentTypeExpr(String)
          by the method TextDataHandle.setContentType(String) 
org.eclipse.birt.report.model.api.DataSetHandle.setDataSetRowLimit(int)
          duplicate with method setRowFetchLimit() 
org.eclipse.birt.report.model.api.DataItemHandle.setDistinct(String)
          by the drop function of Cell element. 
org.eclipse.birt.report.model.api.DataItemHandle.setDistinctReset(String)
          by the drop function of Cell element. 
org.eclipse.birt.report.model.api.ActionHandle.setDrillThroughBookmarkLink(String)
          use ActionHandle.setTargetBookmark(String)instead. 
org.eclipse.birt.report.model.api.ActionHandle.setDrillThroughReportName(String)
          use ActionHandle.setReportName(String)instead. 
org.eclipse.birt.report.model.api.ActionHandle.setDrillThroughTargetBookmark(String)
          use ActionHandle.setTargetBookmark(String)instead. 
org.eclipse.birt.report.model.api.OdaDataSourceHandle.setDriverName(String)
          This property is removed. 
org.eclipse.birt.report.model.api.DesignElementHandle.setExtendsElement(DesignElement)
          by DesignElementHandle.setExtends(DesignElementHandle) 
org.eclipse.birt.report.model.api.FilterConditionHandle.setFilterExpr(String)
          Replaced by the method FilterConditionHandle.setExpr(String) 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.setFilterExpr(String)
          Replaced by the method FilterCondition.setExpr(String) 
org.eclipse.birt.report.model.api.ScalarParameterHandle.setFormat(String)
          replaced by setPattern and setCategory. 
org.eclipse.birt.report.model.api.GroupHandle.setGroupStart(String)
          by GroupHandle.setIntervalBase(String) 
org.eclipse.birt.report.model.api.StyleHandle.setHighlightTestExpr(String)
            
org.eclipse.birt.report.model.api.ActionHandle.setHyperlink(String)
          ActionHandle.setURI(String) 
org.eclipse.birt.report.model.api.DataSetParameterHandle.setIsNullable(boolean)
          Use setAllowNull(boolean) 
org.eclipse.birt.report.model.api.elements.structures.DataSetParameter.setIsNullable(boolean)
          Use setAllowNull(boolean) 
org.eclipse.birt.report.model.api.ScalarParameterHandle.setLabelColumn(String)
          Replaced by the method ScalarParameterHandle.setLabelExpr(String) 
org.eclipse.birt.report.model.api.StyleHandle.setMapTestExpr(String)
            
org.eclipse.birt.report.model.api.OdaDataSetHandle.setPrivateDriverDesignState(String)
            
org.eclipse.birt.report.model.api.OdaDataSetHandle.setQueryScript(String)
          to be removed. 
org.eclipse.birt.report.model.api.DesignElementHandle.setStyleElement(StyleElement)
          by DesignElementHandle.setStyle(SharedStyleHandle) 
org.eclipse.birt.report.model.api.ReportItemHandle.setTocExpression(String)
            
org.eclipse.birt.report.model.api.GroupHandle.setTocExpression(String)
            
org.eclipse.birt.report.model.api.ScalarParameterHandle.setType(String)
          Replaced by the method ScalarParameterHandle.setDataType(String) 
org.eclipse.birt.report.model.api.OdaDataSetHandle.setType(String)
          type has been replaced by extension ID 
org.eclipse.birt.report.model.api.ImageHandle.setURI(String)
          should use ImageHandle.setFile(String) or ImageHandle.setURL(String). 
org.eclipse.birt.report.model.api.simpleapi.IImage.setURI(String)
          Sets the image uri property. The source type is automatically set in this method. Whether IMAGE_REF_TYPE_FILE or IMAGE_REF_TYPE_URL depends on the uri to set. 
org.eclipse.birt.report.model.api.FilterConditionHandle.setValue1Expr(String)
          Replaced by the method FilterConditionHandle.setValue1(String) 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.setValue1Expr(String)
          Replaced by the method FilterCondition.setValue1(String) 
org.eclipse.birt.report.model.api.FilterConditionHandle.setValue2Expr(String)
          Replaced by the method FilterConditionHandle.setValue2(String) 
org.eclipse.birt.report.model.api.elements.structures.FilterCondition.setValue2Expr(String)
          Replaced by the method FilterCondition.setValue2(String) 
org.eclipse.birt.report.model.api.ScalarParameterHandle.setValueColumn(String)
          Replaced by the method ScalarParameterHandle.setValueExpr(String) 
org.eclipse.birt.report.model.api.DataItemHandle.setValueExpr(String)
          As of BIRT version 2.1.0, replaced by setResultSetColumn(String columnName) 
org.eclipse.birt.report.model.api.validators.TableHeaderContextContainmentValidator.validateForAdding(Module, DesignElement, int, DesignElement)
          since birt2.2, replaced by TableHeaderContextContainmentValidator.validateForAdding(Module, ContainerContext, DesignElement) 
org.eclipse.birt.report.model.api.validators.MasterPageContextContainmentValidator.validateForAdding(Module, DesignElement, int, DesignElement)
          since birt2.2, replaced by MasterPageContextContainmentValidator.validateForAdding(Module, ContainerContext, DesignElement) 
 

Deprecated Constructors
org.eclipse.birt.report.model.api.command.ContentReplaceEvent(DesignElement, DesignElement, DesignElement, int)
          since birt 2.2 replaced by ContentReplaceEvent.ContentReplaceEvent(ContainerContext, DesignElement, DesignElement) 
org.eclipse.birt.report.model.api.SessionHandle(Locale)
          to use ICU4J, this method is replaced by: SessionHandle(ULocale locale) 
 



Copyright © 2008 Actuate Corp. All rights reserved.