org.wandora.topicmap.remote

Class RemoteTopic

java.lang.Object

org.wandora.topicmap.Topic

org.wandora.topicmap.memory.TopicImpl

org.wandora.topicmap.remote.RemoteTopic

public class RemoteTopic
extends TopicImpl

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
private RemoteTopicMap	topicMap

Constructor Summary

Constructors

Constructor and Description
RemoteTopic(RemoteTopicMap topicMap) Creates a new instance of RemoteTopic

Method Summary

Modifier and Type	Method and Description
void	addSubjectIdentifier(Locator l) Adds a subject identifier for the topic.
void	addType(Topic t) Adds a topic type.
java.util.Collection	getAssociations() Gets all associations where this topic is a player.
java.util.Collection	getAssociations(Topic type) Gets all associations of specified type where this topic is a player.
java.util.Collection	getAssociations(Topic type, Topic role) Gets associations of the specified type where this topic is in the specified role
java.util.Collection	getAssociationsWithRole() Gets associations that have this topic as role.
java.util.Collection	getAssociationsWithType() Gets associations that have this topic as type.
java.lang.String	getBaseName() Gets the topic base name or null if no base name has been set.
java.util.Hashtable	getData(Topic type) Returns a Hashtable mapping data versions to data content.
java.lang.String	getData(Topic type, Topic version) Gets data with the specified type and version.
java.util.Collection	getDataTypes() Gets all used data types.
long	getDependentEditTime()
long	getEditTime()
java.lang.String	getID() Gets the topic ID.
java.util.Collection	getSubjectIdentifiers() Gets all subject identifiers of the topic.
Locator	getSubjectLocator() Gets the topic subject locator or null if it has not been set.
TopicMap	getTopicMap() Gets the topic map this topic belongs to.
java.util.Collection	getTopicsWithDataType() Gets topics which have data with this topic as type.
java.util.Collection	getTypes() Gets all topic types.
java.lang.String	getVariant(java.util.Set scope) Gets a variant with the specified scope.
java.util.Set	getVariantScopes() Gets the scopes of all variant names.
boolean	isDeleteAllowed() Notice, isDeleteAllowed doesn't return true if the topic map is write protected or if the topic is already deleted.
boolean	isOfType(Topic t) Checks if this topic is of the specified type.
boolean	isRemoved() Returns true if this topic has been removed from the topic map it belonged to.
private void	makeFull()
void	mergeIn(Topic t)
void	removeData(Topic type) Removes all data with the specified type.
void	removeData(Topic type, Topic version) Removes data with specified type and version.
void	removeSubjectIdentifier(Locator l) Removes a subject identifier.
void	removeType(Topic t) Removes a topic type.
void	removeVariant(java.util.Set scope) Removes a variant name with the specified scope.
void	setBaseName(java.lang.String name) Sets the topic base name.
void	setData(Topic type, java.util.Hashtable versionData) Sets several data values.
void	setData(Topic type, Topic version, java.lang.String value) Sets data with specified type and version.
void	setSubjectLocator(Locator l) Sets the topic subject locator overwriting possible previous value.
void	setVariant(java.util.Set scope, java.lang.String name) Sets the variant with the specified scope.

Methods inherited from class org.wandora.topicmap.memory.TopicImpl

clearNameCaches, getDisplayName, getSortName, getTopicsWithDataVersion, getTopicsWithVariantScope, getUniqueID, remove, setDependentEditTime, setEditTime

Methods inherited from class org.wandora.topicmap.Topic

getData, getDisplayName, getFirstSubjectIdentifier, getName, getOneSubjectIdentifier, mergesWithTopic, setDisplayName, toString

Methods inherited from class java.lang.Object

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

Field Detail

topicMap

private RemoteTopicMap topicMap

Constructor Detail

RemoteTopic

public RemoteTopic(RemoteTopicMap topicMap)

Creates a new instance of RemoteTopic

Method Detail

makeFull

private void makeFull()
               throws TopicMapException

Throws:

TopicMapException

getAssociations

public java.util.Collection getAssociations()
                                     throws TopicMapException

Description copied from class: Topic

Gets all associations where this topic is a player.

Overrides:

