net.sf.jasperreports.engine.data

Class JsonDataSource

java.lang.Object

net.sf.jasperreports.engine.data.JRAbstractTextDataSource

net.sf.jasperreports.engine.data.JsonDataSource

All Implemented Interfaces:

JsonData, JRDataSource, JRRewindableDataSource

public class JsonDataSource
extends JRAbstractTextDataSource
implements JsonData

JSON data source implementation

Author:

Narcis Marcu ([email protected])

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTION_MESSAGE_KEY_INVALID_ATTRIBUTE_SELECTION
static String	EXCEPTION_MESSAGE_KEY_INVALID_EXPRESSION
static String	EXCEPTION_MESSAGE_KEY_JSON_FIELD_VALUE_NOT_RETRIEVED
static String	EXCEPTION_MESSAGE_KEY_NO_DATA
static String	PROPERTY_FIELD_EXPRESSION Property specifying the JSON expression for the dataset field.

Fields inherited from class net.sf.jasperreports.engine.data.JRAbstractTextDataSource

EXCEPTION_MESSAGE_KEY_CANNOT_CONVERT_FIELD_TYPE, EXCEPTION_MESSAGE_KEY_CANNOT_MODIFY_PROPERTIES_AFTER_START, EXCEPTION_MESSAGE_KEY_NODE_NOT_AVAILABLE, EXCEPTION_MESSAGE_KEY_NULL_DOCUMENT, EXCEPTION_MESSAGE_KEY_NULL_SELECT_EXPRESSION, EXCEPTION_MESSAGE_KEY_UNKNOWN_COLUMN_NAME, EXCEPTION_MESSAGE_KEY_UNKNOWN_NUMBER_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	JsonDataSource(File file)
	JsonDataSource(File file, String selectExpression)
	JsonDataSource(InputStream stream)
	JsonDataSource(InputStream jsonStream, String selectExpression)
	JsonDataSource(JasperReportsContext jasperReportsContext, String location, String selectExpression) Creates a data source instance that reads JSON data from a given location
protected	JsonDataSource(com.fasterxml.jackson.databind.JsonNode jsonTree, String selectExpression)
	JsonDataSource(RepositoryContext repositoryContext, String location, String selectExpression)
	JsonDataSource(String location, String selectExpression)

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated. no longer required
protected String	getFieldExpression(JRField field)
Object	getFieldValue(JRField jrField) Gets the field value for the current position.
protected com.fasterxml.jackson.databind.JsonNode	getJsonData(com.fasterxml.jackson.databind.JsonNode rootNode, String jsonExpression) Extracts the JSON nodes based on the query expression
protected com.fasterxml.jackson.databind.JsonNode	goDownPath(com.fasterxml.jackson.databind.JsonNode rootNode, String simplePath) Extracts the JSON nodes under the simple path
protected com.fasterxml.jackson.databind.JsonNode	goDownPathWithAttribute(com.fasterxml.jackson.databind.JsonNode rootNode, String pathWithAttributeExpression) Extracts the JSON nodes that match the attribute expression
protected boolean	isValidExpression(com.fasterxml.jackson.databind.JsonNode operand, String attributeExpression) Validates an attribute expression on a JsonNode
void	moveFirst() Moves back to the first element in the data source.
boolean	next() Tries to position the cursor on the next element in the data source.
JsonDataSource	subDataSource() Creates a sub data source using the current node as the base for its input stream.
JsonDataSource	subDataSource(String selectExpression) Creates a sub data source using the current node as the base for its input stream.

Methods inherited from class net.sf.jasperreports.engine.data.JRAbstractTextDataSource

convertNumber, convertStringValue, getConvertBean, getDatePattern, getFormattedDate, getFormattedNumber, getLocale, getNumberPattern, getTextAttributes, getTimeZone, setDatePattern, setLocale, setLocale, setNumberPattern, setTextAttributes, setTextAttributes, setTimeZone, setTimeZone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXCEPTION_MESSAGE_KEY_JSON_FIELD_VALUE_NOT_RETRIEVED

public static final String EXCEPTION_MESSAGE_KEY_JSON_FIELD_VALUE_NOT_RETRIEVED

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_INVALID_ATTRIBUTE_SELECTION

public static final String EXCEPTION_MESSAGE_KEY_INVALID_ATTRIBUTE_SELECTION

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_INVALID_EXPRESSION

public static final String EXCEPTION_MESSAGE_KEY_INVALID_EXPRESSION

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_NO_DATA

