org.patterncoder.source
Interface PatternFileReader

All Known Implementing Classes:

PatternFileReaderDom

public interface PatternFileReader

Classes implementing this interface deal with reading data from the Pattern source files.

Method Summary

java.util.HashMap<java.lang.Object,PatternClass>	getPatternComponents() Returns a List of PatternClass objects that were generated from the source file.
java.lang.String	getPatternDesc() Returns the pattern description retrieved from the source file.
java.lang.String	getPatternImage() Returns the nme of the image used by the pattern.
java.lang.String	getPatternName() Returns the pattern name retrieved from the source file.
java.util.List<WizardPanelDescriptor>	getWizardDescriptors(Wizard parent, PatternModel model) Returns a list of WizardPanelDescriptor objects from data supplied in a source file.
void	parseFile(java.io.File file) Parses the specified source file, to allow for data manipulation.

Method Detail

parseFile

void parseFile(java.io.File file)
               throws java.io.IOException,
                      org.xml.sax.SAXException

Parses the specified source file, to allow for data manipulation.

Parameters:

file - pattern source file.

Throws:

java.io.IOException - thrown if ifle not found.

org.xml.sax.SAXException

getPatternName

java.lang.String getPatternName()

Returns the pattern name retrieved from the source file.

Returns:

the pattern name.

getPatternDesc

java.lang.String getPatternDesc()

Returns the pattern description retrieved from the source file.

Returns:

the pattern description.

getPatternImage

java.lang.String getPatternImage()

Returns the nme of the image used by the pattern.

Returns:

the name of the image.

getPatternComponents

java.util.HashMap<java.lang.Object,PatternClass> getPatternComponents()

Returns a List of PatternClass objects that were generated from the source file.

Returns:

a List of PatternClass objects.

getWizardDescriptors

java.util.List<WizardPanelDescriptor> getWizardDescriptors(Wizard parent,
                                                           PatternModel model)

Returns a list of WizardPanelDescriptor objects from data supplied in a source file.

Parameters:

model - the current data model.

Returns:

a list of WizardPanelDescriptor objects.