SCRAML Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
Client.AboutThe About dialog - shown from MainWindow's About menu item, and when you click the What is... link on the Login dialog
Client.BibExporterThis interface is to be implemented by all bibliography generator classes
Client.BibliographyExporterClass which takes care of exporting biblipgraphies..
Client.BibTeXItemA BibTeX bibliography item
Client.CreateSuggestionLists literature, and lets the suggester enter a reason for suggesting it
Client.ExporterBibTeXThe BibTeX exporter class
Client.ExporterEndNoteExport bibliographies to EndNote format (proprietary format used by the EndNote program by Thomson ISI ResearchSoft - http://www.endnote.com/ )
Client.ExporterRTFExport bibliographies to RTF (Rich Text Format)
Client.ExporterXHTMLExports bibliographies to XHTML
Client.GetAUserLet the user select a single user from a list of users using only usernames (currently at least)
Client.LiteratureEntryViewWhat shows the user data about literature entries, and allows them to edit that data
Client.LocalSettingsManages settings for the local program. Adding new settings are done by adding the property, adding it to the lists in the constructor and to SaveSettings() Defaults are set at the end of the constructor - the false section of the shorthand conditional statement TODO: Make a prettier way to define default settings!
Client.LoginThe first form shown to the user
Client.LoginConfigThe form used for presenting the user with options pertaining to connection - server and host
Client.MainWindowThe program's main interface. The start point for all activities in the system
Client.MainWindow.PreviousSearch
Client.ProjectViewWhat shows the user data about projects, and allows them to edit that data
Client.Properties.ResourcesA strongly-typed resource class, for looking up localized strings, etc
Client.Properties.Settings
Client.ReconnectHandler
Client.ReferenceCreate a new reference to a piece of literature
Client.ReviewAndCommentsView
Client.RMIClientThe client part of the RMI system
Client.StartupThis is where it all starts - spawns the client's first window, namely the Login window
Client.UserFormUsed for both creating and editing user information
CommentControls.CommentControlThe Comment handling control. Used for showing a single comment to the user
CommentControls.CommentControlEventArgsAn implementation of EventArgs which is used to generate events for the CommentControl control
CommentControls.CommentsContainerThe CommentsContainer control. Used to manage a collection of threaded comments Create the control and drop it on a form, then fill it up with a whole bunch of comments. Catch the event CommentsChanged, which is fired when the collection of comments contained in the control has been changed
CommentControls.CommentsContainerEventArgsAn implementation of EventArgs which is used to generate events for the CommentsContainer control
CommentControls.WorkingCommentControlThe comment control which is actually used in the system Simpler and less abstract than the one envisioned in the CommentContainer system, this one actually works. We need working code. Thankyouverymuch
Server.CatalogueThe Catalogue class contains the actual model of the system. It contains all functionality needed by both the AccessHandler class and the server-side console
Server.Catalogue.SearchResultComparer
Server.Catalogue.TagComparer
Server.CommentThis class represents a single comment to a review, parent or another comment. A Comment inherits from the abstract UniquelyIdentifiable class, to ensure it can be retrieved again
Server.Data.BinaryDataSaves a DataContainer in a set of binary files
Server.Data.DataContainerContains datastructures that contain the model of the system
Server.Data.DummyDataA dummy class that does not save or load data. It is used for unit-testing purpose
Server.Data.IPersistentDataThis abstract class works as an abstraction over the IPersistentData layer. The IPersistentData has the same interface no matter which type of data storage is implemented below it
Server.Data.XmlDataA simple non-generic class for loading and saving data into XML-files. The class inherits from the abstract class IPersistentData which implements methods for loading and saving
Server.Literature
Server.MyWin32
Server.Net.RMIAccessHandlerThis class contains an implemention of an AccessHandler. In this case it is used for Remote Method Invocation. The objective of the AccessHandler is to handle the communication between the client and the catalogue. It inherits from the class MarshalByRefObject which enables the class to be accessed via network. It also inherits from the IAccessHandler interface which defines the public methods in the Catalogue class
Server.Net.RMIServerThis class represents the server-side part of a RMI-connection. It inherits from the ServerAPI interface which ensures exchangeability
Server.PersonThis class represents a person in the system. A person has a username and a password for accessing the system
Server.ProjectThis class represents a project. It stores information about members, references and generel details about the project
Server.ReferenceThe class represents a reference to a parent object. A reference holds a list of added comments
Server.ReviewThe class represents a review. A review inherits from Reference, which 'connects' a project and a piece of parent
Server.RoleThis class represents a given users role in a project
Server.ServerConsoleThe class runs a small console used for interacting with the catalogue object while the server is running
Server.StartupThis class is the starting point of the server. It contains the Main method, which initializes IPersistentData and the Catalogue. It also runs a server-side console for executing various commands
Server.SuggestionA Suggestion is a Reference created by a Supervisor. It defines a Suggestion to the project group to investigate a piece of Literature and contains a reason for it
Server.Test.BinaryDataTestAn NUnit test class for testing the BinaryDatabase implementation of IPersistentData
Server.Test.CatalogueTestTests the Catalogue class. It's a blackbox test
Server.Test.PersistentDataTestContains helper functions for testing of PersistentData implementations
Server.Test.WhiteBoxTestingTests the Catalogue.Search function using whitebox testing
Server.Test.XmlDataTestAn NUnit test class for testing the XMLDatabase implementation of IPersistentData. This class is not entirely done
Server.UniquelyIdentifiableAn abstract class used for assigning unique ID's to inherieted objects. The class contains a private static integer variable which represents the ID next to be assigned
Shared.CoffeeThis thing makes coffee!
Shared.CommentInfoContains data about a Comment object. Used in network transmissions and representation on PersistentData
Shared.IAccessHandlerThis interface makes it possible to create an accesshandler. it is used for creating e.g. the RMI-AccessHandler
Shared.ISearchableProvides common descriptions for information which can be searched upon
Shared.IServerAPIThis interface describes the ServerAPI
Shared.LiteratureInfoContains data about a Litterature object. Used in network transmissions and representation on PersistentData
Shared.PersonInfoContains data about a Person object. Used in network transmissions and representation on PersistentData
Shared.ProjectInfoContains data about a Project. Used in network transmissions and representation on PersistentData
Shared.PublicObjectThis class represents an object designed to be accessed from both client and server
Shared.ReferenceInfoContains data about a Reference object. Used in network transmissions and representation on PersistentData
Shared.ReviewInfoContains data about a Review object. Used in network transmissions and representation on PersistentData
Shared.RoleInfoContains data about a Role object. Used in network transmissions and representation on PersistentData
Shared.SearchResultContains information about a result of a Search function, also contains the found object as a variable
Shared.StatisticsInfoContains information about the amount of content in the catalogue system
Shared.SuggestionInfoContains data about a Suggestion object. Used in network transmissions and representation on PersistentData
Shared.TagInfoContains data about a Tag object. Used in network transmissions and representation on PersistentData
Shared.UtilsThe class contains static methods for various purposes
SimpleControls.DoingStuffThe DoingStuff control, which very simply shows a small, rotating throbber
SimpleControls.PleaseWaitA control which simply shows the text "Please wait..." and a rotating throbber which is simply an instance of DoingStuff
SimpleControls.Properties.ResourcesA strongly-typed resource class, for looking up localized strings, etc
TagControls.Properties.ResourcesA strongly-typed resource class, for looking up localized strings, etc
TagControls.SorterThis class containt different sorting functions there can be used on the tags
TagControls.TagCloudThe tag cloud control, which is used to show a weighted list of keywords to the user
TagControls.TagCloudEventArgsAn implementation of EventArgs which is used to generate events for the TagCloud control
TagControls.TagContainerThe TagContainer control, which is used to edit the tags for an item with a UniquelyIdentifiable ID Make sure to actually add ID, Username and Tags to the control! Otherwise it has nothing to handle
TagControls.TagContainerEventArgsAn implementation of EventArgs which is used to generate events for the TagContainer control
TagControls.TagControleThe TagControle class, is used to draw the tags themseles. A tag is made up by: The tag word +/- label user to add or remove tags 4 black lines forming a hollow black rectangle A rectangle status bar whith a texture, indicating in % how much the tag is used A white rectangle filling the rest of the status bar if the status bar is not a 100% and a background
TagControls.TagsInfoThis is used to sort the tags in

Generated on Thu Dec 21 06:21:57 2006 for SCRAML by  doxygen 1.5.1-p1