Package net.ontopia.topicmaps.impl.utils
Class SnapshotTopicName
java.lang.Object
net.ontopia.topicmaps.impl.utils.SnapshotTMObject
net.ontopia.topicmaps.impl.utils.SnapshotTopicName
- All Implemented Interfaces:
NameIF,ReifiableIF,ScopedIF,TMObjectIF,TopicNameIF,TypedIF
INTERNAL:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected TopicIFprotected Collection<TopicIF>protected TopicIFprotected TopicIFprotected Stringprotected Collection<VariantNameIF>Fields inherited from class net.ontopia.topicmaps.impl.utils.SnapshotTMObject
objectId, SNAPSHOT_COMPLETE, SNAPSHOT_REFERENCE, snapshotType, srclocsFields inherited from interface net.ontopia.topicmaps.core.ReifiableIF
EVENT_SET_REIFIERFields inherited from interface net.ontopia.topicmaps.core.TMObjectIF
EVENT_ADD_ITEMIDENTIFIER, EVENT_REMOVE_ITEMIDENTIFIER, MSG_NULL_ARGUMENTFields inherited from interface net.ontopia.topicmaps.core.TopicNameIF
EVENT_ADD_THEME, EVENT_ADD_VARIANT, EVENT_ADDED, EVENT_REMOVE_THEME, EVENT_REMOVE_VARIANT, EVENT_REMOVED, EVENT_SET_TYPE, EVENT_SET_VALUE -
Method Summary
Modifier and TypeMethodDescriptionvoidPUBLIC: Add a topic to this scope.PUBLIC: Returns the topic that reifies this object.getScope()PUBLIC: Returns the set of topics that are the stated scope of this object.getTopic()PUBLIC: Gets the topic to which this name belongs.getType()PUBLIC: Gets the type that this object is an instance of.getValue()PUBLIC: Gets the value of this name.PUBLIC: Gets the variant names of the topic named by this topic name.static TopicNameIFmakeSnapshot(TopicNameIF original, int snapshotType, Map<TMObjectIF, SnapshotTMObject> processed) voidremoveTheme(TopicIF theme) PUBLIC: Remove a topic from this scope.voidsetReifier(TopicIF reifier) PUBLIC: Sets the reifier of this object.voidPUBLIC: Sets the type that this object is an instance of.voidPUBLIC: Sets the value of this topic name.toString()Methods inherited from class net.ontopia.topicmaps.impl.utils.SnapshotTMObject
addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, remove, removeItemIdentifierMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface net.ontopia.topicmaps.core.TMObjectIF
addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, remove, removeItemIdentifier
-
Field Details
-
reifier
-
topic
-
value
-
variants
-
scope
-
type
-
-
Method Details
-
makeSnapshot
public static TopicNameIF makeSnapshot(TopicNameIF original, int snapshotType, Map<TMObjectIF, SnapshotTMObject> processed) -
getTopic
Description copied from interface:NameIFPUBLIC: Gets the topic to which this name belongs. -
getValue
Description copied from interface:NameIFPUBLIC: Gets the value of this name. This corresponds to the content of the 'baseNameString' element in XTM 1.0, as a string. Where this method is implemented by an object implementing VariantNameIF, the contents of the 'variantName' element are returned instead. -
setValue
Description copied from interface:NameIFPUBLIC: Sets the value of this topic name. This corresponds to the content of the 'baseNameString' element in XTM 1.0, as a string. Where this method is implemented by an object implementing VariantNameIF, the contents of the 'variantName' element are returned instead. -
getVariants
Description copied from interface:TopicNameIFPUBLIC: Gets the variant names of the topic named by this topic name. These correspond to the 'variant' child elements of the 'baseName' element in XTM 1.0. There is no guarantee as to which order these appear in the collection.- Specified by:
getVariantsin interfaceTopicNameIF- Returns:
- A collection of VariantNameIF objects.
-
getScope
Description copied from interface:ScopedIFPUBLIC: Returns the set of topics that are the stated scope of this object. Scoping topics inherited from parent objects are not included. There is no guarantee as to which order these topics are returned in. -
addTheme
Description copied from interface:ScopedIFPUBLIC: Add a topic to this scope. (A topic used in a scope is also called a theme.) If the topic is already part of the scope the method call has no effect. -
removeTheme
Description copied from interface:ScopedIFPUBLIC: Remove a topic from this scope. If the topic is not already in the scope this method has no effect. (A topic used in a scope is also called a theme.)- Specified by:
removeThemein interfaceScopedIF- Parameters:
theme- A topic to be removed from this scope; an object implementing TopicIF.
-
getType
Description copied from interface:TypedIFPUBLIC: Gets the type that this object is an instance of. -
setType
Description copied from interface:TypedIFPUBLIC: Sets the type that this object is an instance of. -
getReifier
Description copied from interface:ReifiableIFPUBLIC: Returns the topic that reifies this object.- Specified by:
getReifierin interfaceReifiableIF
-
setReifier
Description copied from interface:ReifiableIFPUBLIC: Sets the reifier of this object.- Specified by:
setReifierin interfaceReifiableIF
-
toString
-