4.2 Data Decomposition

The following classes hold the major data types used throughout SAM.

4.2.1 Field

Description:

A Field is a named data type stored in Tables. Each different Field is uniquely identifiable.

Responsibilities:

This class is responsible for

1. Storing (and returning when asked) the field's name.
2. Storing (and returning when asked) the field's ID number.
3. Storing (and returning when asked) whether the field is able to be selected per stream only, or whether it can be selected with multiple streams.
4. Storing (and having an ability to set) whether or not the stream is selected on screen.

5. Returning whether the field is the ``Stream'' data type.
6. Returning whether the field is the ``Time'' data type.
7. Returning whether the field is an IP or TCP field.

SRS References:

3.2.1.2, 3.2.1.9, 5.2.3

4.2.2 Stream

Description:

A Stream is a data connection between a source host and a destination host. It is uniquely identified by the source IP address, source port, destination IP address and destination port.

Responsibilities:

This class is responsible for

1. Storing the source IP address, source port, destination IP address and destination port of the stream.
2. Storing (and returning when asked) the stream's name (in an understandable form as a string, either an IP address or domain name).
3. Storing (and returning when asked) the stream's ID number.
4. Storing (and having an ability to set) whether or not the stream is selected on screen.
5. Returning whether the stream is an aggregate stream.

SRS References:

3.2.1.5, 5.2.3

4.2.3 Table

Description:

The basic unit of data storage; a set of points which can either be graphed or transformed by an analysis.

Responsibilities:

This class is responsible for

1. Storing (and returning when asked), for each stream, the array of data corresponding to the stream, plus the labels for the array's columns, and whether the stream is the aggregate stream.
2. Creating a single array which combines together all the data for all streams stored in the class.

SRS References:

3.2.1.5, 3.2.1.6, 3.2.1.8

4.2.4 Plugin

Description:

Holds all the information about a particular Plugin, which can be either an analysis or output plugin.

Responsibilities:

This class is responsible for

1. Storing (and returning when asked) the plugin's name (as to be displayed to the user).
2. Storing (and returning when asked) the plugin's type (analysis or output).
3. Storing (and returning when asked) the plugin's ID number.
4. Storing (and having an ability to set) whether or not the plugin is selected on screen.

5. Having a method which allows plugin objects to be run.

SRS References:

3.2.1.8, 4.3.3.2, 5.2.3