# Package net.sf.jasperreports.engine

Provides access to the library's main functionality through facade classes for compiling, filling and exporting reports and also publishes the library's main interfaces and classes.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  DatasetFilter | A dataset row filter.
  Deduplicable | Interface implemented by objects that can be deduplicated by detecting previously created identical instances.
  ElementsVisitor | Report elements visitor extended interface that is able to visit deep/nested elements.
  ImageMapRenderable | Image renderer able to produce image maps.
  JasperReportsContext |
  JRAlignment | An interface that defines constants useful for alignment.
  JRAnchor | An interface providing anchor functionality.
  JRBand | Implementations of this interface represent various bands in the report template.
  JRBox | Deprecated Replaced by `JRLineBox`.
  JRBoxContainer |
  JRBoxPenProvider |
  JRBreak | An abstract representation of a break element.
  JRChart | Implementations of this interface can be used for rendering chart components.
  JRChartCustomizer | This interface allows users to provide pluggable chart customizers.
  JRChartDataset | Datasets are used to represent the actual data needed to generate a chart.
  JRChartPlot | Chart plots define chart appearance and display details such as colors, legend or labels.
  JRChartPlot.JRSeriesColor |
  JRChild | An abstract representation of a report element.
  JRCloneable |
  JRCommonElement | An abstract representation of a report element.
  JRCommonGraphicElement | An abstract representation of a report graphic element.
  JRCommonImage | An abstract representation that provides basic functionality for images.
  JRCommonRectangle | An abstract representation of a graphic element representing a rectangle.
  JRCommonText | Common interface of design and print text elements.
  JRComponentElement | A report element that wraps an abstract component.
  JRConditionalStyle |
  JRConstants |
  JRDataset | Interface representing a data set that can be used in a report.
  JRDatasetParameter | Dataset parameter value interface.
  JRDatasetRun | Interface of an sub dataset instantiation.
  JRDataSource | This interface represents the abstract representation of a JasperReports data source.
  JRDataSourceProvider | Abstracts the means of creating and disposing a data source.
  JRDefaultStyleProvider | An interface that provides a default style when none is specified.
  JRElement | An abstract representation of a report element.
  JRElementDataset | Element datasets are used to represent the report data needed to generate a chart or crosstab.
  JRElementGroup | Groups several report elements.
  JREllipse | An abstract representation of a graphic element representing an ellipse.
  JREvaluation | Provides support for expressions evaluation.
  JRExporter<I extends ExporterInput,IC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput> | Deprecated Replaced by `Exporter`.
  JRExpression | Provides the JasperReports expressions functionality.
  JRExpressionChunk |
  JRField | An abstract representation of a data source field.
  JRFont | An abstract representation of a font.
  JRFrame | An abstract representation of a report elements container.
  JRGenericElement | A "generic" report element that will produce a `generic print element` in the generated report.
  JRGenericElementParameter | A generic report element parameter.
  JRGenericPrintElement | A generic print element.
  JRGraphicElement | An abstract representation of a report graphic element.
  JRGroup | Groups represent a flexible way to organize data on a report.
  JRHyperlink | An interface providing hyperlink functionality.
  JRHyperlinkParameter | A hyperlink parameter, consisting of a name and a value expression.
  JRIdentifiable |
  JRImage | An abstract representation of a graphic element representing an image.
  JRImageMapRenderer | Deprecated Replaced by `ImageMapRenderable`.
  JRLine | An abstract representation of a graphic element representing a straight line.
  JRLineBox | This is useful for drawing borders around text elements and images.
  JRParagraph |
  JRParagraphContainer |
  JRParameter | Provides functionality for report parameters.
  JRPen | This interface is used to customize line settings such as width, style and color.
  JRPenContainer |
  JRPrintAnchor |
  JRPrintElement |
  JRPrintElementContainer | Print element container interface.
  JRPrintEllipse |
  JRPrintFrame | A print elements container.
  JRPrintGraphicElement |
  JRPrintHyperlink |
  JRPrintImage |
  JRPrintLine |
  JRPrintPage |
  JRPrintRectangle |
  JRPrintText |
  JRPropertiesHolder | Interface to be implemented by objects that have properties attached.
  JRPropertyExpression | Report property with a value based on an expression.
  JRQuery | Represents a query used for generation of report data.
  JRQueryChunk |
  JRRectangle | An abstract representation of a graphic element representing a rectangle.
  JRRenderable | Deprecated Replaced by `Renderable`.
  JRReport | An abstract representation of a Jasper report.
  JRReportTemplate | A template included in a report.
  JRRewindableDataSource | This interface represents a data source which can go back to the first element.
  JRScriptlet |
  JRSection | Implementations of this interface represent various sections in the report template.
  JRSortField | Provides support for in-memory field-based data source sorting.
  JRStaticText | An abstract representation of a report static text.
  JRStyle | Provides a collection of style settings declared at the report level.
  JRStyleContainer |
  JRStyleSetter | An interface implemented by objects upon which style attributes can be set.
  JRSubreport | An abstract representation of a subreport.
  JRSubreportParameter |
  JRSubreportReturnValue | A value copied from a subreport into a variable of the master report.
  JRTemplate | A template that can be used by report.
  JRTextElement | An abstract representation of a report text element.
  JRTextField | An abstract representation of a report text.
  JRValueParameter | A report/dataset parameter having an assigned value.
  JRVariable | An interface for implementing classes that deal with report variables.
  JRVirtualizable<T> |
  JRVirtualizer |
  JRVisitable |
  JRVisitor |
  ParameterContributor |
  ParameterContributorFactory |
  PrintBookmark |
  PrintElementVisitor<T> | Print element visitor interface.
  Renderable |
  ReportContext |
  ReturnValue | A value copied from a subdataset into a variable of the parent report.

