LayeredAssociation (Wandora

java.lang.Object
- org.wandora.topicmap.layered.LayeredAssociation

All Implemented Interfaces:

Association
```
public class LayeredAssociation
extends java.lang.Object
implements Association
```
Unlike LayeredTopic, LayeredAssociation is not a collection of individual associations of different layers. Of course it can still be treated like this but the implementation does not keep a collection of associations the way LayeredTopic does. Instead the association simply has a LayeredTopic for association type and a map that maps roles to players, both LayeredTopics. Whenever LayeredAssociation is being modified an association of the selected layer that matches this layered association needs to be searched for. If such an association is found, it can be used for the modification. Finding the matching association is made difficult by the fact that role topics of an individual association may have merged. In this case two (or more) roles are showing as only one role in LayeredAssociation. Although these kind of topic merges might be rare, they are still possible and may have clever practical uses. In cases where role topics have merged, several LayeredAssociations are created in the layer stack, one for each possible combination of roles. For example, suppose that an association has roles named 1,2,3 and 4 with players A,B,C and D respectively. Suppose that in the layer stack roles 1 and 2 merge and roles 3 and 4 merge. Then the individual association is showing as four associations in the layer stack. (1:A,3:C), (1:B,3:C), (1:A,3:D) and (1:B,3:D). Each of these (and only these) matches the individual association. Editing any of them will affect all of the LayeredAssociations because they all originate from the same association.

Author:

olli

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Integer`	`hashCode`
`protected LayerStack`	`layerStack`
`protected KeyedHashMap<LayeredTopic,LayeredTopic>`	`players`
`protected LayeredTopic`	`type`

Constructor Summary

Constructors
Constructor and Description

LayeredAssociation(LayerStack layerStack, LayeredTopic type)
Creates a new instance of LayeredAssociation

Constructors
Constructor and Description
`LayeredAssociation(LayerStack layerStack, LayeredTopic type)` Creates a new instance of LayeredAssociation

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`addLayeredPlayer(LayeredTopic player, LayeredTopic role)` Adds a player to this LayeredAssociation object.
`void`	`addPlayer(Topic player, Topic role)` Adds a player to the association and modifies the appropriate individual association accordingly.
`void`	`addPlayers(java.util.Map<Topic,Topic> players)` Adds players to the association.
`protected void`	`ambiguity(java.lang.String s)`
`boolean`	`associationMatchesThis(Association a)` Checks if the given non layered association matches this association.
`boolean`	`equals(java.lang.Object o)`
`Association`	`findAssociationForLayer(Layer l)` Finds an association in the given layer that matches this LayredAssociation.
`Association`	`findAssociationForSelectedLayer()`
`java.util.Collection<Association>`	`findAssociationsForLayer(Layer l)` Finds all associations in the given layer that match this LayeredAssociation.
`Topic`	`getPlayer(Topic role)` Gets the player with the specified role.
`java.util.Collection<Topic>`	`getRoles()` Gets a Collection of Topics containing the roles of this association.
`TopicMap`	`getTopicMap()` Gets the topic map this association belongs to.
`Topic`	`getType()` Gets the type of this association.
`int`	`hashCode()`
`boolean`	`isRemoved()` Tests if this association has been removed and thus this object is now invalid.
`void`	`remove()` Removes this association.
`void`	`removePlayer(Topic role)` Removes the player with the specified role.
`void`	`setType(Topic t)` Sets the type of this association replacing the previous type.

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

- Field Detail
  - type
```
protected LayeredTopic type
```
  - layerStack
```
protected LayerStack layerStack
```
  - players
```
protected KeyedHashMap<LayeredTopic,LayeredTopic> players
```
  - hashCode
```
private java.lang.Integer hashCode
```
- Constructor Detail
  - LayeredAssociation
```
public LayeredAssociation(LayerStack layerStack,
                          LayeredTopic type)
```
    Creates a new instance of LayeredAssociation
- Method Detail
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - ambiguity
```
protected void ambiguity(java.lang.String s)
```
  - getType
```
public Topic getType()
```
    Description copied from interface: Association
    
    Gets the type of this association.
    
    Specified by:
    
    getType in interface Association
  - setType
```
public void setType(Topic t)
             throws TopicMapException
```
    Description copied from interface: Association
    
    Sets the type of this association replacing the previous type.
    
    Specified by:
    
    setType in interface Association
    
    Throws:
    
    TopicMapException
  - getPlayer
```
public Topic getPlayer(Topic role)
```
    Description copied from interface: Association
    
    Gets the player with the specified role.
    
    Specified by:
    
    getPlayer in interface Association
  - associationMatchesThis
```
public boolean associationMatchesThis(Association a)
                               throws TopicMapException
```
    Checks if the given non layered association matches this association.
    
    Throws:
    
    TopicMapException
  - findAssociationForLayer
```
public Association findAssociationForLayer(Layer l)
                                    throws TopicMapException
```
    Finds an association in the given layer that matches this LayredAssociation. Returns null if no such association is found.
    
    Throws:
    
    TopicMapException
  - findAssociationsForLayer
```
public java.util.Collection<Association> findAssociationsForLayer(Layer l)
                                                           throws TopicMapException
```
    Finds all associations in the given layer that match this LayeredAssociation.
    
    Throws:
    
    TopicMapException
  - findAssociationForSelectedLayer
```
public Association findAssociationForSelectedLayer()
                                            throws TopicMapException
```
    Throws:
    
    TopicMapException
  - addLayeredPlayer
```
void addLayeredPlayer(LayeredTopic player,
                      LayeredTopic role)
```
    Adds a player to this LayeredAssociation object. Does not actually modify the association, this method is used to construct LayeredAssociation objects that will later be returned outside the topic map implementation when they are fully constructed.
  - addPlayer
```
public void addPlayer(Topic player,
                      Topic role)
               throws TopicMapException
```
    Adds a player to the association and modifies the appropriate individual association accordingly. Note that if this association isn't already in the selected layer, it will be copied there. Also any roles and players (the ones being added or existing ones) will be copied to the selected layer if they aren't there already.
    
    Specified by:
    
    addPlayer in interface Association
    
    Throws:
    
    TopicMapException
  - addPlayers
```
public void addPlayers(java.util.Map<Topic,Topic> players)
                throws TopicMapException
```
    Description copied from interface: Association
    
    Adds players to the association. Players are given in a map which maps roles to players.
    
    Specified by:
    
    addPlayers in interface Association
    
    Throws:
    
    TopicMapException
  - removePlayer
```
public void removePlayer(Topic role)
                  throws TopicMapException
```
    Description copied from interface: Association
    
    Removes the player with the specified role.
    
    Specified by:
    
    removePlayer in interface Association
    
    Throws:
    
    TopicMapException
  - getRoles
```
public java.util.Collection<Topic> getRoles()
```
    Description copied from interface: Association
    
    Gets a Collection of Topics containing the roles of this association.
    
    Specified by:
    
    getRoles in interface Association
  - getTopicMap
```
public TopicMap getTopicMap()
```
    Description copied from interface: Association
    
    Gets the topic map this association belongs to.
    
    Specified by:
    
    getTopicMap in interface Association
  - remove
```
public void remove()
            throws TopicMapException
```
    Description copied from interface: Association
    
    Removes this association.
    
    Specified by:
    
    remove in interface Association
    
    Throws:
    
    TopicMapException
  - isRemoved
```
public boolean isRemoved()
                  throws TopicMapException
```
    Description copied from interface: Association
    
    Tests if this association has been removed and thus this object is now invalid.
    
    Specified by:
    
    isRemoved in interface Association
    
    Throws:
    
    TopicMapException

Class LayeredAssociation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

layerStack

players

hashCode

Constructor Detail

LayeredAssociation

Method Detail

equals

hashCode

ambiguity

getType

setType

getPlayer

associationMatchesThis

findAssociationForLayer

findAssociationsForLayer

findAssociationForSelectedLayer

addLayeredPlayer

addPlayer

addPlayers

removePlayer

getRoles

getTopicMap

remove

isRemoved