getAssociations in class TopicImpl

Throws:

TopicMapException

getAssociations

public java.util.Collection getAssociations(Topic type)
                                     throws TopicMapException

Description copied from class: Topic

Gets all associations of specified type where this topic is a player.

Overrides:

getAssociations in class TopicImpl

Throws:

TopicMapException

getAssociations

public java.util.Collection getAssociations(Topic type,
                                            Topic role)
                                     throws TopicMapException

Description copied from class: Topic

Gets associations of the specified type where this topic is in the specified role

Overrides:

getAssociations in class TopicImpl

Throws:

TopicMapException

getBaseName

public java.lang.String getBaseName()
                             throws TopicMapException

Description copied from class: Topic

Gets the topic base name or null if no base name has been set.

Overrides:

getBaseName in class TopicImpl

Throws:

TopicMapException

getData

public java.util.Hashtable getData(Topic type)
                            throws TopicMapException

Description copied from class: Topic

Returns a Hashtable mapping data versions to data content.

Overrides:

getData in class TopicImpl

Throws:

TopicMapException

getData

public java.lang.String getData(Topic type,
                                Topic version)
                         throws TopicMapException

Description copied from class: Topic

Gets data with the specified type and version. Returns null if data is not found.

Overrides:

getData in class TopicImpl

Throws:

TopicMapException

getDataTypes

public java.util.Collection getDataTypes()
                                  throws TopicMapException

Description copied from class: Topic

Gets all used data types.

Overrides:

getDataTypes in class TopicImpl

Throws:

TopicMapException

getDependentEditTime

public long getDependentEditTime()
                          throws TopicMapException

Overrides:

getDependentEditTime in class TopicImpl

Throws:

TopicMapException

getEditTime

public long getEditTime()
                 throws TopicMapException

Overrides:

getEditTime in class TopicImpl

Throws:

TopicMapException

getID

public java.lang.String getID()
                       throws TopicMapException

Description copied from class: Topic

Gets the topic ID. Topic id is unique in the topic map. It cannot be changed after topic creation and is generally not visible to the user. It can be used when exporting topic map into XTM or storing it in a database.

Overrides:

getID in class TopicImpl

Throws:

TopicMapException

getSubjectIdentifiers

public java.util.Collection getSubjectIdentifiers()
                                           throws TopicMapException

Description copied from class: Topic

Gets all subject identifiers of the topic.

Overrides:

getSubjectIdentifiers in class TopicImpl

Throws:

TopicMapException

getSubjectLocator

public Locator getSubjectLocator()
                          throws TopicMapException

Description copied from class: Topic

Gets the topic subject locator or null if it has not been set.

Overrides:

getSubjectLocator in class TopicImpl

Throws:

TopicMapException

getTopicMap

public TopicMap getTopicMap()

Description copied from class: Topic

Gets the topic map this topic belongs to.

Overrides:

getTopicMap in class TopicImpl

getTypes

public java.util.Collection getTypes()
                              throws TopicMapException

Description copied from class: Topic

Gets all topic types.

Overrides:

getTypes in class TopicImpl

Throws:

TopicMapException

getVariant

public java.lang.String getVariant(java.util.Set scope)
                            throws TopicMapException

Description copied from class: Topic

Gets a variant with the specified scope. The scope must be a Collection of Topics. Returns null if there is no variant with the specified scope.

Overrides:

getVariant in class TopicImpl

Throws:

TopicMapException

getVariantScopes

public java.util.Set getVariantScopes()
                               throws TopicMapException

Description copied from class: Topic

Gets the scopes of all variant names.

Overrides:

getVariantScopes in class TopicImpl

Throws:

TopicMapException

isDeleteAllowed

public boolean isDeleteAllowed()
                        throws TopicMapException

Description copied from class: TopicImpl

Notice, isDeleteAllowed doesn't return true if the topic map is write protected or if the topic is already deleted.

Overrides:

isDeleteAllowed in class TopicImpl

Throws:

TopicMapException

isOfType

public boolean isOfType(Topic t)
                 throws TopicMapException

Description copied from class: Topic

Checks if this topic is of the specified type.

Overrides:

isOfType in class TopicImpl

Throws:

