Package project35.configurationTool

This package describes the code for the Project35 Configuration Tool.

See:
Description

Class Summary

AdditionalOntologySourceParametersDialog	a convenience class used to capture the "inputFile" and "anchorTerm" parameter values that can be associated with default ontology sources such as TabIndentedOntologySource and SingleColumnTextSource.
ContextHelpOptionsDialog	this dialog provides options for data modellers so they can generate a suite of context help pages
ContextHelpPageCreationPlugin	This plugin is for use with the project35_configuration_tool model It finds the root of a document that describes the configuration options for a given target schema.
ContextHelpPageGenerator	It prompts the users to make some choices about what kind of context help pages they want.
ContextHelpPageWriter	creates a context help web page for a single record.
CreateDefaultSchemaConceptRecordModels	utility class for creating default configuration properties for records used in the Project35 configuration tool.
DefaultConfigurationFileCreationPlugin	plugin for creating a default Project35 configuration file.
DefaultOntologyServiceDescriptionsPlugin	this is a plugin to help data modellers rapidly specify ontology services for an edit field.
DuplicateFieldConfigurationsValidationService	this is a record model validation service plugin that is used with the configuration tool.
DuplicateRecordConfigurationsValidationService	this is a document validation service that is used with the configuration tool.
GenerateFunctionalSpecificationsDialog	a dialog class that allows the application designers to specify the following properties of a functional specification generated from the currently displayed configuration file the name of the functional specification the name of the style sheet that can be used to format the generated specification
GenerateFunctionalSpecificationsPlugin	This plugin is for use with the project35_configuration_tool model It finds the root of a document that describes the configuration options for a given target schema.
OKButtonPanel	a class for creating the OK button panel that will appear at the bottom of many dialogs.
OntologyIdentifierCreationPlugin	This plugin is for use with the project35_configuration_tool model It finds the root of a document that describes the configuration options for a given target schema.
OntologyIdentifierGenerator	This plugin is for use with the project35_configuration_tool model It finds the root of a document that describes the configuration options for a given target schema.
OntologyIdentifierPrefixDialog	a dialog that lets the data modeller choose the following parts that comprise an auto-generated ontology identifier: a prefix, which is probably a namespace (eg: "www.myontology.org.uk:version1.1") a separator character, which is used to break up phrases in the identifier to make them readable
Project35ConfigurationOntologySource	used in the Project35 configuration tool to supply names of records and fields.
Project35ConfigurationTool	This is the main class for invoking the Project35 Configuration Tool.
SelectOntologySourceDialog	dialog the data modeller uses to enter information for creating a default ontology service.
TestApplicationPlugin	Copyright (c) 2008 Kevin Garwood for Project35.

Package project35.configurationTool Description

This package describes the code for the Project35 Configuration Tool. The configuration tool is an example of a Project35 data entry application that is customised with plugins that help populate and validate the fields of a Project35 configuration file. Most of the package contains code which supports the following features:

• creating default ontology services for edit fields: classes that guide application designers to set up simple ontology services that are based on a single column or tab-indented list of terms.
• generating context help pagesclasses that can generate local,stubbed context-help HTML documents or refer to remotely maintained help pages. If they decide to generate local help pages, they can finish the documents by putting feature descriptions in the stubbed parts of the documents. The classes automatically populate the "help_link" configuration option for record, edit field, list field and attribute field definitions.
• generating functional specifications classes that generate a human-readable functional specification that is described by the currently edited configuration file. The specification is generated from information provided by two sources. First, the code analyses properties of the template record model objects that are managed by project35.mda.model.RecordModelFactory. Descriptions of record properties are supplemented by configuration settings that are managed by project35.mda.model.config.Project35ConfigurationReader.
• creation of ontology identifiers classes that prompt the user to provide a naming convention for ontology identifiers associated with form fields and application features. The code then fills in the "ontology_identifier" fields for various parts of currently edited configuration file. Ontology identifiers are used to provide unique feature identifiers that could be used by ontology services to provide more relevant terms to end-users. For example, a service could make use of ontology identifiers of the currently displayed form to determine which terms should be displayed in a list.
• test application based on the current state of the configuration file The code creates a test instance of a Project35Service. Normally a service object contains configuration data that is parsed from a ConfigurationFile.xml file. For the test application, the same configuration options are extracted from a tree of native Project35 data structures that represent the currently edited configuration file.

Most of the plugins use data structures that are defined in the schema found at: ..\models\project35_form_configuration\model\project_form_configuration.xsd.