project35.mda.config
Class Project35ConfigurationReader

java.lang.Object
  project35.mda.config.Project35ConfigurationReader

All Implemented Interfaces:

SchemaConceptPropertyManager

public class Project35ConfigurationReader
extends Object
implements SchemaConceptPropertyManager

this is the class that holds configuration data that the XML Schema can't express. The configuration reader reads a configuration file which conforms with the XML Schema for the Project35 Configuration Tool. It reads parts of the file and stores the data in a collection of data container classes, usually ending in "..Configuration.java". Once the configuration reader is intialised, it is used by other parts of the Project35 application to lookup configuration options for application features such as menus, or schema concepts

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Constructor Summary

Project35ConfigurationReader()

Method Summary

void	addComponentSchema(ComponentSchemaConfiguration componentSchemaConfiguration)
void	addRecordConfiguration(RecordConfiguration recordConfiguration)
AttributeFieldConfiguration	getAttributeFieldConfiguration(String recordClassName, String fieldName)
ComponentSchemaConfiguration[]	getComponentSchemaConfigurations()
SchemaConceptConfiguration	getConfigurationRecord(String recordClassName, String fieldName) provides a lookup method for getting configuration data on a particular field in a record.
CustomMenuConfiguration[]	getCustomMenuConfigurations()
String	getDateFormat()
String	getDialogTitle()
DocumentValidationServiceConfiguration[]	getDocumentValidationServiceConfigurations()
EditFieldConfiguration	getEditFieldConfiguration(String recordClassName, String fieldName)
EditMenuConfiguration	getEditMenuConfiguration()
FileLauncher	getFileLauncher()
FileMenuConfiguration	getFileMenuConfiguration()
GeneralDisplayPropertiesConfiguration	getGeneralDisplayPropertiesConfiguration()
HelpMenuConfiguration	getHelpMenuConfiguration()
ListFieldConfiguration	getListFieldConfiguration(String recordClassName, String fieldName)
OptionsMenuConfiguration	getOptionsMenuConfiguration()
RecordConfiguration[]	getRecordConfigurations()
SessionManager	getSessionManager()
String	getStyleSheet()
String	getTopLevelElementName() Returns the name of the top level element in case that the schema is ambiguous that is has several global elements.
ViewMenuConfiguration	getViewMenuConfiguration()
boolean	ignoreSchemaLocation()
void	parseExtensionLauncherRegistry(InputStream extensionLauncherStream)
void	parseMainConfigurationFile(InputStream inputStream, URL documentDirectory, URL resourceDirectory)
void	parseSessionFile(File favouritesFile)
void	setComponentSchemas(ArrayList componentSchemas)
void	setCustomMenuConfigurations(ArrayList customMenuConfigurations)
void	setDateFormat(String dateFormat)
void	setDefaultValues(RecordModel recordModel)
void	setDialogTitle(String dialogTitle)
void	setDocumentValidationServiceConfigurations(ArrayList documentValidationServiceConfigurations)
void	setEnableClassLoader(boolean enableClassLoader)
void	setFileMenuConfiguration(FileMenuConfiguration fileMenuConfiguration)
void	setGeneralDisplayPropertiesConfiguration(GeneralDisplayPropertiesConfiguration generalDisplayPropertiesConfiguration)
void	setHelpMenuConfiguration(HelpMenuConfiguration helpMenuConfiguration)
void	setIgnoreSchemaLocation(boolean ignoreSchemaLocation)
void	setRecordConfigurations(ArrayList recordConfigurations)
void	setStyleSheet(String styleSheet) sets the style sheet used by the configuration file
void	setTopLevelElementName(String topLevelElementName) Sets the name of the top level element in case that the schema is ambiguous that is has several global elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

Project35ConfigurationReader

public Project35ConfigurationReader()

Method Detail

getComponentSchemaConfigurations

public ComponentSchemaConfiguration[] getComponentSchemaConfigurations()

ignoreSchemaLocation

public boolean ignoreSchemaLocation()

getFileMenuConfiguration

public FileMenuConfiguration getFileMenuConfiguration()

getEditMenuConfiguration

public EditMenuConfiguration getEditMenuConfiguration()

getOptionsMenuConfiguration

public OptionsMenuConfiguration getOptionsMenuConfiguration()

getViewMenuConfiguration

public ViewMenuConfiguration getViewMenuConfiguration()

getHelpMenuConfiguration

public HelpMenuConfiguration getHelpMenuConfiguration()

getCustomMenuConfigurations

public CustomMenuConfiguration[] getCustomMenuConfigurations()

getConfigurationRecord

