Topic (Wandora - Javadocs)

java.lang.Object
- org.wandora.topicmap.Topic

Direct Known Subclasses:

DatabaseTopic, DatabaseTopic, LayeredTopic, LinkedTopic, QueryTopic, T2WTopic, TopicImpl, UndoTopic, WebServiceTopic
```
public abstract class Topic
extends java.lang.Object
```
The abstract Topic class. Each topic implementation should extend this class.
Note that you should not store Topic objects except for very short times. Topics may be removed or merged at any time and the topic objects will become invalid. If you are doing something where this can happen, be sure to check if the topic is invalid with the isRemoved method. If it returns true, the topic may have been removed from the topic map or it might have been merged with some other topic. You can get this possible other topic with TopicMap.getTopic which will need the subject identifier of the topic, which means that usually it is better to just store the subject identifiers instead of the topics in the first place.
Many methods may cause topic merges in the topic map. Such methods include addSubjectIdentifier, setBaseName and setSubjectLocator. If a merge occurs, the merge will be handled in such a way that the object whose method was called will stay a valid topic object. In other words, other merging topics will be merged into it instead of the other way around.

Author:

olli

Constructor Summary

Constructors
Constructor and Description

Topic()

Constructors
Constructor and Description
`Topic()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`addSubjectIdentifier(Locator l)` Adds a subject identifier for the topic.
`abstract void`	`addType(Topic t)` Adds a topic type.
`abstract java.util.Collection<Association>`	`getAssociations()` Gets all associations where this topic is a player.
`abstract java.util.Collection<Association>`	`getAssociations(Topic type)` Gets all associations of specified type where this topic is a player.
`abstract java.util.Collection<Association>`	`getAssociations(Topic type, Topic role)` Gets associations of the specified type where this topic is in the specified role
`abstract java.util.Collection<Association>`	`getAssociationsWithRole()` Gets associations that have this topic as role.
`abstract java.util.Collection<Association>`	`getAssociationsWithType()` Gets associations that have this topic as type.
`abstract java.lang.String`	`getBaseName()` Gets the topic base name or null if no base name has been set.
`abstract 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, java.lang.String lang)` Gets data with the specified type and language version.
`abstract java.lang.String`	`getData(Topic type, Topic version)` Gets data with the specified type and version.
`abstract java.util.Collection<Topic>`	`getDataTypes()` Gets all used data types.
`abstract long`	`getDependentEditTime()`
`java.lang.String`	`getDisplayName()` Gets a display name for English language.
`java.lang.String`	`getDisplayName(java.lang.String lang)` Gets a name suitable for display in the specified language.
`abstract long`	`getEditTime()`
`Locator`	`getFirstSubjectIdentifier()` Returns the subject identifier for the topic that is the first in lexicographical ordering.
`abstract java.lang.String`	`getID()` Gets the topic ID.
`java.lang.String`	`getName(java.util.Set scope)` Gets a name for the topic.
`Locator`	`getOneSubjectIdentifier()` Returns one of the subject identifiers of this topic or null if none exists.
`java.lang.String`	`getSortName(java.lang.String lang)` Gets a name suitable for sorting in the specified language.
`abstract java.util.Collection<Locator>`	`getSubjectIdentifiers()` Gets all subject identifiers of the topic.
`abstract Locator`	`getSubjectLocator()` Gets the topic subject locator or null if it has not been set.
`abstract TopicMap`	`getTopicMap()` Gets the topic map this topic belongs to.
`abstract java.util.Collection<Topic>`	`getTopicsWithDataType()` Gets topics which have data with this topic as type.
`abstract java.util.Collection<Topic>`	`getTopicsWithDataVersion()` Gets topics which have data with this topic as version.
`abstract java.util.Collection<Topic>`	`getTopicsWithVariantScope()` Gets topics which have variants with this topic in scope.
`abstract java.util.Collection<Topic>`	`getTypes()` Gets all topic types.
`abstract java.lang.String`	`getVariant(java.util.Set<Topic> scope)` Gets a variant with the specified scope.
`abstract java.util.Set<java.util.Set<Topic>>`	`getVariantScopes()` Gets the scopes of all variant names.
`abstract boolean`	`isDeleteAllowed()` Returns true if and only if remove() can be called without it throwing TopicInUseException.
`abstract boolean`	`isOfType(Topic t)` Checks if this topic is of the specified type.
`abstract boolean`	`isRemoved()` Returns true if this topic has been removed from the topic map it belonged to.
`boolean`	`mergesWithTopic(Topic topic)` Checks if this topic would merge with the topic given as parameter.
`abstract void`	`remove()` Removes this topic.
`abstract void`	`removeData(Topic type)` Removes all data with the specified type.
`abstract void`	`removeData(Topic type, Topic version)` Removes data with specified type and version.
`abstract void`	`removeSubjectIdentifier(Locator l)` Removes a subject identifier.
`abstract void`	`removeType(Topic t)` Removes a topic type.
`abstract void`	`removeVariant(java.util.Set<Topic> scope)` Removes a variant name with the specified scope.
`abstract void`	`setBaseName(java.lang.String name)` Sets the topic base name.
`abstract void`	`setData(Topic type, java.util.Hashtable<Topic,java.lang.String> versionData)` Sets several data values.
`abstract void`	`setData(Topic type, Topic version, java.lang.String value)` Sets data with specified type and version.
`abstract void`	`setDependentEditTime(long time)`
`void`	`setDisplayName(java.lang.String lang, java.lang.String name)` Sets a variant with scope containing the display topic and the language topic of the specified language.
`abstract void`	`setEditTime(long time)`
`abstract void`	`setSubjectLocator(Locator l)` Sets the topic subject locator overwriting possible previous value.
`abstract void`	`setVariant(java.util.Set<Topic> scope, java.lang.String name)` Sets the variant with the specified scope.
`java.lang.String`	`toString()` Gets name of this topic suitable for display.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Topic
```
public Topic()
```
- Method Detail
  - getID
```
public abstract java.lang.String getID()
                                throws TopicMapException
```
    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.
    
    Throws:
    
    TopicMapException
  - getSubjectIdentifiers
```
public abstract java.util.Collection<Locator> getSubjectIdentifiers()
                                                             throws TopicMapException
```
    Gets all subject identifiers of the topic.
    
    Throws:
    
    TopicMapException
  - addSubjectIdentifier
```
public abstract void addSubjectIdentifier(Locator l)
                                   throws TopicMapException
```
    Adds a subject identifier for the topic. This may cause a topic merge.
    
    Throws:
    
    TopicMapException
  - removeSubjectIdentifier
```
public abstract void removeSubjectIdentifier(Locator l)
                                      throws TopicMapException
```
    Removes a subject identifier.
    
    Throws:
    
    TopicMapException
  - getBaseName
```
public abstract java.lang.String getBaseName()
                                      throws TopicMapException
```
    Gets the topic base name or null if no base name has been set.
    
    Throws:
    
    TopicMapException
  - setBaseName
```
public abstract void setBaseName(java.lang.String name)
                          throws TopicMapException
```
    Sets the topic base name. This may cause a topic merge.
    
    Throws:
    
    TopicMapException
  - getTypes
```
public abstract java.util.Collection<Topic> getTypes()
                                              throws TopicMapException
```
    Gets all topic types.
    
    Throws:
    
    TopicMapException
  - addType
```
public abstract void addType(Topic t)
                      throws TopicMapException
```
    Adds a topic type. If topic already has that type, does nothing.
    
    Throws:
    
    TopicMapException
  - removeType
```
public abstract void removeType(Topic t)
                         throws TopicMapException
```
    Removes a topic type. If topic is not of the specified type, does nothing.
    
    Throws:
    
    TopicMapException
  - isOfType
```
public abstract boolean isOfType(Topic t)
                          throws TopicMapException
```
    Checks if this topic is of the specified type.
    
    Throws:
    
    TopicMapException
  - getVariant
```
public abstract java.lang.String getVariant(java.util.Set<Topic> scope)
                                     throws TopicMapException
```
    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.
    
    Throws:
    
    TopicMapException
  - setVariant
```
public abstract void setVariant(java.util.Set<Topic> scope,
                                java.lang.String name)
                         throws TopicMapException
```
    Sets the variant with the specified scope. Will overwrite previous value if there already is a variant name with the specified scope.
    
    Throws:
    
    TopicMapException
  - getVariantScopes
```
public abstract java.util.Set<java.util.Set<Topic>> getVariantScopes()
                                                              throws TopicMapException
```
    Gets the scopes of all variant names.
    
    Throws:
    
    TopicMapException
  - removeVariant
```
public abstract void removeVariant(java.util.Set<Topic> scope)
                            throws TopicMapException
```
    Removes a variant name with the specified scope. If no such variant exists, does nothing.
    
    Throws:
    
    TopicMapException
  - getData
```
public abstract java.lang.String getData(Topic type,
                                         Topic version)
                                  throws TopicMapException
```
    Gets data with the specified type and version. Returns null if data is not found.
    
    Throws:
    
    TopicMapException
  - getData
```
public abstract java.util.Hashtable<Topic,java.lang.String> getData(Topic type)
                                                             throws TopicMapException
```
    Returns a Hashtable mapping data versions to data content.
    
    Throws:
    
    TopicMapException
  - getDataTypes
```
public abstract java.util.Collection<Topic> getDataTypes()
                                                  throws TopicMapException
```
    Gets all used data types.
    
    Throws:
    
    TopicMapException
  - setData
```
public abstract void setData(Topic type,
                             java.util.Hashtable<Topic,java.lang.String> versionData)
                      throws TopicMapException
```
    Sets several data values. Each value is set with same type, the other parameter should contain versions mapped to the actual values.
    
    Throws:
    
    TopicMapException
  - setData
```
public abstract void setData(Topic type,
                             Topic version,
                             java.lang.String value)
                      throws TopicMapException
```
    Sets data with specified type and version.
    
    Throws:
    
    TopicMapException
  - removeData
```
public abstract void removeData(Topic type,
                                Topic version)
                         throws TopicMapException
```
    Removes data with specified type and version. If no such data value is set, does nothing.
    
    Throws:
    
    TopicMapException
  - removeData
```
public abstract void removeData(Topic type)
                         throws TopicMapException
```
    Removes all data with the specified type.
    
    Throws:
    
    TopicMapException
  - getSubjectLocator
```
public abstract Locator getSubjectLocator()
                                   throws TopicMapException
```
    Gets the topic subject locator or null if it has not been set.
    
    Throws:
    
    TopicMapException
  - setSubjectLocator
```
public abstract void setSubjectLocator(Locator l)
                                throws TopicMapException
```
    Sets the topic subject locator overwriting possible previous value.
    
    Throws:
    
    TopicMapException
  - getTopicMap
```
public abstract TopicMap getTopicMap()
```
    Gets the topic map this topic belongs to.
  - getAssociations
```
public abstract java.util.Collection<Association> getAssociations()
                                                           throws TopicMapException
```
    Gets all associations where this topic is a player.
    
    Throws:
    
    TopicMapException
  - getAssociations
```
public abstract java.util.Collection<Association> getAssociations(Topic type)
                                                           throws TopicMapException
```
    Gets all associations of specified type where this topic is a player.
    
    Throws:
    
    TopicMapException
  - getAssociations
```
public abstract java.util.Collection<Association> getAssociations(Topic type,
                                                                  Topic role)
                                                           throws TopicMapException
```
    Gets associations of the specified type where this topic is in the specified role
    
    Throws:
    
    TopicMapException
  - remove
```
public abstract void remove()
                     throws TopicMapException
```
    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.
    
    Throws:
    
    TopicMapException
  - getEditTime
```
public abstract long getEditTime()
                          throws TopicMapException
```
    Throws:
    
    TopicMapException
  - setEditTime
```
public abstract void setEditTime(long time)
                          throws TopicMapException
```
    Throws:
    
    TopicMapException
  - getDependentEditTime
```
public abstract long getDependentEditTime()
                                   throws TopicMapException
```
    Throws:
    
    TopicMapException
  - setDependentEditTime
```
public abstract void setDependentEditTime(long time)
                                   throws TopicMapException
```
    Throws:
    
    TopicMapException
  - isRemoved
```
public abstract boolean isRemoved()
                           throws TopicMapException
```
    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.
    
    Throws:
    
    TopicMapException
  - isDeleteAllowed
```
public abstract boolean isDeleteAllowed()
                                 throws TopicMapException
```
    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.
    
    Throws:
    
    TopicMapException
  - getTopicsWithDataType
```
public abstract java.util.Collection<Topic> getTopicsWithDataType()
                                                           throws TopicMapException
```
    Gets topics which have data with this topic as type.
    
    Throws:
    
    TopicMapException
  - getTopicsWithDataVersion
```
public abstract java.util.Collection<Topic> getTopicsWithDataVersion()
                                                              throws TopicMapException
```
    Gets topics which have data with this topic as version.
    
    Throws:
    
    TopicMapException
  - getAssociationsWithType
```
public abstract java.util.Collection<Association> getAssociationsWithType()
                                                                   throws TopicMapException
```
    Gets associations that have this topic as type.
    
    Throws:
    
    TopicMapException
  - getAssociationsWithRole
```
public abstract java.util.Collection<Association> getAssociationsWithRole()
                                                                   throws TopicMapException
```
    Gets associations that have this topic as role.
    
    Throws:
    
    TopicMapException
  - getTopicsWithVariantScope
```
public abstract java.util.Collection<Topic> getTopicsWithVariantScope()
                                                               throws TopicMapException
```
    Gets topics which have variants with this topic in scope.
    
    Throws:
    
    TopicMapException
  - getData
```
public java.lang.String getData(Topic type,
                                java.lang.String lang)
                         throws TopicMapException
```
    Gets data with the specified type and language version. If data with the specified language is not found tries to get data with language independent version (WandoraManage.LANGINDEPENDENT_SI). If that is not found tries to get data of the specified type with any version. Use getData(Topic,Topic) to get the data with specified type and version or null if it does not exist.
    
    Throws:
    
    TopicMapException
  - setDisplayName
```
public void setDisplayName(java.lang.String lang,
                           java.lang.String name)
                    throws TopicMapException
```
    Sets a variant with scope containing the display topic and the language topic of the specified language.
    
    Throws:
    
    TopicMapException
  - getDisplayName
```
public java.lang.String getDisplayName()
                                throws TopicMapException
```
    Gets a display name for English language. Calls getDisplayName(String) with parameter "en".
    
    Throws:
    
    TopicMapException
    
    See Also:
    
    getDisplayName(String)
  - getDisplayName
```
public java.lang.String getDisplayName(java.lang.String lang)
                                throws TopicMapException
```
    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.
    
    Throws:
    
    TopicMapException
  - getSortName
```
public java.lang.String getSortName(java.lang.String lang)
                             throws TopicMapException
```
    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.
    
    Throws:
    
    TopicMapException
  - getName
```
public java.lang.String getName(java.util.Set scope)
                         throws TopicMapException
```
    Gets a name for the topic. Tries to get a name that matches the scope as much as possible. If a suitable name is not found in variants, returns the base name, if it is null returns one of the subject identifiers, if there is none returns "[unnamed]".
    
    Throws:
    
    TopicMapException
  - getOneSubjectIdentifier
```
public Locator getOneSubjectIdentifier()
                                throws TopicMapException
```
    Returns one of the subject identifiers of this topic or null if none exists.
    
    Throws:
    
    TopicMapException
  - getFirstSubjectIdentifier
```
public Locator getFirstSubjectIdentifier()
                                  throws TopicMapException
```
    Returns the subject identifier for the topic that is the first in lexicographical ordering. This guarantees that you'll always get the same subject identifier as long as the subject identifiers of the topic have not changed between calls. This can be desirable in some situations. However, there is a performance penalty in using this as opposed to getOneSubjectIdentifier.
    
    Throws:
    
    TopicMapException
  - mergesWithTopic
```
public boolean mergesWithTopic(Topic topic)
                        throws TopicMapException
```
    Checks if this topic would merge with the topic given as parameter. The topic given as parameter may be from this or another topic map.
    
    Throws:
    
    TopicMapException
  - toString
```
public java.lang.String toString()
```
    Gets name of this topic suitable for display. Uses getDisplayName to do this.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    getDisplayName()

Class Topic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Topic

Method Detail

getID

getSubjectIdentifiers

addSubjectIdentifier

removeSubjectIdentifier

getBaseName

setBaseName

getTypes

addType

removeType

isOfType

getVariant

setVariant

getVariantScopes

removeVariant

getData

getData

getDataTypes

setData

setData

removeData

removeData

getSubjectLocator

setSubjectLocator

getTopicMap

getAssociations

getAssociations

getAssociations

remove

getEditTime

setEditTime

getDependentEditTime

setDependentEditTime

isRemoved

isDeleteAllowed

getTopicsWithDataType

getTopicsWithDataVersion

getAssociationsWithType

getAssociationsWithRole

getTopicsWithVariantScope

getData

setDisplayName

getDisplayName

getDisplayName

getSortName

getName

getOneSubjectIdentifier

getFirstSubjectIdentifier

mergesWithTopic

toString