net.windward.xmlreport
Interface IImportFile

public interface IImportFile

This implements a system to import files requested via the import tag. This class must be instantiated because there is no static methods in an interface. But this is a singleton, a single object will be instantiated for the engine to handle all import requests and therefore must be thread safe.

Version:

5.0 19 August 2007

Method Summary

java.io.InputStream

readImport(java.lang.String filename, java.util.Map attributes, java.lang.String baseDirectory) Read in an imported file.

Method Detail

readImport

public java.io.InputStream readImport(java.lang.String filename,
                                      java.util.Map attributes,
                                      java.lang.String baseDirectory)
                               throws java.io.IOException

Read in an imported file.

Parameters:

filename - The filename, url, etc.

attributes - The tag properties.

baseDirectory - The base directory for reletive filenames. null if there is no base directory.

Returns:

The file contents. null if the file cannot be found.

Throws:

java.io.IOException - hit a problem reading the file.