public SchemaConceptConfiguration getConfigurationRecord(String recordClassName,
                                                         String fieldName)

provides a lookup method for getting configuration data on a particular field in a record.

Specified by:

getConfigurationRecord in interface SchemaConceptPropertyManager

Parameters:

recordClassName - the record tag name

fieldName - the field tag name. For Configuration records that describe the record-level attributes, fieldName will be "null"

getAttributeFieldConfiguration

public AttributeFieldConfiguration getAttributeFieldConfiguration(String recordClassName,
                                                                  String fieldName)

Specified by:

getAttributeFieldConfiguration in interface SchemaConceptPropertyManager

getEditFieldConfiguration

public EditFieldConfiguration getEditFieldConfiguration(String recordClassName,
                                                        String fieldName)

Specified by:

getEditFieldConfiguration in interface SchemaConceptPropertyManager

getListFieldConfiguration

public ListFieldConfiguration getListFieldConfiguration(String recordClassName,
                                                        String fieldName)

Specified by:

getListFieldConfiguration in interface SchemaConceptPropertyManager

getTopLevelElementName

public String getTopLevelElementName()

Returns the name of the top level element in case that the schema is ambiguous that is has several global elements. Returns null if no top level element name was defined.

Returns:

the name of the top level element in case that the schema is ambiguous.

getDialogTitle

public String getDialogTitle()

getSessionManager

public SessionManager getSessionManager()

getFileLauncher

public FileLauncher getFileLauncher()

Specified by:

getFileLauncher in interface SchemaConceptPropertyManager

getRecordConfigurations

public RecordConfiguration[] getRecordConfigurations()

getStyleSheet

public String getStyleSheet()

getDateFormat

public String getDateFormat()

getDocumentValidationServiceConfigurations

public DocumentValidationServiceConfiguration[] getDocumentValidationServiceConfigurations()

getGeneralDisplayPropertiesConfiguration

public GeneralDisplayPropertiesConfiguration getGeneralDisplayPropertiesConfiguration()

setDefaultValues

public void setDefaultValues(RecordModel recordModel)

Specified by:

setDefaultValues in interface SchemaConceptPropertyManager

setEnableClassLoader

public void setEnableClassLoader(boolean enableClassLoader)

setIgnoreSchemaLocation

public void setIgnoreSchemaLocation(boolean ignoreSchemaLocation)

parseMainConfigurationFile

public void parseMainConfigurationFile(InputStream inputStream,
                                       URL documentDirectory,
                                       URL resourceDirectory)
                                throws Exception

Throws:

Exception

parseSessionFile

public void parseSessionFile(File favouritesFile)
                      throws ParserConfigurationException,
                             Project35Exception,
                             SAXException,
                             IOException

Throws:

ParserConfigurationException

Project35Exception

SAXException

IOException

parseExtensionLauncherRegistry

public void parseExtensionLauncherRegistry(InputStream extensionLauncherStream)
                                    throws ParserConfigurationException,
                                           Project35Exception,
                                           SAXException,
                                           IOException

Throws:

ParserConfigurationException

Project35Exception

SAXException

IOException

addRecordConfiguration

public void addRecordConfiguration(RecordConfiguration recordConfiguration)

setRecordConfigurations

public void setRecordConfigurations(ArrayList recordConfigurations)

setTopLevelElementName

public void setTopLevelElementName(String topLevelElementName)

Sets the name of the top level element in case that the schema is ambiguous that is has several global elements.

Parameters:

topLevelElementName - the name of the top level element.

addComponentSchema

public void addComponentSchema(ComponentSchemaConfiguration componentSchemaConfiguration)

setComponentSchemas

public void setComponentSchemas(ArrayList componentSchemas)

setHelpMenuConfiguration

public void setHelpMenuConfiguration(HelpMenuConfiguration helpMenuConfiguration)

setFileMenuConfiguration

public void setFileMenuConfiguration(FileMenuConfiguration fileMenuConfiguration)

setDateFormat

public void setDateFormat(String dateFormat)

setStyleSheet

public void setStyleSheet(String styleSheet)

sets the style sheet used by the configuration file

setDialogTitle

public void setDialogTitle(String dialogTitle)

setDocumentValidationServiceConfigurations

public void setDocumentValidationServiceConfigurations(ArrayList documentValidationServiceConfigurations)

setGeneralDisplayPropertiesConfiguration

public void setGeneralDisplayPropertiesConfiguration(GeneralDisplayPropertiesConfiguration generalDisplayPropertiesConfiguration)

setCustomMenuConfigurations

public void setCustomMenuConfigurations(ArrayList customMenuConfigurations)