CouplingManager (Simbrain API)

java.lang.Object
- org.simbrain.workspace.CouplingManager

```
public class CouplingManager
extends java.lang.Object
```
Manages all the couplings for a Workspace instance.

Author:

Matt Watson, Jeff Yoshimi

See Also:

Coupling

Constructor Summary

Constructors
Constructor and Description

CouplingManager(Workspace workspace)
Construct a coupling manager.

Constructors
Constructor and Description
`CouplingManager(Workspace workspace)` Construct a coupling manager.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCoupling(Coupling<?> coupling)` Adds a coupling to this instance.
`void`	`addCouplingListener(CouplingListener listener)` Adds a new listener to be updated when changes are made.
`void`	`clearCouplings()` Clear all couplings.
`boolean`	`containseEquivalentCoupling(Coupling<?> toCheck)` Returns whether the coupling is referenced by this manager.
`static java.awt.Color`	`getColor(java.lang.Class<?> dataType)` Associates attribute and coupling data types (classes) with colors used in displaying attributes and couplings.
`java.util.Collection<? extends Coupling<?>>`	`getCouplings()` Returns an unmodifiable list of all the couplings.
`java.util.Collection<? extends Coupling<?>>`	`getCouplings(WorkspaceComponent sourceComponent, WorkspaceComponent targetComponent)` Returns all couplings from the given source component to the given target component.
`int`	`getPriority()` Get the priority.
`static java.lang.String`	`getTypeDescriptor(java.lang.Class<?> dataType)` Associates attribute and coupling data types (classes) with text descriptions used in displaying attributes.
`void`	`removeAttachedCouplings(Attribute attribute)` Removes all couplings associated with a producer or consumer.
`void`	`removeCoupling(Coupling<?> coupling)` Removes a coupling from the manager.
`void`	`removeCouplingListener(CouplingListener listener)` Removes the listener from the list.
`void`	`removeCouplings(java.util.ArrayList<Coupling<?>> couplings)` Remove a specified list of couplings.
`void`	`removeCouplings(WorkspaceComponent component)` Remove all couplings associated with a WorkspaceComponent.
`void`	`removeMatchingCoupling(Coupling<?> toRemove)` Remove coupling (if any) that is essentially a copy of the supplied coupling.
`void`	`replaceCouplings(Attribute oldAttr, Attribute newAttr)` Replaces any couplings where the old attribute is the source or target with a new coupling with the new attribute in the source and/or target.
`void`	`setPriority(int value)` Set the priority.
`void`	`updateAllCouplings()` Updates all couplings in the workspace.
`void`	`updateCouplings(java.util.List<Coupling<?>> couplingList)` Convenience method for updating a set of couplings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CouplingManager
```
public CouplingManager(Workspace workspace)
```
    Construct a coupling manager.
    
    Parameters:
    
    workspace - workspace reference
- Method Detail
  - getCouplings
```
public java.util.Collection<? extends Coupling<?>> getCouplings()
```
    Returns an unmodifiable list of all the couplings.
    
    Returns:
    
    An unmodifiable list of all the couplings.
  - clearCouplings
```
public void clearCouplings()
```
    Clear all couplings.
  - getCouplings
```
public java.util.Collection<? extends Coupling<?>> getCouplings(WorkspaceComponent sourceComponent,
                                                                WorkspaceComponent targetComponent)
```
    Returns all couplings from the given source component to the given target component.
    
    Parameters:
    
    sourceComponent - The source component to use in the search.
    
    targetComponent - The target component to use in the search.
    
    Returns:
    
    A list of the couplings between the provided source and target.
  - updateAllCouplings
```
public void updateAllCouplings()
```
    Updates all couplings in the workspace.
  - removeAttachedCouplings
```
public void removeAttachedCouplings(Attribute attribute)
```
    Removes all couplings associated with a producer or consumer.
    
    Parameters:
    
    attribute - consumer or producer.
  - containseEquivalentCoupling
```
public boolean containseEquivalentCoupling(Coupling<?> toCheck)
```
    Returns whether the coupling is referenced by this manager.
    
    Parameters:
    
    toCheck - The coupling to search for.
    
    Returns:
    
    whether the coupling is referenced by this manager.
  - removeMatchingCoupling
```
public void removeMatchingCoupling(Coupling<?> toRemove)
```
    Remove coupling (if any) that is essentially a copy of the supplied coupling.
    
    Parameters:
    
    toRemove - the coupling type to remove
  - addCoupling
```
public void addCoupling(Coupling<?> coupling)
                 throws UmatchedAttributesException
```
    Adds a coupling to this instance.
    
    Parameters:
    
    coupling - The coupling to add.
    
    Throws:
    
    UmatchedAttributesException - thrown if the attributes in this coupling have mismatched data types
  - replaceCouplings
```
public void replaceCouplings(Attribute oldAttr,
                             Attribute newAttr)
```
    Replaces any couplings where the old attribute is the source or target with a new coupling with the new attribute in the source and/or target.
    
    Parameters:
    
    oldAttr - the attribute to be replaced.
    
    newAttr - the attribute to replace it with.
  - removeCouplings
```
public void removeCouplings(WorkspaceComponent component)
```
    Remove all couplings associated with a WorkspaceComponent.
    
    Parameters:
    
    component - component to check.
  - removeCouplings
```
public void removeCouplings(java.util.ArrayList<Coupling<?>> couplings)
```
    Remove a specified list of couplings.
    
    Parameters:
    
    couplings - list of couplings to remove
  - removeCoupling
```
public void removeCoupling(Coupling<?> coupling)
```
    Removes a coupling from the manager.
    
    Parameters:
    
    coupling - The coupling to remove.
  - getPriority
```
public int getPriority()
```
    Get the priority. Used to set updating of couplings to a specific priority when managing custom workspace update.
    
    Returns:
    
    priority for the coupling manager.
  - setPriority
```
public void setPriority(int value)
```
    Set the priority.
    
    Parameters:
    
    value - the priority to set
  - addCouplingListener
```
public void addCouplingListener(CouplingListener listener)
```
    Adds a new listener to be updated when changes are made.
    
    Parameters:
    
    listener - to be updated of changes
  - removeCouplingListener
```
public void removeCouplingListener(CouplingListener listener)
```
    Removes the listener from the list.
    
    Parameters:
    
    listener - to be removed
  - updateCouplings
```
public void updateCouplings(java.util.List<Coupling<?>> couplingList)
```
    Convenience method for updating a set of couplings.
    
    Parameters:
    
    couplingList - the list of couplings to be updated
  - getColor
```
public static java.awt.Color getColor(java.lang.Class<?> dataType)
```
    Associates attribute and coupling data types (classes) with colors used in displaying attributes and couplings.
    
    Parameters:
    
    dataType - the data type to associate with a color
    
    Returns:
    
    the color associated with a data type
  - getTypeDescriptor
```
public static java.lang.String getTypeDescriptor(java.lang.Class<?> dataType)
```
    Associates attribute and coupling data types (classes) with text descriptions used in displaying attributes.
    
    Parameters:
    
    dataType - the data type to associate with a description
    
    Returns:
    
    the text description of the data type

Class CouplingManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CouplingManager

Method Detail

getCouplings

clearCouplings

getCouplings

updateAllCouplings

removeAttachedCouplings

containseEquivalentCoupling

removeMatchingCoupling

addCoupling

replaceCouplings

removeCouplings

removeCouplings

removeCoupling

getPriority

setPriority

addCouplingListener

removeCouplingListener

updateCouplings

getColor

getTypeDescriptor