org.wandora.topicmap.database

Class DatabaseTopic

java.lang.Object

org.wandora.topicmap.Topic

org.wandora.topicmap.database.DatabaseTopic

public class DatabaseTopic
extends Topic

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DatabaseTopic.EqualAssociationWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseName
protected java.util.Hashtable<Topic,java.util.Hashtable<Topic,java.lang.String>>	data
protected boolean	dataFetched
protected boolean	full
protected java.lang.String	id
private static int	idcounter
protected boolean	removed
protected boolean	sisFetched
protected java.lang.ref.WeakReference<java.util.Hashtable<Topic,java.util.Hashtable<Topic,java.util.Collection<Association>>>>	storedAssociations
protected java.util.HashSet<Locator>	subjectIdentifiers
protected Locator	subjectLocator
protected DatabaseTopicMap	topicMap
protected java.util.HashSet<Topic>	types
protected boolean	typesFetched
protected java.util.Hashtable<java.util.Set<Topic>,Tuples.T2<java.lang.String,java.lang.String>>	variants
protected boolean	variantsFetched

Constructor Summary

Constructors

Constructor and Description
DatabaseTopic(DatabaseTopicMap tm) Creates a new instance of DatabaseTopic
DatabaseTopic(java.util.Map<java.lang.String,java.lang.Object> row, DatabaseTopicMap tm)
DatabaseTopic(java.lang.Object baseName, java.lang.Object subjectLocator, java.lang.Object id, DatabaseTopicMap tm)
DatabaseTopic(java.lang.String id, DatabaseTopicMap tm)

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.
(package private) void	associationChanged(DatabaseAssociation a, Topic type, Topic oldType, Topic role, Topic oldRole)
(package private) void	create() Inserts a new topic in the database with the data currently set in this DatabaseTopic object.
protected java.lang.String	escapeSQL(java.lang.String s)
(package private) static void	fetchAllSubjectIdentifiers(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> res, java.util.Map<java.lang.String,DatabaseTopic> topics, DatabaseTopicMap topicMap)
protected java.util.Hashtable<Topic,java.util.Hashtable<Topic,java.util.Collection<Association>>>	fetchAssociations()
protected void	fetchData()
protected void	fetchSubjectIdentifiers()
protected void	fetchTypes()
protected void	fetchVariants()
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.
(package private) void	initialize(java.lang.Object baseName, java.lang.Object subjectLocator)
(package private) void	initialize(java.lang.String baseName, java.lang.String subjectLocator) Initializes this DatabaseTopic object setting the basename and subject locator but does not modify the actual database.
protected void	internalSetBaseName(java.lang.String bn) Sets the base name in this DatabaseTopic object but does not modify the database.
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.
(package private) void	makeFull() Fetch all information from database that hasn't already been fetched.
protected static java.lang.String	makeID() Makes an ID string that can be used as an identifier in the database.
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	removeDuplicateAssociations()
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)
protected void	setSubjectIdentifiers(java.util.HashSet<Locator> sis) Sets subject identifiers in this DatabaseTopic but does not modify the underlying database.
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

full

protected boolean full

sisFetched

protected boolean sisFetched

dataFetched

protected boolean dataFetched

variantsFetched

protected boolean variantsFetched

typesFetched

protected boolean typesFetched

topicMap

protected DatabaseTopicMap topicMap

baseName

protected java.lang.String baseName

id

protected java.lang.String id

subjectLocator

protected Locator subjectLocator

subjectIdentifiers

protected java.util.HashSet<Locator> subjectIdentifiers

data

protected java.util.Hashtable<Topic,java.util.Hashtable<Topic,java.lang.String>> data

variants

protected java.util.Hashtable<java.util.Set<Topic>,Tuples.T2<java.lang.String,java.lang.String>> variants

types

protected java.util.HashSet<Topic> types

storedAssociations

protected java.lang.ref.WeakReference<java.util.Hashtable<Topic,java.util.Hashtable<Topic,java.util.Collection<Association>>>> storedAssociations

removed

protected boolean removed

idcounter

private static int idcounter

Constructor Detail

DatabaseTopic

public DatabaseTopic(DatabaseTopicMap tm)

Creates a new instance of DatabaseTopic

DatabaseTopic

