Package net.sf.jasperreports.engine.base

Class JRBaseDataset

java.lang.Object
net.sf.jasperreports.engine.base.JRBaseDataset
All Implemented Interfaces:
Serializable, Cloneable, JRChangeEventsSupport, JRCloneable, JRDataset, JRIdentifiable, JRPropertiesHolder
Direct Known Subclasses:
JRDesignDataset
public class JRBaseDataset extends Object implements JRDataset, Serializable, JRChangeEventsSupport
The base implementation of JRDataset.
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

    • JRBaseDataset

      protected JRBaseDataset(boolean isMain)

    • JRBaseDataset

      protected JRBaseDataset(JRDataset dataset, JRBaseObjectFactory factory)

  • Method Details

    • getUUID

      public UUID getUUID()
      Specified by:
      getUUID in interface JRIdentifiable

    • getName

      public String getName()
      Description copied from interface: JRDataset
      Returns the dataset name.
      Specified by:
      getName in interface JRDataset
      Returns:
      the name of the dataset

    • getScriptletClass

      public String getScriptletClass()
      Description copied from interface: JRDataset
      The name of the scriptlet class to be used when iterating this dataset.
      Specified by:
      getScriptletClass in interface JRDataset
      Returns:
      the scriplet class name

    • getQuery

      public JRQuery getQuery()
      Description copied from interface: JRDataset
      Returns the query of the dataset.

      The query is used by passing a connection is passed to the dataset when instantiating.

      Specified by:
      getQuery in interface JRDataset
      Returns:
      the query of the dataset

    • getScriptlets

      public JRScriptlet[] getScriptlets()
      Description copied from interface: JRDataset
      Returns the dataset's scriptlets.
      Specified by:
      getScriptlets in interface JRDataset
      Returns:
      the dataset's scriptlets

    • getParameters

      public JRParameter[] getParameters()
      Description copied from interface: JRDataset
      Returns the dataset's parameters.
      Specified by:
      getParameters in interface JRDataset
      Returns:
      the dataset's parameters

    • getFields

      public JRField[] getFields()
      Description copied from interface: JRDataset
      Returns the dataset's fields.
      Specified by:
      getFields in interface JRDataset
      Returns:
      the dataset's fields

    • getSortFields

      public JRSortField[] getSortFields()
      Description copied from interface: JRDataset
      Returns the dataset's sort fields.
      Specified by:
      getSortFields in interface JRDataset
      Returns:
      the dataset's sort fields

    • getVariables

      public JRVariable[] getVariables()
      Description copied from interface: JRDataset
      Returns the dataset's variables.
      Specified by:
      getVariables in interface JRDataset
      Returns:
      the dataset's variables

    • getGroups

      public JRGroup[] getGroups()
      Description copied from interface: JRDataset
      Returns the dataset's groups.
      Specified by:
      getGroups in interface JRDataset
      Returns:
      the dataset's groups

    • isMainDataset

      public boolean isMainDataset()
      Description copied from interface: JRDataset
      Decides whether this dataset is the main report dataset or a sub dataset.
      Specified by:
      isMainDataset in interface JRDataset
      Returns:
      true if and only if this dataset is the main report dataset

    • getResourceBundle

      public String getResourceBundle()
      Description copied from interface: JRDataset
      Returns the resource bundle base name.

      The resource bundle is used when evaluating expressions.

      Specified by:
      getResourceBundle in interface JRDataset
      Returns:
      the resource bundle base name

    • getWhenResourceMissingType

      public WhenResourceMissingTypeEnum getWhenResourceMissingType()
      Description copied from interface: JRDataset
      Returns the resource missing handling type.
      Specified by:
      getWhenResourceMissingType in interface JRDataset
      Returns:
      the resource missing handling type

    • setWhenResourceMissingType

      public void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
      Description copied from interface: JRDataset
      Sets the resource missing handling type.
      Specified by:
      setWhenResourceMissingType in interface JRDataset
      Parameters:
      whenResourceMissingType - the resource missing handling type

    • hasProperties

      public boolean hasProperties()
      Description copied from interface: JRPropertiesHolder
      Checks whether the object has any properties.
      Specified by:
      hasProperties in interface JRPropertiesHolder
      Returns:
      whether the object has any properties

    • getPropertiesMap

      public JRPropertiesMap getPropertiesMap()
      Description copied from interface: JRPropertiesHolder
      Returns this object's properties map.
      Specified by:
      getPropertiesMap in interface JRPropertiesHolder
      Returns:
      this object's properties map

    • getParentProperties

      public JRPropertiesHolder getParentProperties()
      Description copied from interface: JRPropertiesHolder
      Returns the parent properties holder, whose properties are used as defaults for this object.
      Specified by:
      getParentProperties in interface JRPropertiesHolder
      Returns:
      the parent properties holder, or null if no parent

    • getPropertyExpressions

      public DatasetPropertyExpression[] getPropertyExpressions()
      Description copied from interface: JRDataset
      Returns the list of dynamic/expression-based properties for this dataset.
      Specified by:
      getPropertyExpressions in interface JRDataset
      Returns:
      an array containing the expression-based properties of this dataset

    • getFilterExpression

      public JRExpression getFilterExpression()
      Description copied from interface: JRDataset
      Returns the dataset filter expression.

      This expression is used to filter the rows of the data source that this dataset will iterate on.

      This expression (if not null) is evaluated immediately after a new row is produced by the data source. The evaluation is performed using field and variable values corresponding to the new row. When the result of the evaluation is Boolean.TRUE the row gets processed by the report filling engine. When the result is null or Boolean.FALSE, the current row will be skipped and the datasource will be asked for the next row.

      Specified by:
      getFilterExpression in interface JRDataset
      Returns:
      the dataset filter expression

    • clone

      public Object clone()
      Specified by:
      clone in interface JRCloneable
      Overrides:
      clone in class Object

    • getEventSupport

      public JRPropertyChangeSupport getEventSupport()
      Description copied from interface: JRChangeEventsSupport
      Returns the property change support object for this instance.
      Specified by:
      getEventSupport in interface JRChangeEventsSupport
      Returns:
      the property change support object for this instance