Deprecated API

Contents

• Interfaces
• Classes
• Fields
• Methods
• Constructors

Interfaces

Interface	Description
org.pentaho.reporting.engine.classic.core.layout.BandLayoutManager	This class is no longer used.

Classes

Class	Description
org.pentaho.reporting.engine.classic.core.filter.AnchorFilter	The anchor filter is deprecated now. Use the stylekey "anchor" instead.
org.pentaho.reporting.engine.classic.core.filter.templates.AnchorFieldTemplate	the Anchor-Field has been deprecated. Use the style-key "anchor" instead.
org.pentaho.reporting.engine.classic.core.function.AbstractCompareExpression	This can be better handled in a formula.
org.pentaho.reporting.engine.classic.core.function.AverageExpression	this has been replaced by the ColumnAverageExpression.
org.pentaho.reporting.engine.classic.core.function.bool.AndExpression	use formulas instead
org.pentaho.reporting.engine.classic.core.function.bool.IsEmptyDataExpression	Use a formula instead or make proper use of the No-Data band.
org.pentaho.reporting.engine.classic.core.function.bool.OrExpression	use Formulas instead
org.pentaho.reporting.engine.classic.core.function.ColumnAverageExpression	the same can be achived with a formula "AVG([column1], [column2], [column3])"
org.pentaho.reporting.engine.classic.core.function.ColumnDifferenceExpression	This can be done easier with a formula.
org.pentaho.reporting.engine.classic.core.function.ColumnDivisionExpression	Use a formula
org.pentaho.reporting.engine.classic.core.function.ColumnMaximumExpression	Use a formula
org.pentaho.reporting.engine.classic.core.function.ColumnMinimumExpression	Use a formula
org.pentaho.reporting.engine.classic.core.function.ColumnMultiplyExpression	Use a formula
org.pentaho.reporting.engine.classic.core.function.ColumnSumExpression	Use a formula
org.pentaho.reporting.engine.classic.core.function.CompareFieldsExpression	Use a formula instead.
org.pentaho.reporting.engine.classic.core.function.ConditionalItemSumFunction	Filter the values by using a plain formula.
org.pentaho.reporting.engine.classic.core.function.ConvertToDateExpression	use a formula function (ParseDate) instead.
org.pentaho.reporting.engine.classic.core.function.CreateGroupAnchorsFunction	It is easier to create anchors using a Style-expression. The Anchor-Field has been deprecated now.
org.pentaho.reporting.engine.classic.core.function.CreateHyperLinksFunction	add style expressions to the 'href-target' and 'href-window' instead. It is much easier and less confusing.
org.pentaho.reporting.engine.classic.core.function.date.CompareDateExpression	This can be solved easier using the Inline-Expression language.
org.pentaho.reporting.engine.classic.core.function.date.DateSpanExpression	This can be solved using a plain formula.
org.pentaho.reporting.engine.classic.core.function.DateCutExpression	The VariableDateExpression is much better suited for this purpose.
org.pentaho.reporting.engine.classic.core.function.ElementColorFunction	add a style expression for the 'paint' style instead
org.pentaho.reporting.engine.classic.core.function.ElementTrafficLightFunction	This function can be safely replaced by a formula.
org.pentaho.reporting.engine.classic.core.function.ElementVisibilityFunction	add a style-expression for the visible style-key instead.
org.pentaho.reporting.engine.classic.core.function.ElementVisibilitySwitchFunction	Use the RowBandingFunction to modify the band's background color directly.
org.pentaho.reporting.engine.classic.core.function.HideElementByNameFunction	Use a formula
org.pentaho.reporting.engine.classic.core.function.HideElementIfDataAvailableExpression	Use a Style-Expression or make proper use of the No-Data-Band
org.pentaho.reporting.engine.classic.core.function.HideNullValuesFunction	This should be done using Style-Expressions.
org.pentaho.reporting.engine.classic.core.function.HidePageBandForTableExportFunction	Use style expressions instead.
org.pentaho.reporting.engine.classic.core.function.IsEmptyExpression	Use a Formula Instead
org.pentaho.reporting.engine.classic.core.function.IsNullExpression	Use a Formula Instead
org.pentaho.reporting.engine.classic.core.function.ItemColumnQuotientExpression	Use PercentageExpression instead, it's name is much clearer
org.pentaho.reporting.engine.classic.core.function.NegativeNumberPaintChangeFunction	The same thing can be achieved using a simple StyleExpression on the element's PAINT stylekey.
org.pentaho.reporting.engine.classic.core.function.numeric.CompareNumberExpression	like all compare functions, using the formula support is easier.
org.pentaho.reporting.engine.classic.core.function.numeric.IsNegativeExpression	This can be replaced by a formula.
org.pentaho.reporting.engine.classic.core.function.numeric.IsPositiveExpression	This can be replaced by a formula.
org.pentaho.reporting.engine.classic.core.function.PaintComponentFunction	Use the new Component-Element instead. It uses drawables for this job, and therefore the result looks much better. This method does no longer work, as it depended on implementation details that are no longer in use.
org.pentaho.reporting.engine.classic.core.function.PaintDynamicComponentFunction	Use the new Component-Element instead. It uses drawables for this job, and therefore the result looks much better.
org.pentaho.reporting.engine.classic.core.function.PercentageExpression	The same can be achieved using a simple ValueExpression.
org.pentaho.reporting.engine.classic.core.function.ShowElementByNameFunction	This can be done easier using style-expressions
org.pentaho.reporting.engine.classic.core.function.ShowElementIfDataAvailableExpression	Use a formula instead.
org.pentaho.reporting.engine.classic.core.function.strings.CapitalizeStringExpression	Use a formula instead.
org.pentaho.reporting.engine.classic.core.function.strings.CompareStringExpression	This can be done a lot easier using a simple formula.
org.pentaho.reporting.engine.classic.core.function.strings.SubStringExpression	Use a formula
org.pentaho.reporting.engine.classic.core.function.strings.TokenizeStringExpression	Use a formula: "prefix & SUBSTITUTE(field, delimeter, replacement) & suffix"
org.pentaho.reporting.engine.classic.core.function.strings.ToLowerCaseStringExpression	This can be solved with a formula
org.pentaho.reporting.engine.classic.core.function.strings.ToUpperCaseStringExpression	This can be solved with a formula
org.pentaho.reporting.engine.classic.core.function.strings.URLEncodeExpression	This can be replaced by a formula.
org.pentaho.reporting.engine.classic.core.function.sys.SheetNameFunction	This way of defining a sheetname for elements is deprecated. Sheetnames should be declared or computed directly on the bands by specifiing a sheetname using the "computed-sheetname" style-property.
org.pentaho.reporting.engine.classic.core.function.sys.SingleValueQueryFunction	use the formula expression with the same name instead.
org.pentaho.reporting.engine.classic.core.function.TextFormatExpression	Use the MessageFormatExpression instead.
org.pentaho.reporting.engine.classic.core.layout.StackedLayoutManager	This layout manager is no longer used.
org.pentaho.reporting.engine.classic.core.layout.StaticLayoutManager	This layout manager is no longer used.
org.pentaho.reporting.engine.classic.core.modules.misc.survey.parser.SurveyScaleElementReadHandler
org.pentaho.reporting.engine.classic.core.modules.misc.survey.writer.SurveyScaleWriteHandler
org.pentaho.reporting.engine.classic.core.modules.output.csv.CSVWriter	Will be removed in the future, as PDI is a better CSV generator.
org.pentaho.reporting.engine.classic.core.modules.output.xml.XMLModule	The whole basic XML output is deprecated as it cannot handle inline subreports.
org.pentaho.reporting.engine.classic.core.modules.output.xml.XMLProcessor	The whole basic XML output is deprecated as it cannot handle inline subreports.
org.pentaho.reporting.engine.classic.core.modules.output.xml.XMLWriter	The whole basic XML output is deprecated as it cannot handle inline subreports.
org.pentaho.reporting.engine.classic.core.modules.parser.base.GroupList	The group-list is a legacy class and should not be used outside the legacy handling.
org.pentaho.reporting.engine.classic.core.modules.parser.base.ReportGenerator	Use LibLoader directly.
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.ContentFieldReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.ContentReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.DateFieldReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.EllipseReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.ExternalElementReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.HorizontalLineReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.LabelReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.MessageReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.NumberFieldReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.RectangleReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.ResourceFieldReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.ResourceLabelReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.ResourceMessageReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.TextFieldReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.VerticalLineReadHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.BandElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.ContentElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.ContentFieldElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabCellBodyElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabCellElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabColumnGroupBodyElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabGroupElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabHeaderElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabOtherGroupBodyElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabRowGroupBodyElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabSummaryHeaderElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.CrosstabTitleHeaderElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.DateFieldElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.DetailsFooterElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.DetailsHeaderElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.EllipseElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.ExternalElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.HorizontalLineElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.LabelElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.MessageElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.NumberFieldElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.PageFooterElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.PageHeaderElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.RectangleElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.ResourceFieldElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.ResourceLabelElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.ResourceMessageElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.TextFieldElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.VerticalLineElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer.elements.WatermarkElementWriteHandler
org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.TemplatesWriter	No longer used.
org.pentaho.reporting.engine.classic.core.parameters.StaticListParameter	This class is not used anywhere and you can get the same functionality via a default-list-parameter and a table-datasource.
org.pentaho.reporting.engine.classic.core.style.FontDefinition	use single properties instead.
org.pentaho.reporting.engine.classic.core.wizard.DefaultDataSchemaModel	Use the DesignTimeDataSchemaModel instead.

