Package com.togethersoft.openapi.rwi

See
          Description

Class Diagram Summary
rwi

 

Interface Summary
RwiContainer	A top-level representative of a container of elements.
RwiDiagram	RwiDiagram is a set of RwiReference derivatives referencing the model's elements.
RwiDiagramPositions
RwiDiagramReference	A reference to a diagram
RwiElement	RwiElement is the generic representative of a model's part (package, node, member, diagram and link).
RwiLanguage	Defines string constants for RwiProperty.LANGUAGE property.
RwiLink	A link between two RwiElements.
RwiLinkPositions	RwiLinkPositions interface.
RwiLinkReference	A reference to a link.
RwiMember	RwiMember represents member-like model elements, for example an operation or an attribute.
RwiMemberPositions
RwiMemberReference	A reference to a member.
RwiModel	RwiModel interface provides a set of starting-point methods for working with the model.
RwiNode	Nodes can contain members and other nodes called subnodes.
RwiNodePositions	RwiNodePositions interface.
RwiNodeReference	A reference to a node.
RwiPackage	RwiPackage contains model's data (nodes, members, diagrams, and other packages) in a directory-like structure.
RwiPattern	Defines string constants used as the names for Together's default patterns.
RwiPositions	RwiPositions interface.
RwiProperty	Represents the element's string property and contains the names and descriptions of hardcoded properties.
RwiPropertyMap	Represents a container for the properties.
RwiReference	RwiReference is a generic type of a reference.
RwiShapeType	Defines string constants for RwiProperty.SHAPE_TYPE property.
RwiVisitor	An implementation of a Visitor pattern from GoF "Design Patterns" book.

 

Class Summary
RwiModelAccess	RwiModelAccess is an abstract class which contains the static getModel method.
RwiVisitorAdapter	RwiVisitorAdapter class extends RwiVisitor functionality by providing two additional methods visitContainer and visitElement.

 

Package com.togethersoft.openapi.rwi Description

Provides a set of interfaces representing the model consisting not only of the source code (like SCI model) but also of various diagrams (class diagram, use diagrams etc), links, notes, etc., allowing to access and change these elements.

RWI model is a combination of five different entities: packages, nodes, members, diagrams and links.

Packages.

The RWI model is a tree-like data structure in which data is stored in special data containers - packages. The model can have one or more packages called root packages which are at the top of this tree structure. Every package contains other parts of the model- nodes and diagrams, and other packages called subpackages.

Nodes and members.

Nodes can contain members and other nodes called subnodes. Examples of nodes are classes, use cases, states.
Members keep node's data and usually represent member-like elements. Examples of members are operations and attributes for a class.

Diagrams.

Diagram is a set of references to the model's elements. Examples of diagrams are class diagrams, use case diagrams, sequence diagrams, collaboration diagrams.

Links.

Links are used to represent dependencies between elements described above.

Packages, nodes, members, diagrams and links are derivatives of RwiElement - the most generalized element of the model. Every element has a set of characteristics called properties. These properties are used to keep element's behavioral and structural data, like name, type, content etc. RwiPropertyMap interface provides a set of methods for accessing and changing the element's properties.

See Also:

com.togethersoft.togetherx.rwi.RwiPropertyMap, com.togethersoft.togetherx.rwi.RwiElement, com.togethersoft.togetherx.rwi.RwiPackage, com.togethersoft.togetherx.rwi.RwiNode, com.togethersoft.togetherx.rwi.RwiMember, com.togethersoft.togetherx.rwi.RwiDiagram, com.togethersoft.togetherx.rwi.RwiLink, com.togethersoft.togetherx.rwi.RwiReference