org.wandora.topicmap.layered

Class ContainerTopicMap

java.lang.Object

org.wandora.topicmap.TopicMap

org.wandora.topicmap.layered.ContainerTopicMap

All Implemented Interfaces:

TopicMapLogger

Direct Known Subclasses:

LayerStack, QueryTopicMap

public abstract class ContainerTopicMap
extends TopicMap

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<ContainerTopicMapListener>	containerListeners

Fields inherited from class org.wandora.topicmap.TopicMap

consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors

Constructor and Description
ContainerTopicMap()

Method Summary

Modifier and Type	Method and Description
void	addContainerListener(ContainerTopicMapListener listener)
void	addContainerListeners(java.util.List<ContainerTopicMapListener> listeners)
void	addLayer(Layer l) Adds a layer at the bottom of the container.
abstract void	addLayer(Layer l, int index) Inserts a layer at the specified position in the container.
protected void	fireLayerAdded(Layer layer)
protected void	fireLayerChanged(Layer oldLayer, Layer newLayer)
protected void	fireLayerRemoved(Layer layer)
protected void	fireLayerStructureChanged()
void	fireLayerVisibilityChanged(Layer layer)
java.util.List<ContainerTopicMapListener>	getContainerListeners()
abstract Layer	getLayer(java.lang.String name) Gets the layer with the specified name.
abstract java.util.List<Layer>	getLayers() Gets all layers in the order they are in the container.
abstract int	getLayerZPos(Layer l) Gets layer position in the container.
Layer	getLeafLayer(Topic t) Gets the leaf layer that the specifiec topic belongs to.
java.util.List<Layer>	getLeafLayers() Returns all leaf layers in the layer tree.
void	getLeafLayers(java.util.ArrayList<Layer> list)
int	getNumLayers() Gets the number of layers in this container.
abstract int	getSelectedIndex() Gets the selected layer position in the stack.
abstract Layer	getSelectedLayer() Gets the selected layer.
Layer	getSelectedTreeLayer() Gets the selected layer in the layer tree.
Topic	getTopicForLayer(Layer l, Topic t)
Topic	getTopicForSelectedTreeLayer(Topic t)
java.util.Collection<Topic>	getTopicsForAllLeafLayers(Topic t) Gets all topics in leaf layer tree layers that merge with the given topic.
abstract java.util.Collection<Topic>	getTopicsForLayer(Layer l, Topic t)
java.util.Collection<Topic>	getTopicsForSelectedTreeLayer(Topic t) Get all topics in the selected tree layer topic map that merge with the given topic.
java.util.Collection<Topic>	getTopicsForTreeLayer(Layer l, Topic t)
Layer	getTreeLayer(java.lang.String name)
Layer	getTreeLayer(TopicMap tm)
java.util.ArrayList<Layer>	getTreeLayerPath(Layer l, ContainerTopicMap root) Finds a layer tree path from root to the given layer.
boolean	getTreeLayerPath(Layer l, ContainerTopicMap root, java.util.ArrayList<Layer> stack)
java.util.List<Layer>	getTreeLayers() Gets all layers in the layer tree.
void	getTreeLayers(java.util.ArrayList<Layer> list)
abstract java.util.List<Layer>	getVisibleLayers() Gets all visible layers in the order they are in the container.
void	moveLayer(Layer l, int pos) Moves the specified layer in another position.
abstract void	notifyLayersChanged()
void	removeContainerListener(ContainerTopicMapListener listener)
abstract boolean	removeLayer(Layer l) Removes the specified layer.
abstract void	reverseLayerOrder()
abstract void	selectLayer(Layer layer) Makes the specified layer the selected layer.
abstract void	setLayer(Layer l, int pos) Sets layer in the specified position removing old layer at that position.

Methods inherited from class org.wandora.topicmap.TopicMap

addTopicMapListener, addTopicMapListeners, checkAssociationConsistency, checkAssociationConsistency, clearTopicMap, clearTopicMapIndexes, close, copyAssociationIn, copyTopicAssociationsIn, copyTopicCollectionIn, copyTopicIn, createAssociation, createLocator, createLocator, createTopic, createTopic, disableAllListeners, enableAllListeners, escapeXML, exportJTM, exportJTM, exportJTM, exportJTM, exportLTM, exportLTM, exportLTM, exportLTM, exportTopicMap, exportTopicMap, exportXTM, exportXTM, exportXTM, exportXTM, exportXTM10, exportXTM10, exportXTM10, exportXTM20, exportXTM20, forceStop, getAssociations, getAssociationsOfType, getConsistencyCheck, getLogger, getMergingTopics, getNumAssociations, getNumTopics, getParentTopicMap, getRootTopicMap, getStatistics, getTopic, getTopic, getTopicBySubjectLocator, getTopicBySubjectLocator, getTopicMapListeners, getTopics, getTopics, getTopics, getTopicsOfType, getTopicsOfType, getTopicWithBaseName, hlog, importJTM, importJTM, importJTM, importJTM, importJTM, importJTM, importLTM, importLTM, importLTM, importLTM, importLTM, importLTM, importTopicMap, importTopicMap, importTopicMap, importXTM, importXTM, importXTM, importXTM, importXTM, isConnected, isReadOnly, isTopicMapChanged, log, log, log, makeJTMString, makeJTMTopicId, makeLTMString, makeLTMTopicId, makeSubjectIndicator, makeSubjectIndicatorAsLocator, mergeIn, mergeIn, removeTopicMapListener, resetTopicMapChanged, search, setConsistencyCheck, setLogger, setLogTitle, setParentTopicMap, setProgress, setProgressMax, setReadOnly, setTrackDependent, trackingDependent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