Fields

Field	Description
org.pentaho.reporting.engine.classic.core.modules.output.table.xls.ExcelTableModule.CONFIGURATION_PREFIX	The configuration prefix should not be needed anymore. Always provide the full name.
org.pentaho.reporting.engine.classic.core.modules.output.table.xls.helper.HSSFFontWrapper.FONT_FACTOR	No longer used, will be removed in 6.0
org.pentaho.reporting.engine.classic.core.parameters.ParameterAttributeNames.Swing.RENDER_HINT	Not used and replaced by render-type expansion.

Methods

Method	Description
org.pentaho.reporting.engine.classic.core.AbstractReportDefinition.getResourceBundleFactory()
org.pentaho.reporting.engine.classic.core.AbstractReportDefinition.getResourceManager()
org.pentaho.reporting.engine.classic.core.AbstractReportDefinition.setResourceBundleFactory(ResourceBundleFactory)
org.pentaho.reporting.engine.classic.core.designtime.DesignTimeDataSchemaModel.computeParameterValueSet(MasterReport)
org.pentaho.reporting.engine.classic.core.designtime.DesignTimeDataSchemaModel.isSelectedDataSource(DataFactory, String)
org.pentaho.reporting.engine.classic.core.Element.getDataSource()	Whereever possible use ElementType implementations instead. This method only exists to let old reports run.
org.pentaho.reporting.engine.classic.core.Element.setDataSource(DataSource)	The data-source should not be used anymore. Use ElementType implementations instead. This method only exists to let old reports run.
org.pentaho.reporting.engine.classic.core.elementfactory.DateFieldElementFactory.createDateElement(String, Rectangle2D, Color, ElementAlignment, FontDefinition, String, String, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.elementfactory.ElementFactory.getLayoutCachable()	The layout cachable flag is no longer used.
org.pentaho.reporting.engine.classic.core.elementfactory.ElementFactory.setLayoutCachable(Boolean)	The layout cachable flag is no longer used.
org.pentaho.reporting.engine.classic.core.elementfactory.LabelElementFactory.createLabelElement(String, Rectangle2D, Color, ElementAlignment, FontDefinition, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.elementfactory.MessageFieldElementFactory.createMessageElement(String, Rectangle2D, Color, ElementAlignment, FontDefinition, String, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.elementfactory.NumberFieldElementFactory.createNumberElement(String, Rectangle2D, Color, ElementAlignment, FontDefinition, String, NumberFormat, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.elementfactory.ResourceFieldElementFactory.createResourceElement(String, Rectangle2D, Color, ElementAlignment, ElementAlignment, FontDefinition, String, String, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.elementfactory.ResourceLabelElementFactory.createResourceLabel(String, Rectangle2D, Color, ElementAlignment, ElementAlignment, FontDefinition, String, String, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.elementfactory.ResourceMessageElementFactory.createResourceMessage(String, Rectangle2D, Color, ElementAlignment, ElementAlignment, FontDefinition, String, String, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.elementfactory.TextFieldElementFactory.createStringElement(String, Rectangle2D, Color, ElementAlignment, FontDefinition, String, String)	Use a more fine-grained approach to define this element by using the element-factory directly.
org.pentaho.reporting.engine.classic.core.filter.DataRowDataSource.getField()	Required for legacy-parsing, do not use elsewhere.
org.pentaho.reporting.engine.classic.core.filter.DataRowDataSource.setField(String)	Required for legacy-parsing, do not use elsewhere.
org.pentaho.reporting.engine.classic.core.function.AbstractExpression.isActive()	The Active-Flag is no longer evaluated. We always assume it to be true.
org.pentaho.reporting.engine.classic.core.function.AbstractExpression.setActive(boolean)	All expressions are always active. This method has no effect anymore.
org.pentaho.reporting.engine.classic.core.function.ElementVisibilitySwitchFunction.getInitialTriggerValue()	use getInitialState instead.
org.pentaho.reporting.engine.classic.core.function.Expression.isActive()	The Active-Flag is no longer evaluated. We always assume it to be true.
org.pentaho.reporting.engine.classic.core.function.PageFunction.isIgnorePageCancelEvents()	No longer used.
org.pentaho.reporting.engine.classic.core.function.PageFunction.setIgnorePageCancelEvents(boolean)	No longer used.
org.pentaho.reporting.engine.classic.core.layout.build.DefaultRenderNodeFactory.createAutoParagraph(ReportStateKey)
org.pentaho.reporting.engine.classic.core.layout.build.RenderNodeFactory.createAutoParagraph(ReportStateKey)
org.pentaho.reporting.engine.classic.core.layout.model.RenderableReplacedContent.isImageResolutionMapping()
org.pentaho.reporting.engine.classic.core.layout.output.RenderUtility.extractImageMap(RenderableReplacedContentBox, DrawableWrapper)
org.pentaho.reporting.engine.classic.core.layout.process.util.BoxShifter.extendHeight(RenderBox, RenderNode, long)
org.pentaho.reporting.engine.classic.core.metadata.DefaultStyleKeyMetaData.getPropertyEditor()
org.pentaho.reporting.engine.classic.core.metadata.MetaData.isExperimental()
org.pentaho.reporting.engine.classic.core.metadata.parser.AbstractMetaDataReadHandler.isExperimental()
org.pentaho.reporting.engine.classic.core.metadata.parser.StyleReadHandler.getBundleName()
org.pentaho.reporting.engine.classic.core.metadata.parser.StyleReadHandler.isMandatory()
org.pentaho.reporting.engine.classic.core.modules.misc.datafactory.sql.ResultSetTableModelFactory.updateMetaData(ResultSetMetaData, DefaultTableMetaData, int)
org.pentaho.reporting.engine.classic.core.modules.misc.survey.SurveyScaleExpression.getRangePaint()
org.pentaho.reporting.engine.classic.core.modules.misc.survey.SurveyScaleExpression.setRangePaint(Paint)
org.pentaho.reporting.engine.classic.core.modules.misc.tablemodel.DefaultTableMetaData.addRow()
org.pentaho.reporting.engine.classic.core.modules.output.csv.CSVProcessor.isStrictErrorHandling(Configuration)	No longer needed.
org.pentaho.reporting.engine.classic.core.modules.output.pageable.plaintext.TextDocumentWriter.close()
org.pentaho.reporting.engine.classic.core.modules.output.pageable.plaintext.TextDocumentWriter.open()
org.pentaho.reporting.engine.classic.core.modules.output.table.base.TableCutList.getKeys()	Always provide a buffer for performance reasons.
org.pentaho.reporting.engine.classic.core.modules.output.table.html.helper.StyleManager.getGlobalStyleSheet()	This method is slower than writing to the stream directly. Do not use it.
org.pentaho.reporting.engine.classic.core.parameters.FormulaParameterEvaluator.evaluate(ValidationResult, ReportParameterDefinition, ParameterContext)	This method is unsafe. Do not use it or you may open up your application to all kinds of security risks. The method will be removed in the next release.
org.pentaho.reporting.engine.classic.core.parameters.ParameterUtils.initializeDefaultValues(MasterReport, ParameterContext)
org.pentaho.reporting.engine.classic.core.RelationalGroup.findGroupDataBody()
org.pentaho.reporting.engine.classic.core.states.datarow.DefaultFlowController.performQuery(DataFactory, String, int, int, ResourceBundleFactory)
org.pentaho.reporting.engine.classic.core.states.datarow.DefaultFlowController.performSubReportQuery(String, int, int, ParameterMapping[])
org.pentaho.reporting.engine.classic.core.states.DataRowConnector.getLastDatasource(DataTarget)	no longer used.
org.pentaho.reporting.engine.classic.core.SubReport.getResourceBundleFactory()
org.pentaho.reporting.engine.classic.core.SubReport.getResourceManager()
org.pentaho.reporting.engine.classic.core.util.LevelList.getElementsForLevel(int)	use the array methods for best performance.

Constructors

Constructor	Description
org.pentaho.reporting.engine.classic.core.elementfactory.CrosstabBuilder(DesignTimeDataSchemaModel)
org.pentaho.reporting.engine.classic.core.event.ReportProgressEvent(Object, int)	Use constructor with total pages instead
org.pentaho.reporting.engine.classic.core.metadata.DefaultDataFactoryMetaData(String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, DataFactoryCore, int)
org.pentaho.reporting.engine.classic.core.metadata.DefaultExpressionPropertyMetaData(String, String, boolean, boolean, boolean, boolean, boolean, boolean, String, SharedBeanInfo, String, ExpressionPropertyCore, MaturityLevel, int, boolean)
org.pentaho.reporting.engine.classic.core.metadata.DefaultReportPreProcessorMetaData(String, boolean, boolean, boolean, boolean, Class<? extends ReportPreProcessor>, HashMap<String, ReportPreProcessorPropertyMetaData>, SharedBeanInfo, boolean, boolean, MaturityLevel, int, int)
org.pentaho.reporting.engine.classic.core.metadata.DefaultReportProcessTaskMetaData(String, String, boolean, boolean, boolean, boolean, MaturityLevel, int, Class<? extends ReportProcessTask>, String, String[])
org.pentaho.reporting.engine.classic.core.modules.output.pageable.graphics.internal.LogicalPageDrawable(LogicalPageBox, OutputProcessorMetaData, ResourceManager)
org.pentaho.reporting.engine.classic.core.modules.output.table.base.TableRectangle(int, int, int, int)
org.pentaho.reporting.engine.classic.core.modules.parser.ext.factory.base.DecimalFormatObjectDescription(Class, boolean)	should no longer be used...
org.pentaho.reporting.engine.classic.core.states.QueryDataRowWrapper(DataRow, Integer, Integer)