TopicMapException

isRemoved

public boolean isRemoved()
                  throws TopicMapException

Description copied from class: Topic

Returns true if this topic has been removed from the topic map it belonged to. Note that it might have been removed as a result of topics being merged and still exists in the topic map but as another topic object.

Overrides:

isRemoved in class TopicImpl

Throws:

TopicMapException

removeData

public void removeData(Topic type)
                throws TopicMapException

Description copied from class: Topic

Removes all data with the specified type.

Overrides:

removeData in class TopicImpl

Throws:

TopicMapException

removeData

public void removeData(Topic type,
                       Topic version)
                throws TopicMapException

Description copied from class: Topic

Removes data with specified type and version. If no such data value is set, does nothing.

Overrides:

removeData in class TopicImpl

Throws:

TopicMapException

removeVariant

public void removeVariant(java.util.Set scope)
                   throws TopicMapException

Description copied from class: Topic

Removes a variant name with the specified scope. If no such variant exists, does nothing.

Overrides:

removeVariant in class TopicImpl

Throws:

TopicMapException

setData

public void setData(Topic type,
                    java.util.Hashtable versionData)
             throws TopicMapException

Description copied from class: Topic

Sets several data values. Each value is set with same type, the other parameter should contain versions mapped to the actual values.

Overrides:

setData in class TopicImpl

Throws:

TopicMapException

setData

public void setData(Topic type,
                    Topic version,
                    java.lang.String value)
             throws TopicMapException

Description copied from class: Topic

Sets data with specified type and version.

Overrides:

setData in class TopicImpl

Throws:

TopicMapException

setBaseName

public void setBaseName(java.lang.String name)
                 throws TopicMapException

Description copied from class: Topic

Sets the topic base name. This may cause a topic merge.

Overrides:

setBaseName in class TopicImpl

Throws:

TopicMapException

setVariant

public void setVariant(java.util.Set scope,
                       java.lang.String name)
                throws TopicMapException

Description copied from class: Topic

Sets the variant with the specified scope. Will overwrite previous value if there already is a variant name with the specified scope.

Overrides:

setVariant in class TopicImpl

Throws:

TopicMapException

mergeIn

public void mergeIn(Topic t)
             throws TopicMapException

Overrides:

mergeIn in class TopicImpl

Throws:

TopicMapException

addSubjectIdentifier

public void addSubjectIdentifier(Locator l)
                          throws TopicMapException

Description copied from class: Topic

Adds a subject identifier for the topic. This may cause a topic merge.

Overrides:

addSubjectIdentifier in class TopicImpl

Throws:

TopicMapException

addType

public void addType(Topic t)
             throws TopicMapException

Description copied from class: Topic

Adds a topic type. If topic already has that type, does nothing.

Overrides:

addType in class TopicImpl

Throws:

TopicMapException

removeSubjectIdentifier

public void removeSubjectIdentifier(Locator l)
                             throws TopicMapException

Description copied from class: Topic

Removes a subject identifier.

Overrides:

removeSubjectIdentifier in class TopicImpl

Throws:

TopicMapException

removeType

public void removeType(Topic t)
                throws TopicMapException

Description copied from class: Topic

Removes a topic type. If topic is not of the specified type, does nothing.

Overrides:

removeType in class TopicImpl

Throws:

TopicMapException

setSubjectLocator

public void setSubjectLocator(Locator l)
                       throws TopicMapException

Description copied from class: Topic

Sets the topic subject locator overwriting possible previous value.

Overrides:

setSubjectLocator in class TopicImpl

Throws:

TopicMapException

getAssociationsWithRole

public java.util.Collection getAssociationsWithRole()

Description copied from class: Topic

Gets associations that have this topic as role.

Overrides:

getAssociationsWithRole in class TopicImpl

getAssociationsWithType

public java.util.Collection getAssociationsWithType()

Description copied from class: Topic

Gets associations that have this topic as type.

Overrides:

getAssociationsWithType in class TopicImpl

getTopicsWithDataType

public java.util.Collection getTopicsWithDataType()

Description copied from class: Topic

Gets topics which have data with this topic as type.

Overrides:

getTopicsWithDataType in class TopicImpl