A C D E F G H I L M N O P R S T U V

A

ACTOR - Static variable in class discovery.gui.FlowDrawingArea

Static integer to represent the panel's actor drawing state.

ACTOR - Static variable in class discovery.gui.StructureDrawingArea

Static integer to represent the panel's actor drawing state.

ACTOR - Static variable in class discovery.model.NarrativeModel

ActorModel - Class in discovery.model

This class represents an actor in the model.

ActorModel() - Constructor for class discovery.model.ActorModel

Creates an ActorModel instance with null values for its name and connections list.

ActorModel(String) - Constructor for class discovery.model.ActorModel

Creates an ActorModel instance with the name n.

ActorModel(Integer, String, ArrayList) - Constructor for class discovery.model.ActorModel

Creates an ActorModel instance with the supplied attributes.

ActorView - Class in discovery.view

This class represents the view of an Actor.

ActorView() - Constructor for class discovery.view.ActorView

The empty constructor, creates an ActorView object with no label.

ActorView(String, double, double, double, double, int) - Constructor for class discovery.view.ActorView

Constructor which specifies the actor's label, bounds and the ID of it's corresponding ActorModel object.

addComponent(ComponentModel) - Method in class discovery.data.ComponentDataManager

This is a mutator method which adds the data held within a ComponentModel object to the 'components.xml' file.

addConnection(ConnectionModel) - Method in class discovery.data.ConnectionDataManager

This is a mutator method which adds the data held within a ConnectionModel object to the 'connections.xml' file.

addConnection(Integer) - Method in class discovery.model.ActorModel

Mutator method to add a connection to this ActorModel object's list of connections.

addConnection(Integer) - Method in interface discovery.model.ComponentModel

All component model objects can have connections associated with them.

addConnection(Integer) - Method in class discovery.model.ObjectModel

Mutator method to add a connection to this ObjectModel object's list of connections.

addConnection(Integer) - Method in class discovery.model.TaskModel

Mutator method to add a connection to this TaskModel object's list of connections.

addNarrative(NarrativeModel) - Method in class discovery.data.NarrativeDataManager

This is a mutator method which adds the data held within a Narrative object to the 'narratives.xml' file.

areaIsEmpty(Rectangle) - Method in class discovery.gui.FlowDrawingArea

Tests whether the supplied rectangle contains any diagram components.

areaIsEmpty(Rectangle) - Method in class discovery.gui.StructureDrawingArea

Tests whether the supplied rectangle contains any diagram components.

C

calculateConnection(ConnectionView) - Method in class discovery.gui.FlowDrawingArea

Calculates the connecting line between two components, and returns the line as a GeneralPath object.

calculateConnectionPath(ConnectionView) - Method in class discovery.gui.StructureDrawingArea

Calculates the connecting line between two components, and returns the line as a GeneralPath object.

calculatePosition() - Method in class discovery.gui.Node

This method calculates the position where the node should be drawn on screen, based on the size of the box bounding it and its children.

clearArea(Rectangle, Graphics) - Method in class discovery.gui.DrawingArea

Erases all of the diagram drawing in the area specified.

