org.wandora.topicmap.linked

Class LinkedTopic

java.lang.Object

org.wandora.topicmap.Topic

org.wandora.topicmap.linked.LinkedTopic

public class LinkedTopic
extends Topic

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedTopicMap	topicMap
protected Topic	wrappedTopic

Constructor Summary

Constructors

Constructor and Description
LinkedTopic(Topic wrappedTopic, LinkedTopicMap topicMap)

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.
boolean	equals(java.lang.Object o)
java.util.Collection<Association>	getAssociations() Gets all associations where this topic is a player.
java.util.Collection<Association>	getAssociations(Topic type) Gets all associations of specified type where this topic is a player.
java.util.Collection<Association>	getAssociations(Topic type, Topic role) Gets associations of the specified type where this topic is in the specified role
java.util.Collection<Association>	getAssociationsWithRole() Gets associations that have this topic as role.
java.util.Collection<Association>	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<Topic,java.lang.String>	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<Topic>	getDataTypes() Gets all used data types.
long	getDependentEditTime()
long	getEditTime()
java.lang.String	getID() Gets the topic ID.
java.util.Collection<Locator>	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<Topic>	getTopicsWithDataType() Gets topics which have data with this topic as type.
java.util.Collection<Topic>	getTopicsWithDataVersion() Gets topics which have data with this topic as version.
java.util.Collection<Topic>	getTopicsWithVariantScope() Gets topics which have variants with this topic in scope.
java.util.Collection<Topic>	getTypes() Gets all topic types.
java.lang.String	getVariant(java.util.Set<Topic> scope) Gets a variant with the specified scope.
java.util.Set<java.util.Set<Topic>>	getVariantScopes() Gets the scopes of all variant names.
Topic	getWrappedTopic()
int	hashCode()
boolean	isDeleteAllowed() Returns true if and only if remove() can be called without it throwing TopicInUseException.
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.
void	remove() Removes this topic.
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<Topic> 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<Topic,java.lang.String> versionData) Sets several data values.
void	setData(Topic type, Topic version, java.lang.String value) Sets data with specified type and version.
void	setDependentEditTime(long time)
void	setEditTime(long time)
void	setSubjectLocator(Locator l) Sets the topic subject locator overwriting possible previous value.
void	setVariant(java.util.Set<Topic> scope, java.lang.String name) Sets the variant with the specified scope.

Methods inherited from class org.wandora.topicmap.Topic

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

wrappedTopic

protected Topic wrappedTopic

topicMap

protected LinkedTopicMap topicMap

Constructor Detail

LinkedTopic

public LinkedTopic(Topic wrappedTopic,
                   LinkedTopicMap topicMap)

Method Detail

getWrappedTopic

public Topic getWrappedTopic()

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.

Specified by:

addSubjectIdentifier in class Topic

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.

Specified by:

addType in class Topic

Throws:

TopicMapException

getAssociations

public java.util.Collection<Association> getAssociations()
                                                  throws TopicMapException

Description copied from class: Topic

Gets all associations where this topic is a player.

Specified by:

getAssociations in class Topic

Throws:

TopicMapException

getAssociations

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

Description copied from class: Topic

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

Specified by:

getAssociations in class Topic

Throws:

TopicMapException

getAssociations

public java.util.Collection<Association> 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

Specified by:

getAssociations in class Topic

Throws:

TopicMapException

getAssociationsWithRole

public java.util.Collection<Association> getAssociationsWithRole()
                                                          throws TopicMapException

Description copied from class: Topic

Gets associations that have this topic as role.

Specified by:

getAssociationsWithRole in class Topic

Throws:

TopicMapException

getAssociationsWithType

public java.util.Collection<Association> getAssociationsWithType()
                                                          throws TopicMapException

Description copied from class: Topic

Gets associations that have this topic as type.

Specified by:

getAssociationsWithType in class Topic

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.

Specified by:

getBaseName in class Topic

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.

Specified by:

getData in class Topic

Throws:

TopicMapException

getData

public java.util.Hashtable<Topic,java.lang.String> getData(Topic type)
                                                    throws TopicMapException

Description copied from class: Topic

Returns a Hashtable mapping data versions to data content.

Specified by:

getData in class Topic

Throws:

TopicMapException

getDataTypes

public java.util.Collection<Topic> getDataTypes()
                                         throws TopicMapException

Description copied from class: Topic

Gets all used data types.

Specified by:

getDataTypes in class Topic

Throws:

TopicMapException

getDependentEditTime

public long getDependentEditTime()
                          throws TopicMapException

Specified by:

getDependentEditTime in class Topic

Throws:

TopicMapException

getEditTime

public long getEditTime()
                 throws TopicMapException

Specified by:

getEditTime in class Topic

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.

Specified by:

getID in class Topic

Throws:

TopicMapException

getSubjectIdentifiers

public java.util.Collection<Locator> getSubjectIdentifiers()
                                                    throws TopicMapException

Description copied from class: Topic

Gets all subject identifiers of the topic.

Specified by:

getSubjectIdentifiers in class Topic

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.

Specified by:

getSubjectLocator in class Topic

Throws:

TopicMapException

getTopicMap

public TopicMap getTopicMap()

Description copied from class: Topic

Gets the topic map this topic belongs to.

Specified by:

getTopicMap in class Topic

getTopicsWithDataType

public java.util.Collection<Topic> getTopicsWithDataType()
                                                  throws TopicMapException

Description copied from class: Topic

Gets topics which have data with this topic as type.

Specified by:

getTopicsWithDataType in class Topic

Throws:

TopicMapException

getTopicsWithDataVersion

public java.util.Collection<Topic> getTopicsWithDataVersion()
                                                     throws TopicMapException

Description copied from class: Topic

Gets topics which have data with this topic as version.

Specified by:

getTopicsWithDataVersion in class Topic

Throws:

TopicMapException

getTopicsWithVariantScope

public java.util.Collection<Topic> getTopicsWithVariantScope()
                                                      throws TopicMapException

Description copied from class: Topic

Gets topics which have variants with this topic in scope.

Specified by:

getTopicsWithVariantScope in class Topic

Throws:

TopicMapException

getTypes

public java.util.Collection<Topic> getTypes()
                                     throws TopicMapException

Description copied from class: Topic

Gets all topic types.

Specified by:

getTypes in class Topic

Throws:

TopicMapException

getVariant

public java.lang.String getVariant(java.util.Set<Topic> 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.

Specified by:

getVariant in class Topic

Throws:

TopicMapException

getVariantScopes

public java.util.Set<java.util.Set<Topic>> getVariantScopes()
                                                     throws TopicMapException

Description copied from class: Topic

Gets the scopes of all variant names.

Specified by:

getVariantScopes in class Topic

Throws:

TopicMapException

isDeleteAllowed

public boolean isDeleteAllowed()
                        throws TopicMapException

Description copied from class: Topic

Returns true if and only if remove() can be called without it throwing TopicInUseException. This is exactly when this topic is not used in any association as the association type or role of any member, and this topic is not used in any topic in variant scope, data version, data type or topic type. This topic may however be used as a player of associations.

Specified by:

isDeleteAllowed in class Topic

Throws:

TopicMapException

isOfType

public boolean isOfType(Topic t)
                 throws TopicMapException

Description copied from class: Topic

Checks if this topic is of the specified type.

Specified by:

isOfType in class Topic

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.

Specified by:

isRemoved in class Topic

Throws:

TopicMapException

remove

public void remove()
            throws TopicMapException

Description copied from class: Topic

Removes this topic. If this topic is used in any association as the association type or role of any member or this topic is used in any topic in variant scope, data version, data type or topic type, a TopicInUseException is thrown. This topic may however be used as a player of associations. All such associations are deleted along with this topic.

Specified by:

remove in class Topic

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.

Specified by:

removeData in class Topic

Throws:

TopicMapException

removeData

public void removeData(Topic type)
                throws TopicMapException

Description copied from class: Topic

Removes all data with the specified type.

Specified by:

removeData in class Topic

Throws:

TopicMapException

removeSubjectIdentifier

public void removeSubjectIdentifier(Locator l)
                             throws TopicMapException

Description copied from class: Topic

Removes a subject identifier.

Specified by:

removeSubjectIdentifier in class Topic

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.

Specified by:

removeType in class Topic

Throws:

TopicMapException

removeVariant

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

Description copied from class: Topic

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

Specified by:

removeVariant in class Topic

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.

Specified by:

setBaseName in class Topic

Throws:

TopicMapException

setData

public void setData(Topic type,
                    java.util.Hashtable<Topic,java.lang.String> 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.

Specified by:

setData in class Topic

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.

Specified by:

setData in class Topic

Throws:

TopicMapException

setDependentEditTime

public void setDependentEditTime(long time)
                          throws TopicMapException

Specified by:

setDependentEditTime in class Topic

Throws:

TopicMapException

setEditTime

public void setEditTime(long time)
                 throws TopicMapException

Specified by:

setEditTime in class Topic

Throws:

TopicMapException

setSubjectLocator

public void setSubjectLocator(Locator l)
                       throws TopicMapException

Description copied from class: Topic

Sets the topic subject locator overwriting possible previous value.

Specified by:

setSubjectLocator in class Topic

Throws:

TopicMapException

setVariant

public void setVariant(java.util.Set<Topic> 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.

Specified by:

setVariant in class Topic

Throws:

TopicMapException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object