Package net.sf.jasperreports.engine.xml

Class JRXmlTemplateLoader

java.lang.Object

net.sf.jasperreports.engine.xml.JRXmlTemplateLoader

public class JRXmlTemplateLoader
extends Object

Utility class that loads templates from XML representations.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND
static final String	EXCEPTION_MESSAGE_KEY_TEMPLATE_PARSING_ERROR
static final String	EXCEPTION_MESSAGE_KEY_TEMPLATE_READING_ERROR
static final String	EXCEPTION_MESSAGE_KEY_URL_CONNECTION_ERROR

Method Summary

Modifier and Type	Method	Description
static JRXmlTemplateLoader	getInstance(JasperReportsContext jasperReportsContext)
static JRXmlTemplateLoader	getInstance(RepositoryContext repositoryContext)
static JRTemplate	load(File file)
static JRTemplate	load(InputStream data)
static JRTemplate	load(String location)
static JRTemplate	load(URL url)
JRTemplate	loadTemplate(File file)	Parses a template XML file into a template object.
JRTemplate	loadTemplate(InputStream data)	Parses a template XML data stream into a template object.
JRTemplate	loadTemplate(String location)	Parses a template XML found at a specified location into a template object.
JRTemplate	loadTemplate(URL url)	Parses a template XML located at a URL into a template object.

Methods inherited from class java.lang.Object

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

Field Details

EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND

public static final String EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_TEMPLATE_PARSING_ERROR

public static final String EXCEPTION_MESSAGE_KEY_TEMPLATE_PARSING_ERROR

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_TEMPLATE_READING_ERROR

public static final String EXCEPTION_MESSAGE_KEY_TEMPLATE_READING_ERROR

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_URL_CONNECTION_ERROR

public static final String EXCEPTION_MESSAGE_KEY_URL_CONNECTION_ERROR

See Also:

• Constant Field Values

Method Details

getInstance

public static JRXmlTemplateLoader getInstance(JasperReportsContext jasperReportsContext)

getInstance

public static JRXmlTemplateLoader getInstance(RepositoryContext repositoryContext)

loadTemplate

public JRTemplate loadTemplate(String location)
                        throws JRException

Parses a template XML found at a specified location into a template object.

Parameters:

location - the template XML location. Can be a URL, a file path or a classloader resource name.

Returns:

the template object

Throws:

JRException - when the location cannot be resolved or read

See Also:

• RepositoryUtil.getBytesFromLocation(String)

loadTemplate

public JRTemplate loadTemplate(File file)

Parses a template XML file into a template object.

Parameters:

file - the template XML file

Returns:

the template object

loadTemplate

public JRTemplate loadTemplate(URL url)

Parses a template XML located at a URL into a template object.

Parameters:

url - the location of the template XML

Returns:

the template object

loadTemplate

public JRTemplate loadTemplate(InputStream data)

Parses a template XML data stream into a template object.

Parameters:

data - the data stream

Returns:

the template object

load

public static JRTemplate load(String location)
                       throws JRException

Throws:

JRException

See Also:

• loadTemplate(String)

load

public static JRTemplate load(File file)

See Also:

• loadTemplate(File)

load

public static JRTemplate load(URL url)

See Also:

• loadTemplate(URL)

load

public static JRTemplate load(InputStream data)

See Also:

• loadTemplate(InputStream)