com.adventnet.components.projectworkspace
Interface FileReaderInterface

All Known Implementing Classes:

DefaultFileReader

public interface FileReaderInterface

This interface is provided to read the input xml file & return a document object and/or to read the image file & return an imageicon object. The Project Workspace framework needs XML and image files as input, which can be read in any fashion by the application( which uses this framework) but the application should pass this input to the framework in framework understandable format i.e org.w3c.dom.Document and javax.swing.ImageIcon respectively.

Method Summary

javax.swing.ImageIcon	loadImageFile(java.lang.String imageName) Returns a ImageIcon object which is constructed from the input image file.
org.w3c.dom.Document	loadXMLFile(java.lang.String fileName) Returns a Document object which is constructed from the input xml file.

Method Detail

loadXMLFile

public org.w3c.dom.Document loadXMLFile(java.lang.String fileName)
                                 throws FrameworkException

Returns a Document object which is constructed from the input xml file.

Parameters:

fileName - The url or path of the input file.

Returns:

The Document reference.

Throws:

FrameworkException - if an error occurs

loadImageFile

public javax.swing.ImageIcon loadImageFile(java.lang.String imageName)
                                    throws FrameworkException

Returns a ImageIcon object which is constructed from the input image file.

Parameters:

imageName - The url or path of the input image file.

Returns:

The ImageIcon reference.

Throws:

FrameworkException - if an error occurs