XG1 Deliverables 1
Informal Scenarios
Scenario1: Edit an XML document without an XSD specified.
Precondition: Jerry wants to edit an XML document that describes the user interface for a computer game. Jerry is tired of sifting through convoluted tags and syntax he doesn’t understand in a simple text editor.
Main flow of events: Jerry opens the XML document in our software. He can edit the XML document that describes the interface by changing the various values of data fields.
He can also add new data fields that describe various objects of the interface, such as new chat boxes, gauges that monitor hit points, stamina, etc. Jerry saves and exits the program. The document is not validated against a schema, but should still be a valid XML document.
Post condition: This has allowed Jerry to edit his document without making careless errors.
Scenario2: Edit an XML document with an XSD(Xml Schema Definition) specified.
Precondition:
Main flow of events: Open XML document with our software which will be displayed in a simple GUI form interface. Make desired changes and click save. Upon saving, the program validates the data, saves and exits. If the data does not validate, the program highlights the incorrect fields and allows user to make corrections.
Post condition: The document has been safely edited while still remaining within the bounds of the schema.
Scenario3: Create a new XML document based on an XSD Schema.
Precondition: Acme Corp. wants all of its news releases to be in XML format so that they can offer them as a web service to other interested parties.
Main flow of events: News guy loads his schema into our software then enters data into proper fields. He can add and delete subfields based on what the schema defines as allowable. His actual data is verified as he inputs it and the program highlights invalid fields (such as invalid dates). When the document is complete he can save it and create another.
Post Condition: News guy has generated his news release in XML and can effectively use our software to manage all of his articles.
Requirements Specification
Supported Activity
List
- Edit XML documents with or without schema definition.
- Create an XML document with a specified schema.
- Validates XML documents that are associated with a schema.
- Ensures XML documents are well-formed.
Human-computer
interface description
- Form-based GUI. Either Web interface or Java GUI.
- User provides data through a form based interface.
Solved problem list
- Allows user to edit or create an XML document without pre-existing knowledge of XML.
- GUI prevents common XML syntax errors.
- Allows quick manipulation of XML documents by eliminating the need to decipher confusing XML tags.
Information source
list
- A provided schema.
- Existing XML documents.
- User input.
Information
requesting organization list
- Web/Database Developers - currently using ASCII text editors.
- Business users in need of storing data in xml format - no universal application to meet this need.
- Scientific users - currently working with ASCII text editors.
- Various types of information can be written/edited/etc. with this tool. Data can represent a wide area of fields. The GUI is independent of this variation.
Checks and Balances
- Check XML document to assure it is well-formed. XML form data is validated against the schema.
- These checks allow the document to be used according to XML standards and the intent of the document specified by the schema.
Security and
fault-tolerance requirements
- Security measures need to be implemented if the Web interface design is implemented. SSL encryption should then be utilized in order to protect sensitive data.
Interoperating
Systems List
- Java Virtual Machine
Estimates of present
information capacity and projected growth
- Memory limits the size of the XML document being edited. Upon parsing, the document is loaded into memory for traversal. Process overhead produced by Java Runtime environment for processing of a large DOM.
Prioritization of
requirements
Ethical Concerns List
- Ensure users are informed of the software package's limitations. Implementation will be expanded with further releases.
Primary Classes
- XML Document
- Schema
- Edit Form
- Create Form