com.elixirtech.report2.runtime
Interface IReportAdmin

public interface IReportAdmin

IReportAdmin provides basic report management functions.

Method Summary

void	addFileSystem(java.lang.String type, java.lang.String name, java.lang.String config) Add a filesystem to the repository.
void	addJarFileSystem(java.lang.String name, java.lang.String jarFile) Add Jar archived file in the repository.
void	addLocalFileSystem(java.lang.String name, java.lang.String root) Add a local directory structure as a new File System in the repository.
java.lang.String[]	getFileNames(java.lang.String fileSystem) List the names of files as template and datasources in a Filesystem.
java.lang.String[]	getFileSystems() List the names of the Filesystems in the repository.
java.lang.String[]	getReportNames(java.lang.String fileSystem) List the names of templates in a Filesystem.
void	loadRepository(java.io.File repositoryXML) Loads the repository filesystems from an XML file (such as the standard repository.xml)
void	loadRepository(java.io.InputStream repositoryXML) Loads the repository filesystems from an XML file passed as stream.
void	refreshFileSystem(java.lang.String name) Refresh Filesystem by re-scanning the source information.
void	removeFileSystem(java.lang.String name) Remove Filesystem.It will also clear rml object that is cached.

Method Detail

loadRepository

void loadRepository(java.io.File repositoryXML)
                    throws java.io.IOException

Loads the repository filesystems from an XML file (such as the standard repository.xml)

Parameters:

repositoryXML - The file containing the filesystems to be loaded

Throws:

java.io.IOException

loadRepository

void loadRepository(java.io.InputStream repositoryXML)
                    throws java.io.IOException

Loads the repository filesystems from an XML file passed as stream. (such as the standard repository.xml)

Parameters:

repositoryXML - The stream containing the filesystems to be loaded

Throws:

java.io.IOException

getFileSystems

java.lang.String[] getFileSystems()

List the names of the Filesystems in the repository.

Returns:

An array of filesystem names

getReportNames

java.lang.String[] getReportNames(java.lang.String fileSystem)

List the names of templates in a Filesystem. The returned names include the full path required to access the report, for example "/Workspace/folder/report.rml".

Parameters:

fileSystem - Filesystem name

Returns:

An array of report names

getFileNames

java.lang.String[] getFileNames(java.lang.String fileSystem)

List the names of files as template and datasources in a Filesystem. The returned names include the full path required to access the report or data Source, for example "/Workspace/folder/mydata.ds".

Parameters:

fileSystem - Filesystem name

Returns:

An array of file names

addLocalFileSystem

void addLocalFileSystem(java.lang.String name,
                        java.lang.String root)

Add a local directory structure as a new File System in the repository.

Parameters:

name - Filesytem name

root - Path to the root of the directory subtree

addJarFileSystem

void addJarFileSystem(java.lang.String name,
                      java.lang.String jarFile)

Add Jar archived file in the repository.

Parameters:

name - Filesystem name

jarFile - Jar file path

addFileSystem

void addFileSystem(java.lang.String type,
                   java.lang.String name,
                   java.lang.String config)

Add a filesystem to the repository.

Parameters:

type - Filesystem type - eg. "local", "jar", etc.

name - Filesystem name

config - Filesystem config string (content varies with type)

refreshFileSystem

void refreshFileSystem(java.lang.String name)

Refresh Filesystem by re-scanning the source information. It will also clear rml object that is cached.

Parameters:

name - Filesystem name

removeFileSystem

void removeFileSystem(java.lang.String name)

Remove Filesystem.It will also clear rml object that is cached.

Parameters:

name - Filesystem name