public DatabaseTopic(java.lang.String id,
                     DatabaseTopicMap tm)

DatabaseTopic

public DatabaseTopic(java.util.Map<java.lang.String,java.lang.Object> row,
                     DatabaseTopicMap tm)
              throws TopicMapException

Throws:

TopicMapException

DatabaseTopic

public DatabaseTopic(java.lang.Object baseName,
                     java.lang.Object subjectLocator,
                     java.lang.Object id,
                     DatabaseTopicMap tm)
              throws TopicMapException

Throws:

TopicMapException

Method Detail

initialize

void initialize(java.lang.Object baseName,
                java.lang.Object subjectLocator)
         throws TopicMapException

Throws:

TopicMapException

initialize

void initialize(java.lang.String baseName,
                java.lang.String subjectLocator)
         throws TopicMapException

Initializes this DatabaseTopic object setting the basename and subject locator but does not modify the actual database.

Throws:

TopicMapException

internalSetBaseName

protected void internalSetBaseName(java.lang.String bn)
                            throws TopicMapException

Sets the base name in this DatabaseTopic object but does not modify the database.

Throws:

TopicMapException

makeID

protected static java.lang.String makeID()

Makes an ID string that can be used as an identifier in the database. It will be unique if all identifiers are generated using the same Java virtual machine but if they are being generated by several virtual machine collisions may occur, however they will be extremely unlikely.

create

void create()
     throws TopicMapException

Inserts a new topic in the database with the data currently set in this DatabaseTopic object. A new DatabaseTopic is not inserted in the database until this method is called.

Throws:

TopicMapException

escapeSQL

protected java.lang.String escapeSQL(java.lang.String s)

setSubjectIdentifiers

protected void setSubjectIdentifiers(java.util.HashSet<Locator> sis)

Sets subject identifiers in this DatabaseTopic but does not modify the underlying database.

fetchSubjectIdentifiers

protected void fetchSubjectIdentifiers()
                                throws TopicMapException

Throws:

TopicMapException

fetchData

protected void fetchData()
                  throws TopicMapException

Throws:

TopicMapException

fetchVariants

protected void fetchVariants()
                      throws TopicMapException

Throws:

TopicMapException

fetchTypes

protected void fetchTypes()
                   throws TopicMapException

Throws:

TopicMapException

fetchAllSubjectIdentifiers

static void fetchAllSubjectIdentifiers(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> res,
                                       java.util.Map<java.lang.String,DatabaseTopic> topics,
                                       DatabaseTopicMap topicMap)
                                throws TopicMapException

Throws:

TopicMapException

fetchAssociations

protected java.util.Hashtable<Topic,java.util.Hashtable<Topic,java.util.Collection<Association>>> fetchAssociations()
                                                                                                             throws TopicMapException

Throws:

TopicMapException

makeFull

void makeFull()
       throws TopicMapException

Fetch all information from database that hasn't already been fetched.

Throws:

TopicMapException

getID

public java.lang.String getID()

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

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

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

mergeIn

public void mergeIn(Topic t)
             throws TopicMapException

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

getBaseName

public java.lang.String getBaseName()

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

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

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

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

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

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

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

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

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

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

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

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

getSubjectLocator

public Locator getSubjectLocator()

Description copied from class: Topic

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

Specified by:

getSubjectLocator in class Topic

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

getTopicMap

public TopicMap getTopicMap()

Description copied from class: Topic

Gets the topic map this topic belongs to.

Specified by:

getTopicMap in class Topic

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

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

getEditTime

public long getEditTime()

Specified by:

getEditTime in class Topic

setEditTime

public void setEditTime(long time)

Specified by:

setEditTime in class Topic

getDependentEditTime

public long getDependentEditTime()

Specified by:

getDependentEditTime in class Topic

setDependentEditTime

public void setDependentEditTime(long time)

Specified by:

setDependentEditTime in class Topic

isRemoved

public boolean isRemoved()

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

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

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

associationChanged

void associationChanged(DatabaseAssociation a,
                        Topic type,
                        Topic oldType,
                        Topic role,
                        Topic oldRole)

removeDuplicateAssociations

void removeDuplicateAssociations()
                          throws TopicMapException

Throws:

TopicMapException