clearConnection(ConnectionView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Removes a connection line from the diagram.

clearConnection(ConnectionView, Graphics) - Method in class discovery.gui.StructureDrawingArea

Removes a connection line from the diagram.

clearConnections(Graphics) - Method in class discovery.gui.FlowDrawingArea

Removes all connection lines from the diagram.

clearConnections(Graphics) - Method in class discovery.gui.StructureDrawingArea

Removes all connection lines from the diagram.

clearDiagram() - Method in class discovery.gui.NarrativeScreen

Clears all data on the narrative screen.

clearDrawingArea() - Method in class discovery.gui.StructureDrawingArea

This method clears all drawing from the drawing panel, and resets all diagram information.

ComponentDataManager - Class in discovery.data

This class is responsible for all program interaction with the component database.

ComponentDataManager() - Constructor for class discovery.data.ComponentDataManager

ComponentModel - Interface in discovery.model

This class provides an interface to group together all of the component model types.

ComponentView - Interface in discovery.view

This interface groups together the view classes of the various components that make up a Discovery diagram.

COMPOSITION - Static variable in class discovery.model.ConnectionModel

Static integer representing a composition connection type in a connection between tasks.

COMPOSITION - Static variable in class discovery.view.ConnectionView

Static integer representing a composition connection type in a connection between tasks.

Configuration - Class in discovery.data

This class is responsible for reading and writing data to the configuration xml file.

Configuration() - Constructor for class discovery.data.Configuration

ConnectionDataManager - Class in discovery.data

This class is responsible for all program interaction with the connection database.

ConnectionDataManager() - Constructor for class discovery.data.ConnectionDataManager

connectionIsValid(ConnectionModel) - Static method in class discovery.model.ConsistencyChecker

Tests whether the supplied connection is valid.

ConnectionModel - Class in discovery.model

This class represents a connection between two components in the model.

ConnectionModel() - Constructor for class discovery.model.ConnectionModel

Creates an empty connection with no components to connect or a connection type.

ConnectionModel(int, int, int) - Constructor for class discovery.model.ConnectionModel

Creates a connection between components c1 and c2, of type t.

ConnectionModel(int, int, int, int) - Constructor for class discovery.model.ConnectionModel

Creates the connection with ID number id between components c1 and c2, of type t.

ConnectionView - Class in discovery.view

This class represents the view of a connection between two components.

ConnectionView(ComponentView, ComponentView, int) - Constructor for class discovery.view.ConnectionView

Constructor which takes the two components to be connected, and the type of relation between them.

ConnectionView(ComponentView, ComponentView, int, int) - Constructor for class discovery.view.ConnectionView

Constructor which includes the ID number of the connection.

CONNECTOR1 - Static variable in class discovery.gui.FlowDrawingArea

Static integer to indicate that the panel is waiting for the first component to be selected in a connection.

CONNECTOR1 - Static variable in class discovery.gui.StructureDrawingArea

Static integer to indicate that the panel is waiting for the first component to be selected in a connection.

CONNECTOR2 - Static variable in class discovery.gui.FlowDrawingArea

Static integer to indicate that the panel is waiting for the second component to be selected in a connection.

CONNECTOR2 - Static variable in class discovery.gui.StructureDrawingArea

Static integer to indicate that the panel is waiting for the second component to be selected in a connection.

connectVia(ConnectionView) - Method in class discovery.gui.DrawingFunctions

Given a connection, this method calculates whether the connecting line should divert around the left or right of the destination component, or just go straight to the top of it.

ConsistencyChecker - Class in discovery.model

Contains a range of methods that should be called whenever data in the repository is modified to ensure that the changes are valid.

ConsistencyChecker() - Constructor for class discovery.model.ConsistencyChecker

createPopupMenu(String) - Method in class discovery.gui.FlowDrawingArea

Creates a popup menu when a component is right-clicked.

createPopupMenu(String) - Method in class discovery.gui.StructureDrawingArea

Creates a popup menu when a component is right-clicked.

D

DateGenerator - Class in discovery.model

This class is responsible for generating the date in the required format, for automatic inclusion in narrative diagrams.

DateGenerator() - Constructor for class discovery.model.DateGenerator

delete - Variable in class discovery.gui.FlowDrawingArea

deleteComponent(int) - Method in class discovery.data.ComponentDataManager

This is a mutator method which deletes a component from the 'components.xml' file.

deleteComponent(ComponentView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Deletes the specified component, and all of the connections going to it.

deleteComponent(ComponentView, Graphics) - Method in class discovery.gui.StructureDrawingArea

Deletes the specified component, and all of the connections going to it.

deleteConnection(int) - Method in class discovery.data.ConnectionDataManager

This is a mutator method which deletes a component from the 'connections.xml' file.

deleteConnection(ConnectionView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Removes the specified connection from the diagram and from the database.

deleteConnection(ConnectionView, Graphics) - Method in class discovery.gui.StructureDrawingArea

Removes the specified connection from the diagram and from the database.

deleteConnectionsTo(ComponentView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Deletes all connections that are going to the specified component.

deleteConnectionsTo(ComponentView, Graphics) - Method in class discovery.gui.StructureDrawingArea

Deletes all connections that are going to the specified component.

deleteNarrative(int) - Method in class discovery.data.NarrativeDataManager

This is a mutator method which deletes a narrative from the 'narratives.xml' file.

DiagramLayoutManager - Class in discovery.gui

This class is responsible for calculating the layout of diagrams, after loading TaskModel objects from the database.

DiagramLayoutManager() - Constructor for class discovery.gui.DiagramLayoutManager

disableDoubleBuffering(Component) - Static method in class discovery.gui.PrintManager

This method disables double buffering when the specified component is repainted.

discovery.data - package discovery.data

discovery.gui - package discovery.gui

discovery.model - package discovery.model

discovery.view - package discovery.view

DISPATCH - Static variable in class discovery.model.NarrativeModel

drawActor(ActorView, Graphics) - Method in class discovery.gui.DrawingArea

Draws and actor on screen.

drawArrowHead(int, int, Graphics) - Method in class discovery.gui.FlowDrawingArea

Draws an arrow head at the end of a connecting line.

drawComponent(ComponentView, Graphics) - Method in class discovery.gui.DrawingArea

Draws a diagram component on screen.

drawComposition(double, double, Graphics) - Method in class discovery.gui.StructureDrawingArea

Draws a composition diamond in the specified position.

drawConnection(ConnectionView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Draws the connecting line between two components.

drawConnection(ConnectionView, Graphics) - Method in class discovery.gui.StructureDrawingArea

Draws the connecting line between two components.

drawConnectionSelectionBoxes(ConnectionView, Graphics) - Method in class discovery.gui.DrawingArea

Draws selection boxes at the ends of a connection line.

drawDecisionPoint(double, double, Graphics) - Method in class discovery.gui.FlowDrawingArea

Draws a decision point diamond with its tip at the specified location.

drawDiagram(int) - Method in class discovery.gui.NarrativeScreen

Fills out the narrative screen with data from the narrative with the specified ID, as loaded from the repository.

drawDiagram(int, int) - Method in class discovery.gui.StructureDrawingArea

This method uses the diagram layout manager to get the diagram components to draw.

drawDiagrams() - Method in class discovery.gui.MainScreen

Calls the draw diagram methods on the diagram editing screens, so that they draw the diagrams for the currently selected task.

drawEndPoint(EndPointView, Graphics) - Method in class discovery.gui.DrawingArea

Draws an end point icon for a task flow diagram.

drawFailPoint(FailPointView, Graphics) - Method in class discovery.gui.DrawingArea

Draws a fail point icon for a task flow diagram.

drawGeneralisation(double, double, Graphics) - Method in class discovery.gui.StructureDrawingArea

Draws a generalisation triangle in the specified position.

DrawingArea - Class in discovery.gui

This class contains a range of functions that are common to both the task flow and task structure diagram editors.

DrawingArea() - Constructor for class discovery.gui.DrawingArea

DrawingFunctions - Class in discovery.gui

This class contains various non-graphical functions that are required for drawing diagrams.

DrawingFunctions() - Constructor for class discovery.gui.DrawingFunctions

drawOwnership(double, double, Graphics) - Method in class discovery.gui.DrawingArea

Draws a black circle at the end of a connecting line to denote ownership.

drawSelectionBoxes(Rectangle, Graphics) - Method in class discovery.gui.DrawingArea

Draws selection boxes around the component with the bounding box specified by the supplied rectangle.

drawShadow(Rectangle, Graphics) - Method in class discovery.gui.DrawingArea

Draws a blue rectangle indicating the new location of a component, while it is being moved or resized.

drawStartPoint(StartPointView, Graphics) - Method in class discovery.gui.DrawingArea

Draws a start point icon for a task flow diagram.

drawTitle(String, String, Graphics) - Method in class discovery.gui.DrawingArea

Draws the title of the diagram in the top left corner.

E

enableDoubleBuffering(Component) - Static method in class discovery.gui.PrintManager

This method enables double buffering when the specified component is repainted.

ENDPOINT - Static variable in class discovery.gui.FlowDrawingArea

Static integer to represent the panel's endpoint drawing state.

EndPointView - Class in discovery.view

This class represents the view of an End Point.

EndPointView() - Constructor for class discovery.view.EndPointView

The empty constructor, creates an EndPointView object with no label.

EndPointView(double, double, double, double) - Constructor for class discovery.view.EndPointView

A constructor which specifies the bounds of the end point

EXCEPTION - Static variable in class discovery.model.NarrativeModel

expandPanel(Rectangle) - Method in class discovery.gui.DrawingArea

Extends the panel when diagram components are moved to the edge of it, so that diagrams don't fall off the edge of the panel.

extendLeft(int) - Method in class discovery.gui.Node

Extends the node's bounding box so that its x-position is the supplied value, but its right-hand-side boundary remains in the same position.

extendRight(int) - Method in class discovery.gui.Node

Extends the node's bounding box so that its position remains the same, but its width reaches to the supplied value.

F

FAILPOINT - Static variable in class discovery.gui.FlowDrawingArea

Static integer to represent the panel's failpoint drawing state.

FailPointView - Class in discovery.view

This class represents the view of a Fail Point.

FailPointView() - Constructor for class discovery.view.FailPointView

The empty constructor, creates a FailPointView object with no label.

FailPointView(double, double, double, double) - Constructor for class discovery.view.FailPointView

A constructor which specifies the bounds of the fail point

FLOW - Static variable in class discovery.model.ConnectionModel

Static integer representing a flow connection type in a connection.

FLOW - Static variable in class discovery.view.ConnectionView

Static integer representing a flow connection type in a connection.

FlowDrawingArea - Class in discovery.gui

This class represents the drawing panel where Task Flow diagrams are drawn.

FlowDrawingArea(int, int, int, int, MainScreen) - Constructor for class discovery.gui.FlowDrawingArea

Constructor, which sets up the drawing panel and initializes all of the variables required.

G

g - Variable in class discovery.gui.DrawingArea

GENERALISATION - Static variable in class discovery.model.ConnectionModel

Static integer representing a generalisation connection type in a connection between tasks.

GENERALISATION - Static variable in class discovery.view.ConnectionView

Static integer representing a generalisation connection type in a connection between tasks.

generateComponentID() - Static method in class discovery.model.IDGenerator

This method returns a unique integer ID number for a component model object.

generateConnectionID() - Static method in class discovery.model.IDGenerator

This method returns a unique integer ID number for a connection model object.

generateDate() - Static method in class discovery.model.DateGenerator

Static method that returns the current date in the form dd/MM/yyyy and returns it as a string.

generateNarrativeID() - Static method in class discovery.model.IDGenerator

This method returns a unique integer ID number for a Narrative object.

getActors() - Method in class discovery.model.NarrativeModel

Accessor method to get the actors for this narrative.

getAuthor() - Method in class discovery.model.NarrativeModel

Accessor method to get the author for this narrative.

getBounds() - Method in class discovery.gui.Node

Accessor method to get the bounds of this Node and its children.

getComponent(int) - Method in class discovery.data.ComponentDataManager

This is an accessor method which returns a ComponentModel object of a component in the database.

getComponent1() - Method in class discovery.model.ConnectionModel

Accessor method to get the first component (ie.

getComponent1() - Method in class discovery.view.ConnectionView

Accessor method to get the source component.

getComponent2() - Method in class discovery.model.ConnectionModel

Accessor method to get the second component (ie.

getComponent2() - Method in class discovery.view.ConnectionView

Accessor method to get the destination component.

getComponents(String) - Method in class discovery.data.ComponentDataManager

This is an accessor method which returns a TreeMap of a certain type of component, mapping each component's name (key) and ID number (value).

getComponentToDraw() - Method in class discovery.gui.MainScreen

Returns the ID number of the component selected on the component list of the palette.

getConcerns() - Method in class discovery.model.NarrativeModel

Accessor method to get the concerns for this narrative.

getConnection(int) - Method in class discovery.data.ConnectionDataManager

This is an accessor method which returns a ConnectionModel object of a connection in the database.

getConnections() - Method in class discovery.data.ConnectionDataManager

This is an accessor that returns all connections in the database.

getConnections() - Method in class discovery.model.ActorModel

Accessor to get the connections going from this actor.

getConnections() - Method in interface discovery.model.ComponentModel

All component model objects must have an accessor to get the list of connections leaving the component.

getConnections() - Method in class discovery.model.ObjectModel

Accessor to get the connections going from this object.

getConnections() - Method in class discovery.model.TaskModel

Accessor method to get the connections leaving this task.

getCurrentNarrativeID() - Method in class discovery.gui.NarrativeScreen

Accessor method to get the ID of the currently displayed narrative.

getDate() - Method in class discovery.model.NarrativeModel

Accessor method to get the date for this narrative.

getDepth() - Method in class discovery.gui.Node

Accessor method to get the depth of this node in the diagram.

getDescription() - Method in class discovery.model.NarrativeModel

Accessor method to get the description for this narrative.

getEndPoint() - Method in class discovery.view.ConnectionView

Accessor method to get the connecting line end point.

getExceptions() - Method in class discovery.model.NarrativeModel

Accessor method to get the exceptions for this narrative.

getID() - Method in class discovery.model.ActorModel

Accessor to get the unique ID number of this actor.

getID() - Method in interface discovery.model.ComponentModel

All component model objects must have an accessor to get the ID number of the component.

getID() - Method in class discovery.model.ConnectionModel

Accessor method to get the unique ID number of this connection.

getID() - Method in class discovery.model.NarrativeModel

Accessor method to get the ID number for this narrative.

getID() - Method in class discovery.model.ObjectModel

Accessor to get the unique ID number of this object.

getID() - Method in class discovery.model.TaskModel

Accessor to get the unique ID number of this task.

getID() - Method in class discovery.view.ActorView

Accessor to get this actor's ID number.

getID() - Method in interface discovery.view.ComponentView

Returns the unique ID number for this diagram component.

getID() - Method in class discovery.view.ConnectionView

Accessor method to get the connection ID

getID() - Method in class discovery.view.EndPointView

Accessor to get the end point's ID.

getID() - Method in class discovery.view.FailPointView

Accessor to get the fail point's ID.

getID() - Method in class discovery.view.ObjectView

Accessor to get this object's ID number.

getID() - Method in class discovery.view.StartPointView

Accessor to get the start point's ID.

getID() - Method in class discovery.view.TaskView

Accessor to get this task's ID number.

getImage() - Method in class discovery.gui.FlowDrawingArea

Converts the graphics on the drawing panel into a BufferedImage object, ready to be exported to an image file.

getImage() - Method in class discovery.gui.NarrativeScreen

Creates a BufferedImage object of the narrative card, ready to export it to an image file.

getImage() - Method in class discovery.gui.StructureDrawingArea

Converts the graphics on the drawing panel into a BufferedImage object, ready to be exported to an image file.

getIndexOfConnectionWith(ComponentView, ComponentView) - Method in class discovery.gui.FlowDrawingArea

Returns the index in the connection list of the connection which connects the given components.

getIndexOfConnectionWith(ComponentView, ComponentView) - Method in class discovery.gui.StructureDrawingArea

Returns the index in the connection list of the connection which connects the given components.

getIntersectionPoint(Line2D.Double, Line2D.Double) - Method in class discovery.gui.DrawingFunctions

Uses matrix algebra to calculate the point of intersection between two lines.

getLabel() - Method in class discovery.view.ActorView

Accessor method to get the actor's label.

getLabel() - Method in interface discovery.view.ComponentView

Returns the label of this diagram component.

getLabel() - Method in class discovery.view.EndPointView

Accessor to get the end point's label.

getLabel() - Method in class discovery.view.FailPointView

Accessor to get the fail point's label.

getLabel() - Method in class discovery.view.ObjectView

Accessor method to get the object's label.

getLabel() - Method in class discovery.view.StartPointView

Accessor to get the start point's label.

getLabel() - Method in class discovery.view.TaskView

Returns this task ellipse's label.

getName() - Method in class discovery.model.ActorModel

Accessor to get the name of this actor.

getName() - Method in interface discovery.model.ComponentModel

All component model objects must have a name accessor.

getName() - Method in class discovery.model.ObjectModel

Accessor to get the name of this object.

getName() - Method in class discovery.model.TaskModel

Accessor method to get the name of this task.

getNarrative(int) - Method in class discovery.data.NarrativeDataManager

This is an accessor method which returns a Narrative object of a narrative in the database.

getNarrative() - Method in class discovery.model.TaskModel

Accessor method to get the narrative for this task.

getNodes(int, int) - Method in class discovery.gui.DiagramLayoutManager

This method returns a list of lists, representing the nodes in each level of a diagram.

getObjects() - Method in class discovery.model.NarrativeModel

Accessor method to get the objects for this narrative.

getParent(int) - Method in class discovery.gui.GUIFunctions

This method finds and returns the parent of the task supplied in the argument.

getParent() - Method in class discovery.gui.Node

Accessor method to get the parent of this node.

getPath() - Method in class discovery.view.ConnectionView

Accessor method to get the path of the connecting line.

getPosition() - Method in class discovery.gui.Node

Accessor method to get the position of this Node.

getPostconditions() - Method in class discovery.model.NarrativeModel

Accessor method to get the postconditions for this narrative.

getPreconditions() - Method in class discovery.model.NarrativeModel

Accessor method to get the preconditions for this narrative.

getProject() - Static method in class discovery.data.Configuration

This method loads the name of the current project from the config file.

getProject() - Method in class discovery.gui.MainScreen

Accessor method to get the name of the currently active project.

getPurpose() - Method in class discovery.model.NarrativeModel

Accessor method to get the purpose for this narrative.

getRelation() - Method in class discovery.model.ConnectionModel

Accessor method to get the type of relationship of this connection.

getRelation() - Method in class discovery.view.ConnectionView

Accessor method to get the relation type.

getStartPoint() - Method in class discovery.view.ConnectionView

Accessor method to get the connecting line start point.

getSubtasks() - Method in class discovery.model.TaskModel

Accessor method to get the list of subtasks for this task.

getTask() - Method in class discovery.gui.Node

Accessor method to get the TaskModel object for this Node.

getTask() - Method in class discovery.model.NarrativeModel

Accessor method to get the associated task's ID number for this narrative.

getType() - Method in class discovery.model.ActorModel

Accessor to get the type of this diagram component.

getType() - Method in interface discovery.model.ComponentModel

All component model objects must have an accessor to get the type of component it is, eg.

getType() - Method in class discovery.model.ObjectModel

Accessor to get the type of this diagram component.

getType() - Method in class discovery.model.TaskModel

Accessor method to get the type of this diagram component.

getType() - Method in class discovery.view.ActorView

Accessor method to get the actor's type.

getType() - Method in interface discovery.view.ComponentView

This returns a String, indicating what type of diagram component the component is.

getType() - Method in class discovery.view.EndPointView

Accessor method to get the end point's type.

getType() - Method in class discovery.view.FailPointView

Accessor method to get the fail point's type.

getType() - Method in class discovery.view.ObjectView

Accessor method to get the object's type.

getType() - Method in class discovery.view.StartPointView

Accessor method to get the start point's type.

getType() - Method in class discovery.view.TaskView

Returns the type of diagram component that this class represents.

getVersion() - Method in class discovery.model.NarrativeModel

Accessor method to get the version of this narrative.

getWorkspace() - Static method in class discovery.data.Configuration

This method loads the current workspace directory from the config file.

GUIFunctions - Class in discovery.gui

This class contains a range of methods that are used by the MainScreen class of the Discovery CASE tool.

GUIFunctions() - Constructor for class discovery.gui.GUIFunctions

H

highlightActor(ActorView, Graphics) - Method in class discovery.gui.DrawingArea

Highlights an actor by filling its head blue.

highlightComponent(ComponentView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Highlights a component by filling it blue.

highlightComponent(ComponentView, Graphics) - Method in class discovery.gui.StructureDrawingArea

Highlights a component by filling it blue.

highlightEndPoint(EndPointView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Highlights an end point by filling it blue.

highlightFailPoint(FailPointView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Highlights a fail point by filling it blue.

highlightStartPoint(StartPointView, Graphics) - Method in class discovery.gui.FlowDrawingArea

Highlights a start point by filling it blue.

I

IDGenerator - Class in discovery.model

This class is responsible for generating unique ID numbers for components, connections and narratives.

IDGenerator() - Constructor for class discovery.model.IDGenerator

increaseHeight(int) - Method in class discovery.gui.Node

Increases the node's bounding box height by the specified amount.

increaseWidth(int) - Method in class discovery.gui.Node

Increases the node's bounding box width by the specified amount.

intersection(Rectangle, Line2D.Double) - Method in class discovery.gui.DrawingFunctions

Calculates the point where a line first intersects a rectangle.

L

layoutDiagram(int, int) - Method in class discovery.gui.DiagramLayoutManager

This method calculates the bounding boxes for all nodes in the task structure diagram with the root task being the task with the supplied ID, to the specified depth.

loadConfig() - Static method in class discovery.data.Configuration

This method uses the SAXBuilder class to construct a Document object of the XML data held within the 'config.xml' file.

loadDatabase() - Method in class discovery.data.ComponentDataManager

This method uses the SAXBuilder class to construct a Document object of the XML data held within the 'components.xml' file.

loadDatabase() - Method in class discovery.data.ConnectionDataManager

This method uses the SAXBuilder class to construct a Document object of the XML data held within the 'connections.xml' file.

loadDatabase() - Method in class discovery.data.NarrativeDataManager

This method uses the SAXBuilder class to construct a Document object of the XML data held within the 'narratives.xml' file.

M

MainScreen - Class in discovery.gui

This class represents the main GUI for the Discovery CASE tool.

MainScreen(int, int) - Constructor for class discovery.gui.MainScreen

The default constructor.

N

nameIsValid(String, String) - Static method in class discovery.model.ConsistencyChecker

Tests whether the supplied name for a diagram component is valid.

NarrativeDataManager - Class in discovery.data

This class is responsible for all program interaction with the narrative database.

NarrativeDataManager() - Constructor for class discovery.data.NarrativeDataManager

NarrativeModel - Class in discovery.model

This class represents a Narrative.

NarrativeModel() - Constructor for class discovery.model.NarrativeModel

This is the empty constructor, which gives the narrative a unique ID number, but leaves all other attributes empty.

NarrativeModel(Integer, Integer, String, String, String, String, String, String, String, String, String, String, String) - Constructor for class discovery.model.NarrativeModel

This constructor supplies all of the narrative's attributes, including the ID number.

NarrativeScreen - Class in discovery.gui

This class describes the screen for the narrative editor.

NarrativeScreen(MainScreen) - Constructor for class discovery.gui.NarrativeScreen

This is the default constructor, which sets up the Narrative card.

Node - Class in discovery.gui

This class represents a Node in a task structure diagram, ie.

Node(TaskModel, int, Node, Rectangle) - Constructor for class discovery.gui.Node

Constructor builds a Node object with the supplied TaskModel and bounds.

O

OBJECT - Static variable in class discovery.gui.FlowDrawingArea

Static integer to represent the panel's object drawing state.

OBJECT - Static variable in class discovery.gui.StructureDrawingArea

Static integer to represent the panel's object drawing state.

OBJECT - Static variable in class discovery.model.NarrativeModel

ObjectModel - Class in discovery.model

This class represents an object in the model.

ObjectModel() - Constructor for class discovery.model.ObjectModel

Creates an ObjectModel instance with null values for its name and connections list.

ObjectModel(Integer, String, ArrayList) - Constructor for class discovery.model.ObjectModel

Creates an ObjectModel instance with the supplied attributes.

ObjectModel(String) - Constructor for class discovery.model.ObjectModel

Creates an ObjectModel instance with the name n.

ObjectView - Class in discovery.view

This class represents the view of an Object.

ObjectView() - Constructor for class discovery.view.ObjectView

The empty constructor, creates an ObjectView object with no label.

ObjectView(String, double, double, double, double, int) - Constructor for class discovery.view.ObjectView

Constructor which specifies the object's label, bounds and the ID of it's corresponding ObjectModel object.

OWNERSHIP - Static variable in class discovery.model.ConnectionModel

Static integer representing an ownership connection type in a connection.

OWNERSHIP - Static variable in class discovery.view.ConnectionView

Static integer representing an ownership connection type in a connection.

P

paintComponent(Graphics) - Method in class discovery.gui.FlowDrawingArea

This method overrides the panel's default paintComponent method.

paintComponent(Graphics) - Method in class discovery.gui.StructureDrawingArea

This method overrides the panel's default paintComponent method.

PARTICIPATION - Static variable in class discovery.model.ConnectionModel

Static integer representing a participation connection type in a connection.

PARTICIPATION - Static variable in class discovery.view.ConnectionView

Static integer representing a participation connection type in a connection.

pop(int) - Static method in class discovery.model.PushPopper

Pops the Narrative with the specified ID, so that it is merged with its parent task.

popup - Variable in class discovery.gui.FlowDrawingArea

print() - Method in class discovery.gui.PrintManager

This method is called by the printComponent method.

print(Graphics, PageFormat, int) - Method in class discovery.gui.PrintManager

This method is required by the Printable interface.

printComponent(Component) - Static method in class discovery.gui.PrintManager

Static method which prints the supplied Swing component.

PrintManager - Class in discovery.gui

This class is responsible for printing out task structure, task flow and narrative diagrams.

PrintManager(Component) - Constructor for class discovery.gui.PrintManager

Constructor which creates a new PrintManager instance with the supplied component.

push(int, String) - Static method in class discovery.model.PushPopper

Pushes the Narrative with the specified ID.

PushPopper - Class in discovery.model

PushPopper() - Constructor for class discovery.model.PushPopper

R

relation - Variable in class discovery.gui.FlowDrawingArea

removeConnection(Integer) - Method in class discovery.model.ActorModel

Mutator method to remove a connection from this ActorModel object's list of connections.

removeConnection(Integer) - Method in interface discovery.model.ComponentModel

This method removes the given connection from the component's list of connections.

removeConnection(Integer) - Method in class discovery.model.ObjectModel

Mutator method to remove a connection from this ObjectModel object's list of connections.

removeConnection(Integer) - Method in class discovery.model.TaskModel

Mutator method to remove a connection from this ActorModel object's list of connections.

removeContent(String, int) - Method in class discovery.model.NarrativeModel

Mutator method to remove some automatically generated content from the narrative.

rename - Variable in class discovery.gui.FlowDrawingArea

repaintArea(Rectangle, Graphics) - Method in class discovery.gui.FlowDrawingArea

Repaints any diagram components within the specified rectangle.

repaintArea(Rectangle, Graphics) - Method in class discovery.gui.StructureDrawingArea

Repaints any diagram components within the specified rectangle.

repaintConnections(Graphics) - Method in class discovery.gui.FlowDrawingArea

Redraws all of the connection lines in the diagram.

repaintConnections(Graphics) - Method in class discovery.gui.StructureDrawingArea

Redraws all of the connection lines in the diagram.

S

saveConfig(Document) - Static method in class discovery.data.Configuration

This method saves the data in a Document object to the XML file 'config.xml'.

saveDatabase(Document) - Method in class discovery.data.ComponentDataManager

This method saves the data in a Document object to the XML file 'components.xml'.

saveDatabase(Document) - Method in class discovery.data.ConnectionDataManager

This method saves the data in a Document object to the XML file 'connections.xml'.

saveDatabase(Document) - Method in class discovery.data.NarrativeDataManager

This method saves the data in a Document object to the XML file 'narratives.xml'.

saveImage(File, BufferedImage) - Method in class discovery.gui.GUIFunctions

Creates a .jpg image of the supplied BufferedImage object, and saves it with the supplied filename.

saveNarrative() - Method in class discovery.gui.NarrativeScreen

Commits the data in the narrative screen to the repository.

search(String) - Method in class discovery.gui.GUIFunctions

Searches the task database for the given string.

selected - Static variable in class discovery.gui.FlowDrawingArea

selected - Static variable in class discovery.gui.StructureDrawingArea

selectedCon - Static variable in class discovery.gui.FlowDrawingArea

selectedCon - Static variable in class discovery.gui.StructureDrawingArea

setActors(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the list of actors for this narrative.

setAsRoot - Variable in class discovery.gui.FlowDrawingArea

setAuthor(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the author of this narrative.

setBounds(Rectangle) - Method in class discovery.gui.Node

Mutator method to set the Node's bounds.

setComponent1(Integer) - Method in class discovery.model.ConnectionModel

Mutator method to set the first (ie.

setComponent2(Integer) - Method in class discovery.model.ConnectionModel

Mutator method to set the second (ie.

setComponentToDraw(int) - Method in class discovery.gui.FlowDrawingArea

setComponentToDraw(int) - Method in class discovery.gui.StructureDrawingArea

Sets the 'toDraw' variable, indicating to the panel that an existing component with the specified ID is to be drawn on the next user's click.

setConcerns(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the concerns field for this narrative.

setConnections(ArrayList) - Method in class discovery.model.ActorModel

Mutator method to set the list of connections leaving this actor.

setConnections(ArrayList) - Method in class discovery.model.ObjectModel

Mutator method to set the list of connections leaving this object.

setConnections(ArrayList) - Method in class discovery.model.TaskModel

Mutator method to set the list of connections leaving this task.

setCurrentNarrativeID(int) - Method in class discovery.gui.NarrativeScreen

Mutator method to set the ID of the currently displayed narrative.

setDate(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the date field for this narrative.

setDeleteEnabled(boolean) - Method in class discovery.gui.MainScreen

Disables the delete button if no diagram component is currently selected.

setDepth(int) - Method in class discovery.gui.Node

Mutator method to set the Node's depth.

setDescription(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the description field for this narrative.

setEndPoint(Point) - Method in class discovery.view.ConnectionView

Mutator method to set the connection's end point.

setExceptions(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the exceptions field for this narrative.

setHeight(int) - Method in class discovery.gui.Node

Mutator method to set the height of the node's bounding box.

setID(Integer) - Method in class discovery.model.ActorModel

Mutator method to set the ID number of this actor model object.

setID(Integer) - Method in class discovery.model.ObjectModel

Mutator method to set the ID number of this object model object.

setID(Integer) - Method in class discovery.model.TaskModel

Mutator method to set the ID number of this task model object.

setID(int) - Method in class discovery.view.ActorView

Mutator method to set this ActorView's ID number to the supplied integer.

setID(int) - Method in class discovery.view.ConnectionView

Mutator method to set the connection's ID.

setID(int) - Method in class discovery.view.ObjectView

Sets this ObjectView's ID number to the supplied integer.

setID(int) - Method in class discovery.view.TaskView

Sets this TaskView's ID number to the supplied integer.

setLabel(String) - Method in class discovery.view.ActorView

Mutator method to set the actor's label.

setLabel(String) - Method in interface discovery.view.ComponentView

Mutator method to set the label of this diagram component.

setLabel(String) - Method in class discovery.view.EndPointView

Must have this method according to the ComponentView interface, but end points are not labelled, so label is always null.

setLabel(String) - Method in class discovery.view.FailPointView

Must have this method according to the ComponentView interface, but fail points are not labelled, so label is always null.

setLabel(String) - Method in class discovery.view.ObjectView

Mutator method to set the object's label.

setLabel(String) - Method in class discovery.view.StartPointView

Must have this method according to the ComponentView interface, but start points are not labelled, so label is always null.

setLabel(String) - Method in class discovery.view.TaskView

Sets this TaskView's label to the String l.

setName(String) - Method in class discovery.model.ActorModel

Mutator method to set the name of this actor model object.

setName(String) - Method in interface discovery.model.ComponentModel

All component model objects must have a name mutator method.

setName(String) - Method in class discovery.model.ObjectModel

Mutator method to set the name of this object model object.

setName(String) - Method in class discovery.model.TaskModel

Mutator method to set the name of this task model object.

setNarrative(Integer) - Method in class discovery.model.TaskModel

Mutator method to set the narrative of the task.

setObjects(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the list of objects for this narrative.

setParent(Node) - Method in class discovery.gui.Node

Mutator method to set the Node's parent node.

setPath(GeneralPath) - Method in class discovery.view.ConnectionView

Mutator method to set the connecting line's path.

setPostconditions(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the postconditions field for this narrative.

setPreconditions(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the preconditions field for this narrative.

setProject(String) - Static method in class discovery.data.Configuration

This method saves the supplied name to the current project element in the config file.

setProject(String) - Method in class discovery.gui.MainScreen

Sets the name of the currently active project, and passes it to the config file.

setPurpose(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the purpose field for this narrative.

setRelation(Integer) - Method in class discovery.model.ConnectionModel

Mutator method to set the type of this connection.

setRelation(int) - Method in class discovery.view.ConnectionView

Mutator method to set the type of relation between the components in the connection.

setSelectedTask(int) - Method in class discovery.gui.MainScreen

Mutator method to change the system's currently selected task.

setStartPoint(Point) - Method in class discovery.view.ConnectionView

Mutator method to set the connection's start point.

setState(int) - Method in class discovery.gui.FlowDrawingArea

Mutator method to change the state of the drawing panel.

setState(int) - Method in class discovery.gui.StructureDrawingArea

Mutator method to change the state of the drawing panel.

setTask(TaskModel) - Method in class discovery.gui.Node

Mutator method to set the Node's task.

setTask(Integer) - Method in class discovery.model.NarrativeModel

Mutator method to set the task that this narrative is associated with.

setupConnection(ComponentView, ComponentView) - Method in class discovery.gui.FlowDrawingArea

Asks the user what type of connection they want to create, and begins creating ConnectionView objects to represent the connection.

setupConnection(ComponentView, ComponentView) - Method in class discovery.gui.StructureDrawingArea

Asks the user what type of connection they want to create, and begins creating ConnectionView objects to represent the connection.

setVersion(String) - Method in class discovery.model.NarrativeModel

Mutator method to set the version of this narrative.

setWidth(int) - Method in class discovery.gui.Node

Mutator method to set the width of the node's bounding box.

setWorkspace(File) - Static method in class discovery.data.Configuration

This method creates the new workspace directory, and saves the supplied workspace directory to the config file.

showList(String, String) - Method in class discovery.gui.MainScreen

When the task, object or actor button is clicked on the palette, this method builds and displays the list of existing components of that type.

snapToPoint(int, int) - Method in class discovery.gui.DrawingFunctions

Given coordinates, finds and returns the nearest point with coordinates that are multiples of 20.

START - Static variable in class discovery.gui.FlowDrawingArea

Static integer to represent the panel's start state.

START - Static variable in class discovery.gui.StructureDrawingArea

Static integer to represent the panel's start state.

STARTPOINT - Static variable in class discovery.gui.FlowDrawingArea

Static integer to represent the panel's startpoint drawing state.

StartPointView - Class in discovery.view

This class represents the view of a Start Point.

StartPointView() - Constructor for class discovery.view.StartPointView

The empty constructor, creates a StartPointView object with no label.

StartPointView(double, double, double, double) - Constructor for class discovery.view.StartPointView

A constructor which specifies the bounds of the start point

StructureDrawingArea - Class in discovery.gui

This class represents the drawing panel where Task Structure diagrams are drawn.

StructureDrawingArea(int, int, int, int, MainScreen) - Constructor for class discovery.gui.StructureDrawingArea

Constructor, which sets up the drawing panel and initializes all of the variables required.

T

TASK - Static variable in class discovery.gui.FlowDrawingArea

Static integer to represent the panel's task drawing state.

TASK - Static variable in class discovery.gui.StructureDrawingArea

Static integer to represent the panel's task drawing state.

TaskListScreen - Class in discovery.gui

TaskListScreen() - Constructor for class discovery.gui.TaskListScreen

TaskModel - Class in discovery.model

This class represents a task in the model.

TaskModel() - Constructor for class discovery.model.TaskModel

Creates a TaskModel instance with null values for its name, connections list and narrative.

TaskModel(String) - Constructor for class discovery.model.TaskModel

Creates a TaskModel instance with the name n.

TaskModel(Integer, String, ArrayList, Integer) - Constructor for class discovery.model.TaskModel

Creates a TaskModel instance with the supplied attributes.

TaskView - Class in discovery.view

TaskView represents the view of a task ellipse diagram component.

TaskView() - Constructor for class discovery.view.TaskView

Constructs a new TaskView object, initialized to location (0,0) and size (0,0), with no label.

TaskView(String, double, double, double, double, int) - Constructor for class discovery.view.TaskView

Constructs a new TaskView object, initialized to location (x,y) with size (w,h) and label l.

U

updateComponent(ComponentModel) - Method in class discovery.data.ComponentDataManager

This is a mutator method which updates a component in the XML file.

updateConnection(ConnectionModel) - Method in class discovery.data.ConnectionDataManager

This is a mutator method which updates a connection in the XML file.

updateConnectionsFrom(ComponentView, int) - Method in class discovery.gui.StructureDrawingArea

Changes all connections from the given component to the specified type.

updateNarrative(NarrativeModel) - Method in class discovery.data.NarrativeDataManager

This is a mutator method which updates a narrative in the XML file.

V

validateProjectName(String) - Method in class discovery.gui.GUIFunctions

This method ensures that the supplied project name isn't the empty string, and doesn't contain any characters that cannot be used in a directory name, ie: \ / : * ? " | < >

A C D E F G H I L M N O P R S T U V