- Class Summary
  Class | Description
  --- | ---
  BookmarkHelper |
  CompositeDatasetFilter | A dataset filter that wraps several other filters and applies them as a conjunction.
  DefaultJasperReportsContext |
  ElementDecorator |
  JasperCompileManager | Facade class for compiling report designs into the ready-to-fill form and for getting the XML representation of report design objects for storage or network transfer.
  JasperExportManager | Facade class for exporting generated reports into more popular formats such as PDF, HTML and XML.
  JasperFillManager | Facade class for filling compiled report designs with data from report data sources, in order to produce page-oriented documents, ready-to-print.
  JasperPrint | An instance of this class represents a page-oriented document that can be viewed, printed or exported to other formats.
  JasperPrintManager | Facade class for the printing functionality exposed by the JasperReports library.
  JasperReport | Instances of this class represent compiled report template objects.
  JasperRunManager | Facade class for the JasperReports engine.
  JRAbstractChartCustomizer | Abstract implementation of `JRChartCustomizer` that provides access to parameter, variable and field values.
  JRAbstractExporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext> |
  JRAbstractObjectFactory |
  JRAbstractRenderer |
  JRAbstractScriptlet | Defines an abstract representation of a report scriptlet.
  JRAbstractSvgRenderer |
  JRDefaultScriptlet | This class provides default empty implementations for scriptlet events.
  JREmptyDataSource | A simple data source implementation that simulates a data source with a given number of virtual records inside.
  JRExporterParameter | Deprecated Replaced by `ExporterInput`, `ExporterConfiguration` and `ExporterOutput`.
  JRExpressionCollector | An expression collector traverses a report and collects report expressions out of it.
  JRExpressionCollector.GeneratedIds |
  JRGenericElementType | A key identifying a generic element type.
  JRHyperlinkHelper | Utility class that manages built-in hyperlink types.
  JRImageRenderer | Provides functionality for image rendering.
  JROrigin |
  JRPrintAnchorIndex |
  JRPrintElementIndex |
  JRPrintHyperlinkParameter | A parameter of the hyperlink associated to a print element.
  JRPrintHyperlinkParameters | A set of parameters associated with a print element.
  JRPrintImageArea | An area on an image.
  JRPrintImageAreaHyperlink | A component of an image map.
  JRPropertiesMap | Properties map of an JR element.
  JRPropertiesUtil | Class that provides static methods for loading, getting and setting properties.
  JRPropertiesUtil.PropertySuffix | Class used by `JRPropertiesUtil.getProperties(String)`.
  JRResultSetDataSource | This is a default implementation of the `JRDataSource` interface.
  JRSimpleTemplate | Default `JRTemplate` implementation.
  JRStyledTextAttributeSelector | Selector of element-level styled text attributes for print text objects.
  JRTemplateReference | A static template reference, consisting of a location from which the template can be loaded.
  JRVirtualizationHelper | Virtualization helper class.
  JRWrappingSvgRenderer |
  ParameterContributorContext |
  PrintElementId | An Id for a print element.
  RenderableUtil |
  SimpleJasperReportsContext |
  SimpleReportContext |
  TabStop |

- Enum Summary
  Enum | Description
  --- | ---
  EvaluationType | Determines the field and variables values to be used when evaluating an expression.

- Exception Summary
  Exception | Description
  --- | ---
  JRException | General purpose JasperReports exception.
  JRRuntimeException |
  JRScriptletException |

## Package net.sf.jasperreports.engine Description

Provides access to the library's main functionality through facade classes for compiling, filling and exporting reports and also publishes the library's main interfaces and classes.

### Related Documentation

JasperReports Tutorial

© 2001-2010 Jaspersoft Corporation www.jaspersoft.com