net.sf.jasperreports.engine.component.ComponentsXmlParser Maven / Gradle / Ivy
Show all versions of jasperreports Show documentation
/*
* 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.engine.component;
/**
* A components XML parsers contains information required to parse components
* contained by a single component bundle.
*
* @author Lucian Chirita ([email protected])
*/
public interface ComponentsXmlParser
{
/**
* Returns the namespace used by the component bundle.
*
*
* The XML representation of the components will use this namespace.
*
* @return the component bundle namespace
*/
String getNamespace();
/**
* Returns the public location of the component bundle XML schema.
*
*
* This would be listed in schemaLocation
XML attributes.
*
* @return the public location of the component bundle XML schema
*/
String getPublicSchemaLocation();
/**
* Returns a resource name that resolves to an internal XML schema
* resource.
*
*
* If not null, the resource (which needs to be present on the classpath)
* will be used when parsing component XML fragments instead of the public
* XML schema.
*
* @return the name of the internal XML schema resource
*/
String getInternalSchemaResource();
/**
* Returns a digester configurer for the component bundle.
*
*
* The digester configurer is responsible for providing digester rules
* that transform an XML fragment into a {@link Component} instance.
*
* @return a digester configurer
*/
XmlDigesterConfigurer getDigesterConfigurer();
}