org.wandora.topicmap.memory

Class TopicImpl

java.lang.Object

org.wandora.topicmap.Topic

org.wandora.topicmap.memory.TopicImpl

Direct Known Subclasses:

RemoteTopic

public class TopicImpl
extends Topic

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TopicImpl.EqualAssociationWrapper
private static class	TopicImpl.ScopeComparator
private static class	TopicImpl.TopicComparator

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<Topic,java.util.Map<Topic,java.util.Collection<Association>>>	associationIndex
private java.util.Set<Association>	associations
private java.util.Set<Association>	associationTypeIndex
private java.lang.String	baseName
private java.util.Map<Topic,java.util.Map<Topic,java.lang.String>>	data
private java.util.Set<Topic>	dataTypeIndex
private java.util.Set<DataVersionIndexWrapper>	dataVersionIndex
private boolean	denyRemoveIfCoreTopic
private long	dependentEditTime
private java.util.Set<Topic>	dependentTopics
private java.util.Map<java.lang.String,java.lang.String>	dispNameCache
private long	editTime
private java.lang.String	id
private static long	idcounter
private boolean	removed
private java.util.Set<Association>	roleTypeIndex
private java.util.Map<java.lang.String,java.lang.String>	sortNameCache
private java.util.Set<Locator>	subjectIdentifiers
private Locator	subjectLocator
private TopicMapImpl	topicMap
private java.util.Set<Topic>	topicTypeIndex
private java.util.Set<Topic>	types
private java.util.Map<java.util.Set<Topic>,java.lang.String>	variants
private java.util.Set<Topic>	variantScopeIndex

Constructor Summary

Constructors

Constructor and Description
TopicImpl(java.lang.String id, TopicMapImpl topicMap) Creates a new instance of TopicImpl
TopicImpl(TopicMapImpl topicMap) Creates a new instance of TopicImpl

Method Summary

Modifier and Type	Method and Description
(package private) void	addedAsAssociationType(Association a)
(package private) void	addedAsDataType(Topic t)
(package private) void	addedAsDataVersion(Topic t, Topic type)
(package private) void	addedAsRoleType(Association a)
(package private) void	addedAsTopicType(Topic t)
(package private) void	addedAsVariantScope(Topic t)
(package private) void	addInAssociation(Association a, Topic role)
void	addSubjectIdentifier(Locator l) Adds a subject identifier for the topic.
void	addType(Topic t) Adds a topic type.
(package private) void	associationTypeChanged(Association a, Topic type, Topic oldType, Topic role)
void	clearNameCaches()
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	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()
java.lang.String	getDisplayName(java.lang.String lang) Gets a name suitable for display in the specified language.
long	getEditTime()
java.lang.String	getID() Gets the topic ID.
java.lang.String	getSortName(java.lang.String lang) Gets a name suitable for sorting in the specified language.
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<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.
static java.lang.String	getUniqueID()
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.
private void	initializeTopicImpl()
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	makeDependentTopicsSet()
void	mergeIn(Topic t)
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.
(package private) void	removedFromAssociationType(Association a)
(package private) void	removedFromDataType(Topic t)
(package private) void	removedFromDataVersion(Topic t, Topic type)
(package private) void	removedFromRoleType(Association a)
(package private) void	removedFromTopicType(Topic t)
(package private) void	removedFromVariantScope(Topic t)
(package private) void	removeDuplicateAssociations()
(package private) void	removeDuplicateAssociations(Association notThis) Deletes duplicate associations but does not delete the one given as parameter.
(package private) void	removeFromAssociation(Association a, Topic role, boolean otherRoles)
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.
private void	updateDependentEditTime()
private void	updateEditTime()

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 TopicMapImpl topicMap

data

private java.util.Map<Topic,java.util.Map<Topic,java.lang.String>> data

types

private java.util.Set<Topic> types

associations

private java.util.Set<Association> associations

associationIndex

private java.util.Map<Topic,java.util.Map<Topic,java.util.Collection<Association>>> associationIndex

baseName

private java.lang.String baseName

subjectLocator

private Locator subjectLocator

subjectIdentifiers

private java.util.Set<Locator> subjectIdentifiers

variants

private java.util.Map<java.util.Set<Topic>,java.lang.String> variants

dataTypeIndex

private java.util.Set<Topic> dataTypeIndex

dataVersionIndex

private java.util.Set<DataVersionIndexWrapper> dataVersionIndex

topicTypeIndex

private java.util.Set<Topic> topicTypeIndex

associationTypeIndex

private java.util.Set<Association> associationTypeIndex

roleTypeIndex

private java.util.Set<Association> roleTypeIndex

variantScopeIndex

private java.util.Set<Topic> variantScopeIndex

dependentTopics

private java.util.Set<Topic> dependentTopics

id

private java.lang.String id

removed

private boolean removed

denyRemoveIfCoreTopic

private boolean denyRemoveIfCoreTopic

