venice
Interface VInterface

All Superinterfaces:
VModelElement
All Known Implementing Classes:
ZInterface

public interface VInterface
extends VModelElement

VInterface represents an interface in the software architecture

Interface has operations and a type and it can be visualized in two different modes: either as a circle or like class

Author:
Hannu Laurila, Antti Pietarinen

Field Summary
static int TYPE_OFFERED
          a constant describing that this interface is an offered interface
static int TYPE_REQUIRED
          a constant describing that this interface is a required interface
static int VIEWMODE_CIRCLE
          a constant: mode when interface is visualized as a circle
static int VIEWMODE_EXPANDED
          a constant: mode when interface is visualized like class
 
Method Summary
 void addSubsDeps(VModelElement inElement)
          Add inElement to list of dependencies that are greated to substitute this interface.
 void clearHiddenRelationships()
          Clear list of hidden relationship.
 java.util.LinkedList getHiddenRelationships()
          Get content of hidden relationships.
 int getInterfaceType()
          returns the type of interface (offered or required)
 java.lang.Object[] getOperations()
          returns the array which contains the operations in this interface.
 java.util.LinkedList getSubsDeps()
          Get content of substitute dependency list.
 int getViewMode()
          returns the current view mode of the interface.
 void removeSubsDeps()
          Clear substitute dependency list.
 void setHiddenRelationships(VModelElement inElement)
          Set inElement to hidden relationships list.
 void setInterfaceType(int inType)
          sets the type of the interface (offered or required).
 void setOperations(java.lang.Object[] inOps)
          sets the operations of the interface.
 void setViewMode(int inMode)
          sets the view mode of the interface.
 
Methods inherited from interface venice.VModelElement
addRelationship, addToCompositeRelationshipList, debugDump, getCompositeRelationships, getId, getName, getRelationshipConnectPoint, getRelationships, getType, getVisible, getVParent, intersectWithLine, setName, setType, setVisible
 

Field Detail

TYPE_OFFERED

public static final int TYPE_OFFERED
a constant describing that this interface is an offered interface

TYPE_REQUIRED

public static final int TYPE_REQUIRED
a constant describing that this interface is a required interface

VIEWMODE_CIRCLE

public static final int VIEWMODE_CIRCLE
a constant: mode when interface is visualized as a circle

VIEWMODE_EXPANDED

public static final int VIEWMODE_EXPANDED
a constant: mode when interface is visualized like class
Method Detail

setHiddenRelationships

public void setHiddenRelationships(VModelElement inElement)
Set inElement to hidden relationships list.

getHiddenRelationships

public java.util.LinkedList getHiddenRelationships()
Get content of hidden relationships.

clearHiddenRelationships

public void clearHiddenRelationships()
Clear list of hidden relationship.

addSubsDeps

public void addSubsDeps(VModelElement inElement)
Add inElement to list of dependencies that are greated to substitute this interface.

getSubsDeps

public java.util.LinkedList getSubsDeps()
Get content of substitute dependency list.

removeSubsDeps

public void removeSubsDeps()
Clear substitute dependency list.

getInterfaceType

public int getInterfaceType()
returns the type of interface (offered or required)
Returns:
one of TYPE_ constants

getOperations

public java.lang.Object[] getOperations()
returns the array which contains the operations in this interface.

The array has been given to VInterface using setOperations method. See setOperations method description for information on the array content


getViewMode

public int getViewMode()
returns the current view mode of the interface.
Returns:
one of VIEWMODE_ constants

setInterfaceType

public void setInterfaceType(int inType)
sets the type of the interface (offered or required). The type affects the way how the interface is visualized. An offered interface is visualised as a filled circle and a required interface is visualized as an empty circle

setOperations

public void setOperations(java.lang.Object[] inOps)
sets the operations of the interface.

The operations are shown when the interface is visualized in expanded mode.

Parameters:
inOps - the array of objects representing the operations of the interface. The objects toString() method is used to get string representation of the operations

setViewMode

public void setViewMode(int inMode)
sets the view mode of the interface.
Parameters:
inMode - one of VIEWMODE_ constants