containerListeners

protected java.util.ArrayList<ContainerTopicMapListener> containerListeners

Constructor Detail

ContainerTopicMap

public ContainerTopicMap()

Method Detail

getContainerListeners

public java.util.List<ContainerTopicMapListener> getContainerListeners()

addContainerListener

public void addContainerListener(ContainerTopicMapListener listener)

removeContainerListener

public void removeContainerListener(ContainerTopicMapListener listener)

addContainerListeners

public void addContainerListeners(java.util.List<ContainerTopicMapListener> listeners)

fireLayerAdded

protected void fireLayerAdded(Layer layer)

fireLayerRemoved

protected void fireLayerRemoved(Layer layer)

fireLayerStructureChanged

protected void fireLayerStructureChanged()

fireLayerChanged

protected void fireLayerChanged(Layer oldLayer,
                                Layer newLayer)

fireLayerVisibilityChanged

public void fireLayerVisibilityChanged(Layer layer)

getNumLayers

public int getNumLayers()

Gets the number of layers in this container. Default implementation return getLayers().size().

getTopicsForLayer

public abstract java.util.Collection<Topic> getTopicsForLayer(Layer l,
                                                              Topic t)

getTopicForLayer

public Topic getTopicForLayer(Layer l,
                              Topic t)

getTopicsForTreeLayer

public java.util.Collection<Topic> getTopicsForTreeLayer(Layer l,
                                                         Topic t)

getTreeLayerPath

public boolean getTreeLayerPath(Layer l,
                                ContainerTopicMap root,
                                java.util.ArrayList<Layer> stack)

getTreeLayerPath

public java.util.ArrayList<Layer> getTreeLayerPath(Layer l,
                                                   ContainerTopicMap root)

Finds a layer tree path from root to the given layer. Returned path is a list of layers that must be followed to reach the given layer. Return value will not include a layer for the root. If no path was found, i.e. given layer is not in the layer tree or not under the given root map, returns null.

getTopicsForAllLeafLayers

public java.util.Collection<Topic> getTopicsForAllLeafLayers(Topic t)

Gets all topics in leaf layer tree layers that merge with the given topic.

getLeafLayer

public Layer getLeafLayer(Topic t)

Gets the leaf layer that the specifiec topic belongs to. That is, the given topic should not be a layered topic of this topic map but a topic of one of the leaf layers of the layer tree of which this topic map is the root.

getTopicForSelectedTreeLayer

public Topic getTopicForSelectedTreeLayer(Topic t)

getTopicsForSelectedTreeLayer

public java.util.Collection<Topic> getTopicsForSelectedTreeLayer(Topic t)

Get all topics in the selected tree layer topic map that merge with the given topic. See getSelectedTreeLayer about the definition of selected tree layer.

getLeafLayers

public void getLeafLayers(java.util.ArrayList<Layer> list)

getLeafLayers

public java.util.List<Layer> getLeafLayers()

Returns all leaf layers in the layer tree. Leaf layers are layers that are not container topic maps.

getTreeLayer

public Layer getTreeLayer(TopicMap tm)

getTreeLayer

public Layer getTreeLayer(java.lang.String name)

getTreeLayers

public void getTreeLayers(java.util.ArrayList<Layer> list)

getTreeLayers

public java.util.List<Layer> getTreeLayers()

Gets all layers in the layer tree. This includes this container topic mapand any layers under possible other container topic maps in any of the layers of this topic map.

getSelectedTreeLayer

public Layer getSelectedTreeLayer()

Gets the selected layer in the layer tree. If topic map in selected layer in this topic map is another container topic map, then returns the selected tree layer in that container. Otherwise returns the selected layer in this container. In other words, recursively follows selected layers in container topic maps as deep as possible. Note that the returned layer is not necessarily the same user has selected in the layer tree GUI. This will be the case when user selects a nonleaf layer, that is a container topic map.

getLayers

public abstract java.util.List<Layer> getLayers()

Gets all layers in the order they are in the container.

notifyLayersChanged

public abstract void notifyLayersChanged()

getLayerZPos

public abstract int getLayerZPos(Layer l)

Gets layer position in the container. Layer with index 0 is at the top.

addLayer

public void addLayer(Layer l)

Adds a layer at the bottom of the container.

setLayer

public abstract void setLayer(Layer l,
                              int pos)

Sets layer in the specified position removing old layer at that position.

addLayer

public abstract void addLayer(Layer l,
                              int index)

Inserts a layer at the specified position in the container. Layers after that index are moved one position down.

removeLayer

public abstract boolean removeLayer(Layer l)

Removes the specified layer. Layers after the removed layer are moved one position up.

moveLayer

public void moveLayer(Layer l,
                      int pos)

Moves the specified layer in another position. Moves other layers to make room and to remove the resulting empty position.

getLayer

public abstract Layer getLayer(java.lang.String name)

Gets the layer with the specified name.

getSelectedLayer

public abstract Layer getSelectedLayer()

Gets the selected layer.

getSelectedIndex

public abstract int getSelectedIndex()

Gets the selected layer position in the stack.

selectLayer

public abstract void selectLayer(Layer layer)

Makes the specified layer the selected layer.

reverseLayerOrder

public abstract void reverseLayerOrder()

getVisibleLayers

public abstract java.util.List<Layer> getVisibleLayers()

Gets all visible layers in the order they are in the container.