|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The base class for all objects in the TMAPI system which represent constructs in a topic map.
Every TopicMapObject may be created from any number of input sources (typically markup in some topic map interchange format), each of which may have a separate address. In addition, the TMAPI TopicMapObject may "wrap" one or more objects in an underlying topic map processing system.
Method Summary | |
void |
addSourceLocator(Locator sourceLocator)
Adds a Locator to the set of source locators for this object. |
boolean |
equals(java.lang.Object o)
Returns true if the other object is equal to this one. |
java.lang.String |
getObjectId()
Returns a topic map-specific identifier for this object. |
java.util.Set |
getSourceLocators()
Returns the set of source locators for this object. |
TopicMap |
getTopicMap()
Returns the topic map to which this object belongs. |
int |
hashCode()
Returns the hashcode of the topic map object's object id |
void |
remove()
Removes the object from its container. |
void |
removeSourceLocator(Locator sourceLocator)
Removes a Locator from the set of source locators for this object. |
Method Detail |
public TopicMap getTopicMap()
TopicMap
interface, then it should return itself.
public java.util.Set getSourceLocators()
null
.
public void addSourceLocator(Locator sourceLocator) throws DuplicateSourceLocatorException
sourceLocator
- the Locator to be added
DuplicateSourceLocatorException
- if there is already a
TopicMapObject in the same TopicMap with this source locator.getSourceLocators()
public void removeSourceLocator(Locator sourceLocator)
sourceLocator
- the Locator to be removed.getSourceLocators()
public void remove() throws TMAPIException
TMAPIException
- if the object cannot be removed from the container. Derived
interfaces may define specific circumstances under which a subclass of TMAPIException
must be raised.
Implementations MUST NOT use a TMAPIException to
wrap a failure raised in the underlying engine - such errors must always be wrapped in a
TMAPIRuntimeException.public java.lang.String getObjectId()
public boolean equals(java.lang.Object o)
o
is not an instance of
TopicMapObject the return value is false.
public int hashCode()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |