org.wandora.topicmap.wandora2tmapi

Class W2TTopicMap

java.lang.Object

org.wandora.topicmap.wandora2tmapi.W2TTopicMap

All Implemented Interfaces:

org.tmapi.core.Construct, org.tmapi.core.Reifiable, org.tmapi.core.TopicMap

public class W2TTopicMap
extends java.lang.Object
implements org.tmapi.core.TopicMap

This is a TMAPI topic map implementation which wraps inside it a Wandora TopicMap. The implementation does support both reading and writing, but there are several restrictions in how the topic map can be written to. These have to do with restrictions in Wandora's topic map model compared to the standard TMDM used by TMAPI. Some structures allowed in TMDM cannot be easily converted to Wandora's data model, UnsupportedOperationExceptions are thrown in such cases.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	W2TTopicMap.W2TScopedIndex
private class	W2TTopicMap.W2TTypeInstanceIndex

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TM_LOCATOR
protected W2TLocator	locator
protected TopicMap	original
protected LayerStack	tm
static java.lang.String	TOPIC_NAME_SI
static java.lang.String	TYPE_STRING_SI

Constructor Summary

Constructors

Constructor and Description
W2TTopicMap(TopicMap tm)

Method Summary

Modifier and Type	Method and Description
protected void	addCompatibilityLayer()
void	addItemIdentifier(org.tmapi.core.Locator lctr)
void	clear()
void	close()
org.tmapi.core.Association	createAssociation(org.tmapi.core.Topic type, java.util.Collection<org.tmapi.core.Topic> scope)
org.tmapi.core.Association	createAssociation(org.tmapi.core.Topic type, org.tmapi.core.Topic... scope)
org.tmapi.core.Locator	createLocator(java.lang.String string)
org.tmapi.core.Topic	createTopic()
org.tmapi.core.Topic	createTopicByItemIdentifier(org.tmapi.core.Locator lctr)
org.tmapi.core.Topic	createTopicBySubjectIdentifier(org.tmapi.core.Locator lctr)
org.tmapi.core.Topic	createTopicBySubjectLocator(org.tmapi.core.Locator lctr)
java.util.Set<org.tmapi.core.Association>	getAssociations()
org.tmapi.core.Construct	getConstructById(java.lang.String string)
org.tmapi.core.Construct	getConstructByItemIdentifier(org.tmapi.core.Locator lctr)
java.lang.String	getId()
<I extends org.tmapi.index.Index> I	getIndex(java.lang.Class<I> type)
java.util.Set<org.tmapi.core.Locator>	getItemIdentifiers()
org.tmapi.core.Locator	getLocator()
org.tmapi.core.Construct	getParent()
org.tmapi.core.Topic	getReifier()
org.tmapi.core.Topic	getTopicBySubjectIdentifier(org.tmapi.core.Locator lctr)
org.tmapi.core.Topic	getTopicBySubjectIdentifier(java.lang.String si)
org.tmapi.core.Topic	getTopicBySubjectLocator(org.tmapi.core.Locator lctr)
org.tmapi.core.TopicMap	getTopicMap()
java.util.Set<org.tmapi.core.Topic>	getTopics()
void	mergeIn(org.tmapi.core.TopicMap tm)
void	remove()
void	removeItemIdentifier(org.tmapi.core.Locator lctr)
void	setLocator(W2TLocator locator)
void	setReifier(org.tmapi.core.Topic topic)
java.util.Set<org.tmapi.core.Association>	wrapAssociations(java.util.Collection<Association> associations)
java.util.Set<org.tmapi.core.Locator>	wrapLocators(java.util.Collection<Locator> locators)
java.util.Set<org.tmapi.core.Topic>	wrapTopics(java.util.Collection<Topic> topics)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tmapi.core.Construct

equals, hashCode

Field Detail

DEFAULT_TM_LOCATOR

public static final java.lang.String DEFAULT_TM_LOCATOR

See Also:

Constant Field Values

original

protected TopicMap original

tm

protected LayerStack tm

locator

protected W2TLocator locator

TOPIC_NAME_SI

public static final java.lang.String TOPIC_NAME_SI

See Also:

Constant Field Values

TYPE_STRING_SI

public static final java.lang.String TYPE_STRING_SI

See Also:

Constant Field Values

Constructor Detail

W2TTopicMap

public W2TTopicMap(TopicMap tm)
            throws TopicMapException

Throws:

TopicMapException

Method Detail

addCompatibilityLayer

protected void addCompatibilityLayer()
                              throws TopicMapException

Throws:

TopicMapException

wrapTopics

public java.util.Set<org.tmapi.core.Topic> wrapTopics(java.util.Collection<Topic> topics)

wrapLocators

public java.util.Set<org.tmapi.core.Locator> wrapLocators(java.util.Collection<Locator> locators)

wrapAssociations

public java.util.Set<org.tmapi.core.Association> wrapAssociations(java.util.Collection<Association> associations)

getParent

public org.tmapi.core.Construct getParent()

Specified by:

getParent in interface org.tmapi.core.Construct

Specified by:

getParent in interface org.tmapi.core.TopicMap

getTopics

public java.util.Set<org.tmapi.core.Topic> getTopics()

Specified by:

getTopics in interface org.tmapi.core.TopicMap

getLocator

public org.tmapi.core.Locator getLocator()

Specified by:

getLocator in interface org.tmapi.core.TopicMap

setLocator

public void setLocator(W2TLocator locator)

getAssociations

public java.util.Set<org.tmapi.core.Association> getAssociations()

Specified by:

getAssociations in interface org.tmapi.core.TopicMap

getTopicBySubjectIdentifier

public org.tmapi.core.Topic getTopicBySubjectIdentifier(org.tmapi.core.Locator lctr)

Specified by:

getTopicBySubjectIdentifier in interface org.tmapi.core.TopicMap

getTopicBySubjectIdentifier

public org.tmapi.core.Topic getTopicBySubjectIdentifier(java.lang.String si)

getTopicBySubjectLocator

public org.tmapi.core.Topic getTopicBySubjectLocator(org.tmapi.core.Locator lctr)

Specified by:

getTopicBySubjectLocator in interface org.tmapi.core.TopicMap

getConstructByItemIdentifier

public org.tmapi.core.Construct getConstructByItemIdentifier(org.tmapi.core.Locator lctr)

Specified by:

getConstructByItemIdentifier in interface org.tmapi.core.TopicMap

getConstructById

public org.tmapi.core.Construct getConstructById(java.lang.String string)

Specified by:

getConstructById in interface org.tmapi.core.TopicMap

createLocator

public org.tmapi.core.Locator createLocator(java.lang.String string)
                                     throws org.tmapi.core.MalformedIRIException

Specified by:

createLocator in interface org.tmapi.core.TopicMap

Throws:

org.tmapi.core.MalformedIRIException

createTopicBySubjectIdentifier

public org.tmapi.core.Topic createTopicBySubjectIdentifier(org.tmapi.core.Locator lctr)
                                                    throws org.tmapi.core.ModelConstraintException

Specified by:

createTopicBySubjectIdentifier in interface org.tmapi.core.TopicMap

Throws:

org.tmapi.core.ModelConstraintException

createTopicBySubjectLocator

public org.tmapi.core.Topic createTopicBySubjectLocator(org.tmapi.core.Locator lctr)
                                                 throws org.tmapi.core.ModelConstraintException

Specified by:

createTopicBySubjectLocator in interface org.tmapi.core.TopicMap

Throws:

org.tmapi.core.ModelConstraintException

createTopicByItemIdentifier

public org.tmapi.core.Topic createTopicByItemIdentifier(org.tmapi.core.Locator lctr)
                                                 throws org.tmapi.core.IdentityConstraintException,
                                                        org.tmapi.core.ModelConstraintException

Specified by:

createTopicByItemIdentifier in interface org.tmapi.core.TopicMap

Throws:

org.tmapi.core.IdentityConstraintException

org.tmapi.core.ModelConstraintException

createTopic

public org.tmapi.core.Topic createTopic()

Specified by:

createTopic in interface org.tmapi.core.TopicMap

createAssociation

public org.tmapi.core.Association createAssociation(org.tmapi.core.Topic type,
                                                    org.tmapi.core.Topic... scope)
                                             throws org.tmapi.core.ModelConstraintException

Specified by:

createAssociation in interface org.tmapi.core.TopicMap

Throws:

org.tmapi.core.ModelConstraintException

createAssociation

public org.tmapi.core.Association createAssociation(org.tmapi.core.Topic type,
                                                    java.util.Collection<org.tmapi.core.Topic> scope)
                                             throws org.tmapi.core.ModelConstraintException

Specified by:

createAssociation in interface org.tmapi.core.TopicMap

Throws:

org.tmapi.core.ModelConstraintException

close

public void close()

Specified by:

close in interface org.tmapi.core.TopicMap

mergeIn

public void mergeIn(org.tmapi.core.TopicMap tm)
             throws org.tmapi.core.ModelConstraintException

Specified by:

mergeIn in interface org.tmapi.core.TopicMap

Throws:

org.tmapi.core.ModelConstraintException

getIndex

public <I extends org.tmapi.index.Index> I getIndex(java.lang.Class<I> type)

Specified by:

getIndex in interface org.tmapi.core.TopicMap

getReifier

public org.tmapi.core.Topic getReifier()

Specified by:

getReifier in interface org.tmapi.core.Reifiable

setReifier

public void setReifier(org.tmapi.core.Topic topic)
                throws org.tmapi.core.ModelConstraintException

Specified by:

setReifier in interface org.tmapi.core.Reifiable

Throws:

org.tmapi.core.ModelConstraintException

getTopicMap

public org.tmapi.core.TopicMap getTopicMap()

Specified by:

getTopicMap in interface org.tmapi.core.Construct

getId

public java.lang.String getId()

Specified by:

getId in interface org.tmapi.core.Construct

getItemIdentifiers

public java.util.Set<org.tmapi.core.Locator> getItemIdentifiers()

Specified by:

getItemIdentifiers in interface org.tmapi.core.Construct

addItemIdentifier

public void addItemIdentifier(org.tmapi.core.Locator lctr)
                       throws org.tmapi.core.ModelConstraintException

Specified by:

addItemIdentifier in interface org.tmapi.core.Construct

Throws:

org.tmapi.core.ModelConstraintException

removeItemIdentifier

public void removeItemIdentifier(org.tmapi.core.Locator lctr)

Specified by:

removeItemIdentifier in interface org.tmapi.core.Construct

remove

public void remove()

Specified by:

remove in interface org.tmapi.core.Construct

clear

public void clear()

Specified by:

clear in interface org.tmapi.core.TopicMap