net.sf.jasperreports.export.JsonMetadataReportConfiguration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Free Java Reporting Library
There is a newer version: 6.21.3
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JasperReports. If not, see .
 */
package net.sf.jasperreports.export;

import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.export.annotations.ExporterProperty;
import net.sf.jasperreports.properties.PropertyConstants;


/**
 * Interface containing settings used by the JSON Metadata exporter.
 *
 * @see net.sf.jasperreports.engine.export.JsonMetadataExporter
 *
 * @author Narcis Marcu ([email protected])
 */
public interface JsonMetadataReportConfiguration extends JsonReportConfiguration {

	/**
	 * Property whose value is used as default for the {@link #isEscapeMembers()} export configuration setting.
	 * 
	 * The property itself defaults to true.
	 * 
	 *
	 * @see net.sf.jasperreports.engine.JRPropertiesUtil
	 */
	@Property(
			category = PropertyConstants.CATEGORY_EXPORT,
			defaultValue = PropertyConstants.BOOLEAN_TRUE,
			scopes = {PropertyScope.REPORT},
			sinceVersion = PropertyConstants.VERSION_6_0_0,
			valueType = Boolean.class
			)
	public static final String JSON_EXPORTER_ESCAPE_MEMBERS = JRPropertiesUtil.PROPERTY_PREFIX + "export.json.escape.members";


	/**
	 * Property whose value is used as default for the {@link #getJsonSchemaResource()} export configuration setting.
	 *
	 * @see net.sf.jasperreports.engine.JRPropertiesUtil
	 */
	@Property(
			category = PropertyConstants.CATEGORY_EXPORT,
			scopes = {PropertyScope.REPORT},
			sinceVersion = PropertyConstants.VERSION_6_0_0
			)
	public static final String JSON_EXPORTER_JSON_SCHEMA = JRPropertiesUtil.PROPERTY_PREFIX + "export.json.schema";



	/**
	 *
	 */
	@ExporterProperty(
		value=JSON_EXPORTER_ESCAPE_MEMBERS,
		booleanDefault=true
		)
	public Boolean isEscapeMembers();

	/**
	 *
	 */
	@ExporterProperty(value=JSON_EXPORTER_JSON_SCHEMA)
	public String getJsonSchemaResource();
}