editTime

private long editTime

dependentEditTime

private long dependentEditTime

dispNameCache

private java.util.Map<java.lang.String,java.lang.String> dispNameCache

sortNameCache

private java.util.Map<java.lang.String,java.lang.String> sortNameCache

idcounter

private static long idcounter

Constructor Detail

TopicImpl

public TopicImpl(java.lang.String id,
                 TopicMapImpl topicMap)

Creates a new instance of TopicImpl

TopicImpl

public TopicImpl(TopicMapImpl topicMap)

Creates a new instance of TopicImpl

Method Detail

initializeTopicImpl

private void initializeTopicImpl()

clearNameCaches

public void clearNameCaches()

getDisplayName

public java.lang.String getDisplayName(java.lang.String lang)
                                throws TopicMapException

Description copied from class: Topic

Gets a name suitable for display in the specified language. This method will call getName with a scope containing the display topic and the language topic of the specified language. Will first try to get a variant with this exact scope but if one is not found, may return a variant with almost this scope or base name or subject identifier.

Overrides:

getDisplayName in class Topic

Throws:

TopicMapException

getSortName

public java.lang.String getSortName(java.lang.String lang)
                             throws TopicMapException

Description copied from class: Topic

Gets a name suitable for sorting in the specified language. This method will call getName with a scope containing the sort topic and the language topic of the specified language. Will first try to get a variant with this exact scope but if one is not found, may return a variant with almost this scope or base name or subject identifier.

Overrides:

getSortName in class Topic

Throws:

TopicMapException

getUniqueID

public static java.lang.String getUniqueID()

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

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

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

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

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 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

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

getSubjectIdentifiers

public java.util.Collection getSubjectIdentifiers()
                                           throws TopicMapException

Description copied from class: Topic

Gets all subject identifiers of the topic.

Specified by:

getSubjectIdentifiers 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

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

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

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

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

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

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

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

getEditTime

public long getEditTime()
                 throws TopicMapException

Specified by:

getEditTime in class Topic

Throws:

TopicMapException

setEditTime

public void setEditTime(long time)
                 throws TopicMapException

Specified by:

setEditTime 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

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

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

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

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

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

isDeleteAllowed

public boolean isDeleteAllowed()
                        throws TopicMapException

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

Specified by:

isDeleteAllowed in class Topic

Returns:

Throws:

TopicMapException

getDependentEditTime

public long getDependentEditTime()
                          throws TopicMapException

Specified by:

getDependentEditTime in class Topic

Throws:

TopicMapException

setDependentEditTime

public void setDependentEditTime(long time)
                          throws TopicMapException

Specified by:

setDependentEditTime in class Topic

Throws:

TopicMapException

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

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

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

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

makeDependentTopicsSet

private void makeDependentTopicsSet()
                             throws TopicMapException

Throws:

TopicMapException

updateEditTime

private void updateEditTime()
                     throws TopicMapException

Throws:

TopicMapException

updateDependentEditTime

private void updateDependentEditTime()
                              throws TopicMapException

Throws:

TopicMapException

mergeIn

public void mergeIn(Topic t)
             throws TopicMapException

Throws:

TopicMapException

removeDuplicateAssociations

void removeDuplicateAssociations()
                          throws TopicMapException

Throws:

TopicMapException

removeDuplicateAssociations

void removeDuplicateAssociations(Association notThis)
                          throws TopicMapException

Deletes duplicate associations but does not delete the one given as parameter. If duplicate associations are found and the one given as parameter is one of them, then the parameter will remain in the topic map and other equal associations are deleted. If parameter is null, or when parameter is none of the equal associations, then the one that remains in topic map is chosen arbitrarily

Throws:

TopicMapException

addInAssociation

void addInAssociation(Association a,
                      Topic role)
               throws TopicMapException

Throws:

TopicMapException

removeFromAssociation

void removeFromAssociation(Association a,
                           Topic role,
                           boolean otherRoles)
                    throws TopicMapException

Throws:

TopicMapException

associationTypeChanged

void associationTypeChanged(Association a,
                            Topic type,
                            Topic oldType,
                            Topic role)

addedAsTopicType

void addedAsTopicType(Topic t)

removedFromTopicType

void removedFromTopicType(Topic t)

addedAsDataType

void addedAsDataType(Topic t)

removedFromDataType

void removedFromDataType(Topic t)

addedAsDataVersion

void addedAsDataVersion(Topic t,
                        Topic type)

removedFromDataVersion

void removedFromDataVersion(Topic t,
                            Topic type)

addedAsAssociationType

void addedAsAssociationType(Association a)

removedFromAssociationType

void removedFromAssociationType(Association a)

addedAsRoleType

void addedAsRoleType(Association a)

removedFromRoleType

void removedFromRoleType(Association a)

addedAsVariantScope

void addedAsVariantScope(Topic t)

removedFromVariantScope

void removedFromVariantScope(Topic t)