public static final String EXCEPTION_MESSAGE_KEY_NO_DATA

See Also:

Constant Field Values

PROPERTY_FIELD_EXPRESSION

public static final String PROPERTY_FIELD_EXPRESSION

Property specifying the JSON expression for the dataset field.

See Also:

Constant Field Values

Constructor Detail

JsonDataSource

public JsonDataSource(InputStream stream)
               throws JRException

Throws:

JRException

JsonDataSource

public JsonDataSource(InputStream jsonStream,
                      String selectExpression)
               throws JRException

Throws:

JRException

JsonDataSource

protected JsonDataSource(com.fasterxml.jackson.databind.JsonNode jsonTree,
                         String selectExpression)
                  throws JRException

Throws:

JRException

JsonDataSource

public JsonDataSource(File file)
               throws FileNotFoundException,
                      JRException

Throws:

FileNotFoundException

JRException

JsonDataSource

public JsonDataSource(File file,
                      String selectExpression)
               throws FileNotFoundException,
                      JRException

Throws:

FileNotFoundException

JRException

JsonDataSource

public JsonDataSource(JasperReportsContext jasperReportsContext,
                      String location,
                      String selectExpression)
               throws JRException

Creates a data source instance that reads JSON data from a given location

Parameters:

jasperReportsContext - the JasperReportsContext

location - a String representing JSON data source

selectExpression - a String representing the select expression

Throws:

JRException

JsonDataSource

public JsonDataSource(RepositoryContext repositoryContext,
                      String location,
                      String selectExpression)
               throws JRException

Throws:

JRException

JsonDataSource

public JsonDataSource(String location,
                      String selectExpression)
               throws JRException

Throws:

JRException

See Also:

JsonDataSource(JasperReportsContext, String, String)

Method Detail

moveFirst

public void moveFirst()
               throws JRException

Description copied from interface: JRRewindableDataSource

Moves back to the first element in the data source.

Specified by:

moveFirst in interface JRRewindableDataSource

Throws:

JRException

next

public boolean next()

Description copied from interface: JRDataSource

Tries to position the cursor on the next element in the data source.

Specified by:

next in interface JRDataSource

Returns:

true if there is a next record, false otherwise

getFieldValue

public Object getFieldValue(JRField jrField)
                     throws JRException

Description copied from interface: JRDataSource

Gets the field value for the current position.

Specified by:

getFieldValue in interface JRDataSource

Returns:

an object containing the field value. The object type must be the field object type.

Throws:

JRException

getJsonData

protected com.fasterxml.jackson.databind.JsonNode getJsonData(com.fasterxml.jackson.databind.JsonNode rootNode,
                                                              String jsonExpression)
                                                       throws JRException

Extracts the JSON nodes based on the query expression

Parameters:

rootNode -

jsonExpression -

Throws:

JRException

goDownPathWithAttribute

protected com.fasterxml.jackson.databind.JsonNode goDownPathWithAttribute(com.fasterxml.jackson.databind.JsonNode rootNode,
                                                                          String pathWithAttributeExpression)
                                                                   throws JRException

Extracts the JSON nodes that match the attribute expression

Parameters:

rootNode -

pathWithAttributeExpression - : e.g. Orders(CustomerId == HILAA)

Throws:

JRException

goDownPath

protected com.fasterxml.jackson.databind.JsonNode goDownPath(com.fasterxml.jackson.databind.JsonNode rootNode,
                                                             String simplePath)

Extracts the JSON nodes under the simple path

Parameters:

rootNode -

simplePath - - a simple field name, with no selection by attribute

isValidExpression

protected boolean isValidExpression(com.fasterxml.jackson.databind.JsonNode operand,
                                    String attributeExpression)
                             throws JRException

Validates an attribute expression on a JsonNode

Parameters:

operand -

attributeExpression -

Throws:

JRException

subDataSource

public JsonDataSource subDataSource()
                             throws JRException

Creates a sub data source using the current node as the base for its input stream.

Specified by:

subDataSource in interface JsonData

Returns:

the JSON sub data source

Throws:

JRException

subDataSource

public JsonDataSource subDataSource(String selectExpression)
                             throws JRException

Creates a sub data source using the current node as the base for its input stream. An additional expression specifies the select criteria that will be applied to the JSON tree node.

Specified by:

subDataSource in interface JsonData

Parameters:

selectExpression -

Returns:

the JSON sub data source

Throws:

JRException

close

@Deprecated
public void close()

Deprecated. no longer required

getFieldExpression

protected String getFieldExpression(JRField field)