LayerStack (Wandora

java.lang.Object
- org.wandora.topicmap.TopicMap
- - org.wandora.topicmap.layered.ContainerTopicMap
  - - org.wandora.topicmap.layered.LayerStack

All Implemented Interfaces:

TopicMapListener, TopicMapLogger
```
public class LayerStack
extends ContainerTopicMap
implements TopicMapListener
```
LayerStack combines several topic maps (called layers) into one topic map. This has the advantage of being able to hide and show parts of the topic map when necessary and keep different kinds of information apart from each other but still be able to view all the information as a single topic map when needed.
All LayeredTopics consist of a collection of topics from all layers. The collection may contain any number of topics for any layer. All methods in LayerStack, LayeredTopic and LayeredAssociation always return layered objects instead of the objects of different layers except for the method where it is specifically stated that return value consists of individual topics. Also all methods expect to receive their parameters as Layered objects instead of objects of individual layers except when something else is specifically stated.
LayerStack has some requirements about the behavior of equals and hashCode methods. Objects representing the same topic in the topic map must be equal when checked with the equals method. Also, the hashCode of of a topic must not change after the creation of the topic. One way to achieve this is to use the default equals and hashCode methods and at any time have at most one object for each topic in the topic map. LayerStack itself doesn't meet these requirements, hashCode of topics will change when the set of topics it contains changes, and thus you cannot use LayerStacks as layers in another LayerStack.
Note:
TopicMapListeners work a bit different in LayerStack than other TopicMap implementations. Listeners may get changed events even when nothing that is visible using TopicMap interface methods has changed. For example changing a variant name in any layer will cause topicVariantNameChanged event even if another layer overrides the name. Also changes to subject identifiers may cause complex merge or split operations which are reported as a single (or in some cases a few) events.

Author:

olli

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`LayerStack.AssociationsIterator`
`class`	`LayerStack.TopicAndLayerKeyMaker`
`private class`	`LayerStack.TopicsIterator`

Field Summary

Fields
Modifier and Type	Field and Description
`private AmbiguityResolver`	`ambiguityResolver`
`protected ContainerTopicMapListener`	`containerListener`
`protected java.util.ArrayList<TopicMapListener>`	`disabledListeners`
`protected java.lang.Object`	`indexLock`
`protected java.util.HashMap<TopicMap,Layer>`	`layerIndex` Maps the topic maps of each layer to the layer itself.
`protected java.util.Vector<Layer>`	`layers` All layers in the layer stack.
`protected Layer`	`selectedLayer` The selected layer.
`protected java.util.HashMap<Locator,LayeredTopic>`	`topicIndex` Maps subject identifiers to layered topics for fast access in makeLayered.
`protected java.util.ArrayList<TopicMapListener>`	`topicMapListeners`
`protected boolean`	`trackDependent`
`protected boolean`	`useTopicIndex`
`protected boolean`	`useUndo`
`protected java.util.Vector<Layer>`	`visibleLayers` All layers that are currently visible, in the order they are in the stack.

Fields inherited from class org.wandora.topicmap.layered.ContainerTopicMap
containerListeners

Fields inherited from class org.wandora.topicmap.TopicMap
consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors
Constructor and Description

LayerStack()

LayerStack(java.lang.String wandoraProjectFilename)
Creates a new instance of LayerStack

Constructors
Constructor and Description
`LayerStack()`
`LayerStack(java.lang.String wandoraProjectFilename)` Creates a new instance of LayerStack

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLayer(Layer l)` Adds a layer at the bottom of the stack.
`void`	`addLayer(Layer l, int pos)` Inserts a layer at the specified position in the stack.
`void`	`addTopicMapListener(TopicMapListener listener)` Adds a topic map listener.
`(package private) void`	`addTopicToIndex(LayeredTopic lt)` Adds a topic to topicIndex.
`void`	`addUndoMarker(java.lang.String label)`
`(package private) void`	`ambiguity(java.lang.String s)`
`void`	`associationChanged(Association a)` A notification used to report general or large changes in association.
`void`	`associationPlayerChanged(Association a, Topic role, Topic newPlayer, Topic oldPlayer)` A notification that a player in an association with a certain role has been changed.
`void`	`associationRemoved(Association a)` A notification that an association has been completely removed.
`void`	`associationTypeChanged(Association a, Topic newType, Topic oldType)` A notification that association type has changed.
`boolean`	`canRedo()`
`boolean`	`canUndo()`
`void`	`clearTopicIndex()` Clears topicIndex.
`void`	`clearTopicMap()` Completely clears the topic map.
`void`	`clearTopicMapIndexes()` If the topic map implementation keeps indexes or caches of topics, calling this method will clear such data structures and cause further methods to retrieve data directly from the original data source.
`void`	`clearUndoBuffers()`
`void`	`close()` Close the topic map.
`protected void`	`collectTopics(java.util.Set<Topic> collected, Topic t)` Collects all topics from all layers that merge with the given topic.
`protected java.util.Set<Topic>`	`collectTopics(Topic t)` Collects all topics from all layers that merge with the given topic.
`Association`	`copyAssociationIn(Association a)` Copies an association of a different topic map in this topic map.
`void`	`copyTopicAssociationsIn(Topic t)` Copies all associations of a topic of a different topic map in this topic map using copyAssociationIn.
`Topic`	`copyTopicIn(Topic t, boolean deep)` Copies a topic of different topic map in this topic map.
`Association`	`createAssociation(Topic type)` Creates a new association of the given type without any members.
`Topic`	`createTopic()` Creates a new topic without base name, subject identifier, data or any associations.
`Topic`	`createTopic(java.lang.String id)` Creates a new topic without base name, subject identifier, data or any associations.
`void`	`disableAllListeners()`
`void`	`enableAllListeners()`
`java.util.Iterator<Association>`	`getAssociations()` Returns all associations in the topic map.
`java.util.Collection<Association>`	`getAssociationsOfType(Topic type)` Returns all associations in the topic map that are of the given type.
`boolean`	`getConsistencyCheck()`
`Layer`	`getLayer(java.lang.String layerName)` Gets the layer with the specified name.
`Layer`	`getLayer(Topic t)` Gets the layer a topic belongs to.
`Layer`	`getLayer(TopicMap tm)` Gets the layer of a topic map.
`(package private) LayeredTopic`	`getLayeredTopic(Topic t, java.util.Map<Topic,LayeredTopic> layeredTopics)`
`java.util.List<Layer>`	`getLayers()` Gets all layers in the order they are in the stack.
`int`	`getLayerZPos(Layer l)` Gets layer position in the stack.
`private UndoBuffer`	`getNextRedo()`
`static Tuples.T2<java.lang.Integer,UndoBuffer>`	`getNextRedo(LayerStack lst)`
`private UndoBuffer`	`getNextUndo()`
`static Tuples.T2<java.lang.Integer,UndoBuffer>`	`getNextUndo(LayerStack lst)`
`int`	`getNumAssociations()` Returns the number of associations in topic map.
`int`	`getNumTopics()` Returns the number of topics in topic map.
`int`	`getSelectedIndex()` Gets the selected layer position in the stack.
`Layer`	`getSelectedLayer()` Gets the selected layer.
`TopicMapStatData`	`getStatistics(TopicMapStatOptions options)`
`Topic`	`getTopic(Locator si)` Gets a topic with subject identifier.
`Topic`	`getTopicBySubjectLocator(Locator sl)` Gets a topic with subject locator.
`java.util.List<TopicMapListener>`	`getTopicMapListeners()` Gets all topic map listeners.
`java.util.Iterator<Topic>`	`getTopics()` Gets all topics in the topic map.
`Topic[]`	`getTopics(java.lang.String[] sis)` Gets the topics whose subject identifiers are given in the array.
`java.util.Collection<Topic>`	`getTopicsForLayer(Layer l, Topic t)`
`java.util.Collection<Topic>`	`getTopicsOfType(Topic type)` Gets all topics in the topic map that are of the given type.
`Topic`	`getTopicWithBaseName(java.lang.String name)` Gets a topic with topic base name.
`java.util.ArrayList<UndoOperation>`	`getUndoOperations()`
`java.util.List<Layer>`	`getVisibleLayers()` Gets all visible layers in the order they are in the stack.
`void`	`importLTM(java.io.File in)`
`void`	`importLTM(java.io.InputStream in, TopicMapLogger logger)`
`void`	`importXTM(java.io.InputStream in, TopicMapLogger logger)`
`boolean`	`isSelectedReadOnly()` Checks if the selected layer is in read only mode.
`boolean`	`isTopicMapChanged()` Checks if the topic map has been changed since the last call to resetTopicMapChanged.
`boolean`	`isUseUndo()`
`static void`	`main(java.lang.String[] args)`
`(package private) LayeredAssociation`	`makeLayeredAssociation(Association a)` Makes layered association from an individual association.
`(package private) LayeredTopic`	`makeLayeredTopic(Topic t)` Makes a layered topic when given a topic in one of the layers, that is a topic that isn't yet a LayeredTopic of this LayerStack.
`(package private) java.util.Collection<Topic>`	`makeLayeredTopics(java.util.Collection<Topic> ts)` Makes layered topics for all topics in the collection.
`void`	`mergeAllLayers(int targetLayerIndex)` Merges all layers in the specified layer.
`void`	`mergeIn(TopicMap tm)` Merges the contents of the given topic map in this topic map.
`void`	`mergeLayers(int[] layerIndexes)` Merges some layers.
`void`	`notifyLayersChanged()`
`void`	`redo()`
`boolean`	`removeLayer(Layer l)` Removes the specified layer.
`(package private) void`	`removeTopicFromIndex(Locator l)` Removes topic from topicIndex.
`void`	`removeTopicMapListener(TopicMapListener listener)` Removes a topic map listener.
`boolean`	`resetTopicMapChanged()`
`AmbiguityResolution`	`resolveAmbiguity(java.lang.String event)`
`AmbiguityResolution`	`resolveAmbiguity(java.lang.String event, java.lang.String msg)`
`void`	`reverseLayerOrder()` Moves layers around to reverse layer order.
`java.util.Collection<Topic>`	`search(java.lang.String query, TopicMapSearchOptions options)` Searches the topic map for the given string.
`void`	`selectLayer(Layer layer)` Makes the specified layer the selected layer.
`void`	`setAmbiguityResolver(AmbiguityResolver resolver)`
`void`	`setConsistencyCheck(boolean value)` Set consistency check of associations on or off.
`void`	`setLayer(Layer l, int pos)` Sets layer in the specified position removing old layer at that position.
`void`	`setTrackDependent(boolean v)` NOTE: The two trackDependent methods are mostly deprecated.
`void`	`setUndoDisabled(boolean value)`
`void`	`setUseUndo(boolean useUndo)`
`void`	`topicBaseNameChanged(Topic t, java.lang.String newName, java.lang.String oldName)` Notification that the base name has been changed.
`void`	`topicChanged(Topic t)` A notification used to report general or large changes in topic, for example when topics are merged.
`void`	`topicDataChanged(Topic t, Topic type, Topic version, java.lang.String newValue, java.lang.String oldValue)` Notification that topic occurrence has been changed.
`void`	`topicRemoved(Topic t)` Notification that a topic has been completely removed.
`void`	`topicSubjectIdentifierChanged(Topic t, Locator added, Locator removed)` Notification that a subject identifier has changed.
`void`	`topicSubjectLocatorChanged(Topic t, Locator newLocator, Locator oldLocator)` Notification that the subject locator has been changed.
`void`	`topicTypeChanged(Topic t, Topic added, Topic removed)` Notification that a topic type has changed.
`void`	`topicVariantChanged(Topic t, java.util.Collection<Topic> scope, java.lang.String newName, java.lang.String oldName)` Notification that a variant name has been changed.
`boolean`	`trackingDependent()`
`void`	`undo()`

Methods inherited from class org.wandora.topicmap.TopicMap
addTopicMapListeners, checkAssociationConsistency, checkAssociationConsistency, copyTopicCollectionIn, createLocator, createLocator, escapeXML, exportJTM, exportJTM, exportJTM, exportJTM, exportLTM, exportLTM, exportLTM, exportLTM, exportTopicMap, exportTopicMap, exportXTM, exportXTM, exportXTM, exportXTM, exportXTM10, exportXTM10, exportXTM10, exportXTM20, exportXTM20, forceStop, getLogger, getMergingTopics, getParentTopicMap, getRootTopicMap, getTopic, getTopicBySubjectLocator, getTopics, getTopicsOfType, hlog, importJTM, importJTM, importJTM, importJTM, importJTM, importJTM, importLTM, importLTM, importLTM, importLTM, importTopicMap, importTopicMap, importTopicMap, importXTM, importXTM, importXTM, importXTM, isConnected, isReadOnly, log, log, log, makeJTMString, makeJTMTopicId, makeLTMString, makeLTMTopicId, makeSubjectIndicator, makeSubjectIndicatorAsLocator, mergeIn, setLogger, setLogTitle, setParentTopicMap, setProgress, setProgressMax, setReadOnly

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

- Field Detail
  - useTopicIndex
```
protected boolean useTopicIndex
```
  - indexLock
```
protected java.lang.Object indexLock
```
  - topicIndex
```
protected java.util.HashMap<Locator,LayeredTopic> topicIndex
```
    Maps subject identifiers to layered topics for fast access in makeLayered. Contains topics that have recently been used in makeLayered topic. Each subject identifier of every topic in index is (and must be) indexed. General principle with updating index is that when a topic changes, it is removed from index. That is, mappings from all it's (previous) subject identifiers is removed. It will be added to index later when it is used in makeLayered again. Indexes are completely wiped after significant changes in topic map, such as adding layers or changing visibility of layers.
  - layers
```
protected java.util.Vector<Layer> layers
```
    All layers in the layer stack.
  - layerIndex
```
protected java.util.HashMap<TopicMap,Layer> layerIndex
```
    Maps the topic maps of each layer to the layer itself.
  - selectedLayer
```
protected Layer selectedLayer
```
    The selected layer.
  - visibleLayers
```
protected java.util.Vector<Layer> visibleLayers
```
    All layers that are currently visible, in the order they are in the stack.
  - trackDependent
```
protected boolean trackDependent
```
  - topicMapListeners
```
protected java.util.ArrayList<TopicMapListener> topicMapListeners
```
  - disabledListeners
```
protected java.util.ArrayList<TopicMapListener> disabledListeners
```
  - ambiguityResolver
```
private AmbiguityResolver ambiguityResolver
```
  - containerListener
```
protected ContainerTopicMapListener containerListener
```
  - useUndo
```
protected boolean useUndo
```
- Constructor Detail
  - LayerStack
```
public LayerStack(java.lang.String wandoraProjectFilename)
```
    Creates a new instance of LayerStack
  - LayerStack
```
public LayerStack()
```
- Method Detail
  - close
```
public void close()
```
    Description copied from class: TopicMap
    
    Close the topic map. Free resources used by the topic map, the database connection, for example.
    
    Specified by:
    
    close in class TopicMap
  - isUseUndo
```
public boolean isUseUndo()
```
  - setUseUndo
```
public void setUseUndo(boolean useUndo)
                throws UndoException
```
    Throws:
    
    UndoException
  - setUndoDisabled
```
public void setUndoDisabled(boolean value)
```
  - undo
```
public void undo()
          throws UndoException
```
    Throws:
    
    UndoException
  - redo
```
public void redo()
          throws UndoException
```
    Throws:
    
    UndoException
  - getNextUndo
```
private UndoBuffer getNextUndo()
```
  - getNextUndo
```
public static Tuples.T2<java.lang.Integer,UndoBuffer> getNextUndo(LayerStack lst)
```
  - getNextRedo
```
private UndoBuffer getNextRedo()
```
  - getNextRedo
```
public static Tuples.T2<java.lang.Integer,UndoBuffer> getNextRedo(LayerStack lst)
```
  - canUndo
```
public boolean canUndo()
```
  - canRedo
```
public boolean canRedo()
```
  - addUndoMarker
```
public void addUndoMarker(java.lang.String label)
```
  - clearUndoBuffers
```
public void clearUndoBuffers()
```
  - getUndoOperations
```
public java.util.ArrayList<UndoOperation> getUndoOperations()
```
  - clearTopicMap
```
public void clearTopicMap()
                   throws TopicMapException
```
    Description copied from class: TopicMap
    
    Completely clears the topic map. This deletes all associations and topics and all information related to them.
    
    Specified by:
    
    clearTopicMap in class TopicMap
    
    Throws:
    
    TopicMapException
  - clearTopicMapIndexes
```
public void clearTopicMapIndexes()
                          throws TopicMapException
```
    Description copied from class: TopicMap
    
    If the topic map implementation keeps indexes or caches of topics, calling this method will clear such data structures and cause further methods to retrieve data directly from the original data source. (NOTE: should probably be named clearTopicMapCache?)
    
    Specified by:
    
    clearTopicMapIndexes in class TopicMap
    
    Throws:
    
    TopicMapException
  - clearTopicIndex
```
public void clearTopicIndex()
```
    Clears topicIndex.
  - removeTopicFromIndex
```
void removeTopicFromIndex(Locator l)
                   throws TopicMapException
```
    Removes topic from topicIndex. Each subject identifier of the topic is removed. It is assumed that each subject identifier of a topic is in the index. Thus whatever the subject identifier used as parameter is, the topic will be found if it is in the index. Note that if the indexed topic doesn't anymore contain all its previous subject identifiers, you will have to manually remove the old subject identifiers from the index.
    
    Throws:
    
    TopicMapException
  - addTopicToIndex
```
void addTopicToIndex(LayeredTopic lt)
              throws TopicMapException
```
    Adds a topic to topicIndex. Each subject identifier of the topic is mapped to the layered topic itself.
    
    Throws:
    
    TopicMapException
  - setConsistencyCheck
```
public void setConsistencyCheck(boolean value)
                         throws TopicMapException
```
    Description copied from class: TopicMap
    
    Set consistency check of associations on or off. This should normally be turned on but you may turn it off before some big batch operations to speed them up. After this operation you need to turn the consistency check back on and manually call checkAssociationConsistency unless you are sure that the operation did not cause any incensistencies with associations.
    Note that some implementations may not allow turning consistency check off so getConsistencyCheck may return a different value that the last parameter used for setConsistencyCheck. If turning consistency check off is not supported, then it is also not needed to manually call the checkAssociationConsistency.
    
    Overrides:
    
    setConsistencyCheck in class TopicMap
    
    Throws:
    
    TopicMapException
    
    See Also:
    
    TopicMap.checkAssociationConsistency(TopicMapLogger)
  - getConsistencyCheck
```
public boolean getConsistencyCheck()
                            throws TopicMapException
```
    Overrides:
    
    getConsistencyCheck in class TopicMap
    
    Throws:
    
    TopicMapException
  - setAmbiguityResolver
```
public void setAmbiguityResolver(AmbiguityResolver resolver)
```
  - topicRemoved
```
public void topicRemoved(Topic t)
                  throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    Notification that a topic has been completely removed.
    
    Specified by:
    
    topicRemoved in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - associationRemoved
```
public void associationRemoved(Association a)
                        throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    A notification that an association has been completely removed.
    
    Specified by:
    
    associationRemoved in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - topicSubjectIdentifierChanged
```
public void topicSubjectIdentifierChanged(Topic t,
                                          Locator added,
                                          Locator removed)
                                   throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    Notification that a subject identifier has changed. Either added or removed is non-null and indicates that a subject identifier has been added or removed, respectively. The non-null parameter contains the new subject identifier or the removed subject identifier.
    
    Specified by:
    
    topicSubjectIdentifierChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - topicBaseNameChanged
```
public void topicBaseNameChanged(Topic t,
                                 java.lang.String newName,
                                 java.lang.String oldName)
                          throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    Notification that the base name has been changed. Either newName or oldName may be null indicating that base name was removed or old name was empty.
    
    Specified by:
    
    topicBaseNameChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - topicTypeChanged
```
public void topicTypeChanged(Topic t,
                             Topic added,
                             Topic removed)
                      throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    Notification that a topic type has changed. Either added or removed is non-null and indicates that a type has been added or removed, respectively. The non-null parameter contains the new type or the removed type.
    
    Specified by:
    
    topicTypeChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - topicVariantChanged
```
public void topicVariantChanged(Topic t,
                                java.util.Collection<Topic> scope,
                                java.lang.String newName,
                                java.lang.String oldName)
                         throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    Notification that a variant name has been changed. Either newName or oldName may be null indicating that the variant name was removed or old name was empty.
    
    Specified by:
    
    topicVariantChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - topicDataChanged
```
public void topicDataChanged(Topic t,
                             Topic type,
                             Topic version,
                             java.lang.String newValue,
                             java.lang.String oldValue)
                      throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    Notification that topic occurrence has been changed. Either newValue or oldValue may be null indicating that the occurrence was removed or old value was empty.
    
    Specified by:
    
    topicDataChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - topicSubjectLocatorChanged
```
public void topicSubjectLocatorChanged(Topic t,
                                       Locator newLocator,
                                       Locator oldLocator)
                                throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    Notification that the subject locator has been changed. Either newLocator or oldLocator may be null indicating that locator was removed or there was no old locator.
    
    Specified by:
    
    topicSubjectLocatorChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - topicChanged
```
public void topicChanged(Topic t)
                  throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    A notification used to report general or large changes in topic, for example when topics are merged. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.
    
    Specified by:
    
    topicChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - associationTypeChanged
```
public void associationTypeChanged(Association a,
                                   Topic newType,
                                   Topic oldType)
                            throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    A notification that association type has changed. Either newType or oldType can be null to indicate that old or new type was null. When type is changed from one topic to another, both will be non-null.
    
    Specified by:
    
    associationTypeChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - associationPlayerChanged
```
public void associationPlayerChanged(Association a,
                                     Topic role,
                                     Topic newPlayer,
                                     Topic oldPlayer)
                              throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    A notification that a player in an association with a certain role has been changed. Either newPlayer or oldPlayer can be null to indicate that the no new player for the role was set or that there was no player with the role previously. Both can also be non-null to indicate that the player of the role changed.
    
    Specified by:
    
    associationPlayerChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - associationChanged
```
public void associationChanged(Association a)
                        throws TopicMapException
```
    Description copied from interface: TopicMapListener
    
    A notification used to report general or large changes in association. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.
    
    Specified by:
    
    associationChanged in interface TopicMapListener
    
    Throws:
    
    TopicMapException
  - isSelectedReadOnly
```
public boolean isSelectedReadOnly()
```
    Checks if the selected layer is in read only mode.
  - getLayerZPos
```
public int getLayerZPos(Layer l)
```
    Gets layer position in the stack. Layer with index 0 is at the top.
    
    Specified by:
    
    getLayerZPos in class ContainerTopicMap
  - getLayer
```
public Layer getLayer(Topic t)
```
    Gets the layer a topic belongs to.
  - getLayer
```
public Layer getLayer(TopicMap tm)
```
    Gets the layer of a topic map.
  - getLayer
```
public Layer getLayer(java.lang.String layerName)
```
    Gets the layer with the specified name.
    
    Specified by:
    
    getLayer in class ContainerTopicMap
  - getSelectedLayer
```
public Layer getSelectedLayer()
```
    Gets the selected layer.
    
    Specified by:
    
    getSelectedLayer in class ContainerTopicMap
  - getSelectedIndex
```
public int getSelectedIndex()
```
    Gets the selected layer position in the stack.
    
    Specified by:
    
    getSelectedIndex in class ContainerTopicMap
  - selectLayer
```
public void selectLayer(Layer layer)
```
    Makes the specified layer the selected layer.
    
    Specified by:
    
    selectLayer in class ContainerTopicMap
  - getLayers
```
public java.util.List<Layer> getLayers()
```
    Gets all layers in the order they are in the stack.
    
    Specified by:
    
    getLayers in class ContainerTopicMap
  - getVisibleLayers
```
public java.util.List<Layer> getVisibleLayers()
```
    Gets all visible layers in the order they are in the stack.
    
    Specified by:
    
    getVisibleLayers in class ContainerTopicMap
  - notifyLayersChanged
```
public void notifyLayersChanged()
```
    Specified by:
    
    notifyLayersChanged in class ContainerTopicMap
  - getTopicsForLayer
```
public java.util.Collection<Topic> getTopicsForLayer(Layer l,
                                                     Topic t)
```
    Specified by:
    
    getTopicsForLayer in class ContainerTopicMap
  - addLayer
```
public void addLayer(Layer l)
```
    Adds a layer at the bottom of the stack.
    
    Overrides:
    
    addLayer in class ContainerTopicMap
  - addLayer
```
public void addLayer(Layer l,
                     int pos)
```
    Inserts a layer at the specified position in the stack. Layers after that index are moved one position down.
    
    Specified by:
    
    addLayer in class ContainerTopicMap
  - setLayer
```
public void setLayer(Layer l,
                     int pos)
```
    Sets layer in the specified position removing old layer at that position.
    
    Specified by:
    
    setLayer in class ContainerTopicMap
  - removeLayer
```
public boolean removeLayer(Layer l)
```
    Removes the specified layer. Layers after the removed layer are moved one position up.
    
    Specified by:
    
    removeLayer in class ContainerTopicMap
  - reverseLayerOrder
```
public void reverseLayerOrder()
```
    Moves layers around to reverse layer order.
    
    Specified by:
    
    reverseLayerOrder in class ContainerTopicMap
  - mergeAllLayers
```
public void mergeAllLayers(int targetLayerIndex)
```
    Merges all layers in the specified layer.
  - mergeLayers
```
public void mergeLayers(int[] layerIndexes)
```
    Merges some layers. The array given as parameter should contain indexes of layers to be merged. First index is used as the target layer and all other layers are merged into that.
  - ambiguity
```
void ambiguity(java.lang.String s)
```
  - resolveAmbiguity
```
public AmbiguityResolution resolveAmbiguity(java.lang.String event)
```
  - resolveAmbiguity
```
public AmbiguityResolution resolveAmbiguity(java.lang.String event,
                                            java.lang.String msg)
```
  - collectTopics
```
protected java.util.Set<Topic> collectTopics(Topic t)
                                      throws TopicMapException
```
    Collects all topics from all layers that merge with the given topic.
    
    Throws:
    
    TopicMapException
  - collectTopics
```
protected void collectTopics(java.util.Set<Topic> collected,
                             Topic t)
                      throws TopicMapException
```
    Collects all topics from all layers that merge with the given topic. Initially the collected Set is empty but all merging topics are added to it to be returned later and to avoid processing same topic several times.
    
    Throws:
    
    TopicMapException
  - makeLayeredTopic
```
LayeredTopic makeLayeredTopic(Topic t)
                       throws TopicMapException
```
    Makes a layered topic when given a topic in one of the layers, that is a topic that isn't yet a LayeredTopic of this LayerStack. First checks if the topic is available in the topicIndex map for fast retrieval. If not, collects all topics from different layers and adds the topic to the index before it is returned.
    
    Throws:
    
    TopicMapException
  - makeLayeredTopics
```
java.util.Collection<Topic> makeLayeredTopics(java.util.Collection<Topic> ts)
                                       throws TopicMapException
```
    Makes layered topics for all topics in the collection. Note that some topics in the collection may end up in the same layered topic and thus the returned collection may have less items than the collection used as the parameter.
    
    Throws:
    
    TopicMapException
  - makeLayeredAssociation
```
LayeredAssociation makeLayeredAssociation(Association a)
                                   throws TopicMapException
```
    Makes layered association from an individual association. Note that unlike LayeredTopic.getAssociations, this method returns only one LayeredAssociation for each individual association, even if roles have been merged and there are actually several LayeredAssociations that are constructed from the association used as parameter. In the case of merged roles, one of the possible LayeredAssociations is returned arbitrarily.
    
    Throws:
    
    TopicMapException
  - getTopic
```
public Topic getTopic(Locator si)
               throws TopicMapException
```
    Description copied from class: TopicMap
    
    Gets a topic with subject identifier.
    
    Specified by:
    
    getTopic in class TopicMap
    
    Throws:
    
    TopicMapException
  - getTopics
```
public Topic[] getTopics(java.lang.String[] sis)
                  throws TopicMapException
```
    Description copied from class: TopicMap
    
    Gets the topics whose subject identifiers are given in the array. Will always return an array of equal size as the parameter array with null elements where topics are not found with the given subject identifiers.
    
    Specified by:
    
    getTopics in class TopicMap
    
    Throws:
    
    TopicMapException
  - getTopicBySubjectLocator
```
public Topic getTopicBySubjectLocator(Locator sl)
                               throws TopicMapException
```
    Description copied from class: TopicMap
    
    Gets a topic with subject locator.
    
    Specified by:
    
    getTopicBySubjectLocator in class TopicMap
    
    Throws:
    
    TopicMapException
  - createTopic
```
public Topic createTopic(java.lang.String id)
                  throws TopicMapException
```
    Description copied from class: TopicMap
    
    Creates a new topic without base name, subject identifier, data or any associations.
    
    Specified by:
    
    createTopic in class TopicMap
    
    Throws:
    
    TopicMapException
  - createTopic
```
public Topic createTopic()
                  throws TopicMapException
```
    Description copied from class: TopicMap
    
    Creates a new topic without base name, subject identifier, data or any associations.
    
    Specified by:
    
    createTopic in class TopicMap
    
    Throws:
    
    TopicMapException
  - createAssociation
```
public Association createAssociation(Topic type)
                              throws TopicMapException
```
    Description copied from class: TopicMap
    
    Creates a new association of the given type without any members.
    
    Specified by:
    
    createAssociation in class TopicMap
    
    Throws:
    
    TopicMapException
  - getTopicsOfType
```
public java.util.Collection<Topic> getTopicsOfType(Topic type)
                                            throws TopicMapException
```
    Description copied from class: TopicMap
    
    Gets all topics in the topic map that are of the given type.
    
    Specified by:
    
    getTopicsOfType in class TopicMap
    
    Throws:
    
    TopicMapException
  - getTopicWithBaseName
```
public Topic getTopicWithBaseName(java.lang.String name)
                           throws TopicMapException
```
    Description copied from class: TopicMap
    
    Gets a topic with topic base name.
    
    Specified by:
    
    getTopicWithBaseName in class TopicMap
    
    Throws:
    
    TopicMapException
  - getTopics
```
public java.util.Iterator<Topic> getTopics()
                                    throws TopicMapException
```
    Description copied from class: TopicMap
    
    Gets all topics in the topic map. The topic map may contain a very large number of topics and this operation may take a long time to finish even though it returns an iterator instead of all topics in a collection. Ideally this should return a TopicIterator with the special dispose method instead of a generic Iterator. The interface remains specifies just Iterator for backwards compatibility. See notes in TopicIterator.
    
    Specified by:
    
    getTopics in class TopicMap
    
    Throws:
    
    TopicMapException
  - getAssociations
```
public java.util.Iterator<Association> getAssociations()
                                                throws TopicMapException
```
    Description copied from class: TopicMap
    
    Returns all associations in the topic map. The topic map may contain a very large number of associations and this operation may take a long time to finish even though it returns an iterator instead of all associations in a collection.
    
    Specified by:
    
    getAssociations in class TopicMap
    
    Throws:
    
    TopicMapException
  - getLayeredTopic
```
LayeredTopic getLayeredTopic(Topic t,
                             java.util.Map<Topic,LayeredTopic> layeredTopics)
                      throws TopicMapException
```
    Throws:
    
    TopicMapException
  - getAssociationsOfType
```
public java.util.Collection<Association> getAssociationsOfType(Topic type)
                                                        throws TopicMapException
```
    Description copied from class: TopicMap
    
    Returns all associations in the topic map that are of the given type. Usually topic maps will either contain none or a very large number of associations of any type. Thus this method may potentially be very time consuming and require a very large amount of memory.
    
    Specified by:
    
    getAssociationsOfType in class TopicMap
    
    Throws:
    
    TopicMapException
  - getNumTopics
```
public int getNumTopics()
                 throws TopicMapException
```
    Description copied from class: TopicMap
    
    Returns the number of topics in topic map. For some implementations this may be a very time consuming operation while for some it is a very simple thing to do.
    
    Specified by:
    
    getNumTopics in class TopicMap
    
    Throws:
    
    TopicMapException
  - getNumAssociations
```
public int getNumAssociations()
                       throws TopicMapException
```
    Description copied from class: TopicMap
    
    Returns the number of associations in topic map. For some implementations this may be a very time consuming operation while for some it is a very simple thing to do.
    
    Specified by:
    
    getNumAssociations in class TopicMap
    
    Throws:
    
    TopicMapException
  - copyTopicIn
```
public Topic copyTopicIn(Topic t,
                         boolean deep)
                  throws TopicMapException
```
    Description copied from class: TopicMap
    
    Copies a topic of different topic map in this topic map. If deep is true then topic types, variants and data are also copied. Only stubs of types, data types and variant scopes are copied.
    
    Specified by:
    
    copyTopicIn in class TopicMap
    
    Throws:
    
    TopicMapException
  - copyAssociationIn
```
public Association copyAssociationIn(Association a)
                              throws TopicMapException
```
    Description copied from class: TopicMap
    
    Copies an association of a different topic map in this topic map. If a topic related to the association does not exist in the topic map, then that topic is copied with copyTopicIn(t,false). Otherwise the existing topic is used. The existence of a topic is checked by trying to get it with one (chosen arbitrarily) subject identifier.
    
    Specified by:
    
    copyAssociationIn in class TopicMap
    
    Throws:
    
    TopicMapException
  - copyTopicAssociationsIn
```
public void copyTopicAssociationsIn(Topic t)
                             throws TopicMapException
```
    Description copied from class: TopicMap
    
    Copies all associations of a topic of a different topic map in this topic map using copyAssociationIn.
    
    Specified by:
    
    copyTopicAssociationsIn in class TopicMap
    
    Throws:
    
    TopicMapException
  - importXTM
```
public void importXTM(java.io.InputStream in,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException
```
    Overrides:
    
    importXTM in class TopicMap
    
    Throws:
    
    java.io.IOException
    
    TopicMapException
  - importLTM
```
public void importLTM(java.io.InputStream in,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException
```
    Overrides:
    
    importLTM in class TopicMap
    
    Throws:
    
    java.io.IOException
    
    TopicMapException
  - importLTM
```
public void importLTM(java.io.File in)
               throws java.io.IOException,
                      TopicMapException
```
    Overrides:
    
    importLTM in class TopicMap
    
    Throws:
    
    java.io.IOException
    
    TopicMapException
  - mergeIn
```
public void mergeIn(TopicMap tm)
             throws TopicMapException
```
    Description copied from class: TopicMap
    
    Merges the contents of the given topic map in this topic map. At least one of mergeIn(TopicMap) or mergeIn(TopicMap,TopicMapLogger) must be overridden as they call each other in default implementation.
    
    Overrides:
    
    mergeIn in class TopicMap
    
    Throws:
    
    TopicMapException
  - trackingDependent
```
public boolean trackingDependent()
```
    Specified by:
    
    trackingDependent in class TopicMap
  - setTrackDependent
```
public void setTrackDependent(boolean v)
```
    Description copied from class: TopicMap
    
    NOTE: The two trackDependent methods are mostly deprecated. They are used when caching html pages from topics to decide when cached pages need to be refreshed. A page needs to be updated when any topic visible in the page is changed.
    
    Specified by:
    
    setTrackDependent in class TopicMap
  - getTopicMapListeners
```
public java.util.List<TopicMapListener> getTopicMapListeners()
```
    Description copied from class: TopicMap
    
    Gets all topic map listeners.
    
    Specified by:
    
    getTopicMapListeners in class TopicMap
  - addTopicMapListener
```
public void addTopicMapListener(TopicMapListener listener)
```
    Description copied from class: TopicMap
    
    Adds a topic map listener.
    
    Specified by:
    
    addTopicMapListener in class TopicMap
  - removeTopicMapListener
```
public void removeTopicMapListener(TopicMapListener listener)
```
    Description copied from class: TopicMap
    
    Removes a topic map listener.
    
    Specified by:
    
    removeTopicMapListener in class TopicMap
  - disableAllListeners
```
public void disableAllListeners()
```
    Specified by:
    
    disableAllListeners in class TopicMap
  - enableAllListeners
```
public void enableAllListeners()
```
    Specified by:
    
    enableAllListeners in class TopicMap
  - resetTopicMapChanged
```
public boolean resetTopicMapChanged()
                             throws TopicMapException
```
    Specified by:
    
    resetTopicMapChanged in class TopicMap
    
    Throws:
    
    TopicMapException
    
    See Also:
    
    TopicMap.isTopicMapChanged()
  - isTopicMapChanged
```
public boolean isTopicMapChanged()
                          throws TopicMapException
```
    Description copied from class: TopicMap
    
    Checks if the topic map has been changed since the last call to resetTopicMapChanged.
    
    Specified by:
    
    isTopicMapChanged in class TopicMap
    
    Throws:
    
    TopicMapException
  - search
```
public java.util.Collection<Topic> search(java.lang.String query,
                                          TopicMapSearchOptions options)
                                   throws TopicMapException
```
    Description copied from class: TopicMap
    
    Searches the topic map for the given string. Search options are given in a separate search options object.
    
    Specified by:
    
    search in class TopicMap
    
    Throws:
    
    TopicMapException
  - getStatistics
```
public TopicMapStatData getStatistics(TopicMapStatOptions options)
                               throws TopicMapException
```
    Specified by:
    
    getStatistics in class TopicMap
    
    Throws:
    
    TopicMapException
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception

Class LayerStack

Nested Class Summary

Field Summary

Fields inherited from class org.wandora.topicmap.layered.ContainerTopicMap

Fields inherited from class org.wandora.topicmap.TopicMap

Constructor Summary

Method Summary

Methods inherited from class org.wandora.topicmap.layered.ContainerTopicMap

Methods inherited from class org.wandora.topicmap.TopicMap

Methods inherited from class java.lang.Object

Field Detail

useTopicIndex

indexLock

topicIndex

layers

layerIndex

selectedLayer

visibleLayers

trackDependent

topicMapListeners

disabledListeners

ambiguityResolver

containerListener

useUndo

Constructor Detail

LayerStack

LayerStack

Method Detail

close

isUseUndo

setUseUndo

setUndoDisabled

undo

redo

getNextUndo

getNextUndo

getNextRedo

getNextRedo

canUndo

canRedo

addUndoMarker

clearUndoBuffers

getUndoOperations

clearTopicMap

clearTopicMapIndexes

clearTopicIndex

removeTopicFromIndex

addTopicToIndex

setConsistencyCheck

getConsistencyCheck

setAmbiguityResolver

topicRemoved

associationRemoved

topicSubjectIdentifierChanged

topicBaseNameChanged

topicTypeChanged

topicVariantChanged

topicDataChanged

topicSubjectLocatorChanged

topicChanged

associationTypeChanged

associationPlayerChanged

associationChanged

isSelectedReadOnly

getLayerZPos

getLayer

getLayer

getLayer

getSelectedLayer

getSelectedIndex

selectLayer

getLayers

getVisibleLayers

notifyLayersChanged

getTopicsForLayer

addLayer

addLayer

setLayer

removeLayer

reverseLayerOrder