org.scribble.protocol.model
Class ProtocolModel

java.lang.Object
  extended by org.scribble.protocol.model.ModelObject
      extended by org.scribble.protocol.model.ProtocolModel

public class ProtocolModel
extends ModelObject

This class represents the base class for models associated with specific notations. The details associated with the notation are contained within derived classes.


Constructor Summary
ProtocolModel()
          The default constructor for the model.
 
Method Summary
 List<ImportList> getImports()
          This method returns the list of import definitions.
 Protocol getProtocol()
          This method returns the definition associated with this model.
 List<Role> getRoles()
          This method returns the distinct list of roles defined in the protocol and its nested-protocols.
 boolean isLocated()
          This method determines whether the model is located.
 void setProtocol(Protocol defn)
          This method set the definition associated with the model.
 void visit(Visitor visitor)
          This method visits the model object using the supplied visitor.
 
Methods inherited from class org.scribble.protocol.model.ModelObject
derivedFrom, getAnnotations, getModel, getParent, getProperties, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProtocolModel

public ProtocolModel()
The default constructor for the model.

Method Detail

getImports

public List<ImportList> getImports()
This method returns the list of import definitions.

Returns:
The import definitions

getProtocol

public Protocol getProtocol()
This method returns the definition associated with this model.

Returns:
The definition

setProtocol

public void setProtocol(Protocol defn)
This method set the definition associated with the model.

Parameters:
defn - The definition

isLocated

public boolean isLocated()
This method determines whether the model is located.

Returns:
Whether the model is located

getRoles

public List<Role> getRoles()
This method returns the distinct list of roles defined in the protocol and its nested-protocols.

Returns:
The list of projectable roles

visit

public void visit(Visitor visitor)
This method visits the model object using the supplied visitor.

Specified by:
visit in class ModelObject
Parameters:
visitor - The visitor


Copyright © 2008-Present Scribble.org. All Rights Reserved.