Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> tm4j >> [ topicmap overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.tm4j.topicmap
Interface TopicMapObject  

All Known Subinterfaces:

Association, BaseName, Member, NamedObject, Occurrence, Scope, ScopedObject, Topic, TopicMap, Variant, VariantName

---

public interface TopicMapObject

The generic base interface for topic map objects. All of the interfaces that represent constructs from the topic map are derived from this interface. For a more detailed discussion of the purpose of this interface and its capablities, see the section titled TopicMapObject in the TM4J Developer's Guide.

Note: TM4J provides a generic way for any client application to detect changes made in a topic map, which involves the use of properties and the java.beans.PropertyChangeListener interface. For more in-depth information about using properties in TM4J, and for a discussion of available properties, see the Property Change Listeners section in the TM4J Developer's Guide.

---

Method Summary
void	addMultiValuePropertyChangeListener(org.tm4j.utils.MultiValuePropertyChangeListener listener)           Adds a MultiValue Property Change Listener.
void	addMultiValuePropertyChangeListener(java.lang.String propertyName, org.tm4j.utils.MultiValuePropertyChangeListener listener)           Adds a MultiValue Property Change Listener.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)           Adds a Property Change Listener.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)           Adds a Property Change Listener.
void	addVetoableChangeListener(java.beans.VetoableChangeListener listener)
void	destroy()           Permanently removes this object from the topic map.
void	fireMultiValuePropertyChange(org.tm4j.utils.MultiValuePropertyChangeEvent propertyChange)           Notifies the MultiValue Property Change Listeners of a property change.
void	fireMultiValuePropertyChange(java.lang.String propertyName, int operation, java.lang.Object operand)           Notifies the MultiValue Property Change Listeners of a property change to this object
void	firePropertyChange(java.beans.PropertyChangeEvent propertyChange)           Notifies the Property Change Listeners of a property change.
void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldVal, java.lang.Object newVal)           Notifies a Property Change Listener of a property change.
void	fireVetoableChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
java.lang.String	getID()           Returns the object ID of the TopicMapObject.
org.tm4j.net.Locator	getResourceLocator()           Returns the Locator of the XML or other resource which caused the creation of this topic map object.
TopicMap	getTopicMap()           Returns a handle to the topic map which this object is part of.
void	removeMultiValuePropertyChangeListener(org.tm4j.utils.MultiValuePropertyChangeListener listener)           Removes a MultiValue Property Change Listener.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)           Removes a Property Change Listener.
void	removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
void	setID(java.lang.String id)           Sets the object ID of the TopicMapObject.
void	setResourceLocator(org.tm4j.net.Locator loc)           Sets the Locator of the XML or other resource which caused the creation of this topic map object.

 

Method Detail

setID

public void setID(java.lang.String id)
           throws DuplicateObjectIDException,
                  DuplicateResourceLocatorException

Sets the object ID of the TopicMapObject. The object ID is an internal identifier assigned by the application to a topic map object. ID values must be unique for each object in the same topic map. Implementations are free to assign ID values in any way they see fit.

---

getID

public java.lang.String getID()

Returns the object ID of the TopicMapObject. Note that implementations are free to assign ID values in any way they see fit. To get the Locator of the XTM element which is represented by this object, use getResourceLocator() 55 .

---

getResourceLocator

public org.tm4j.net.Locator getResourceLocator()

Returns the Locator of the XML or other resource which caused the creation of this topic map object.

---

setResourceLocator

public void setResourceLocator(org.tm4j.net.Locator loc)
                        throws DuplicateResourceLocatorException

Sets the Locator of the XML or other resource which caused the creation of this topic map object. Typically, this will be the Locator of an XTM element.

---

getTopicMap

public TopicMap getTopicMap()

Returns a handle to the topic map which this object is part of.

---

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Adds a Property Change Listener. The listener is registered for only one property.

---

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a Property Change Listener. The listener is registered for all properties.

---

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a Property Change Listener.

---

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldVal,
                               java.lang.Object newVal)

Notifies a Property Change Listener of a property change. Note that if oldVal equals newVal, no property change event is actually fired.

---

firePropertyChange

public void firePropertyChange(java.beans.PropertyChangeEvent propertyChange)

Notifies the Property Change Listeners of a property change.

---

addMultiValuePropertyChangeListener

public void addMultiValuePropertyChangeListener(java.lang.String propertyName,
                                                org.tm4j.utils.MultiValuePropertyChangeListener listener)

Adds a MultiValue Property Change Listener. The listener is registered for only one property.

---

addMultiValuePropertyChangeListener

public void addMultiValuePropertyChangeListener(org.tm4j.utils.MultiValuePropertyChangeListener listener)

Adds a MultiValue Property Change Listener. The listener is registered for all properties.

---

removeMultiValuePropertyChangeListener

public void removeMultiValuePropertyChangeListener(org.tm4j.utils.MultiValuePropertyChangeListener listener)

Removes a MultiValue Property Change Listener.

---

fireMultiValuePropertyChange

public void fireMultiValuePropertyChange(java.lang.String propertyName,
                                         int operation,
                                         java.lang.Object operand)

Notifies the MultiValue Property Change Listeners of a property change to this object

---

fireMultiValuePropertyChange

public void fireMultiValuePropertyChange(org.tm4j.utils.MultiValuePropertyChangeEvent propertyChange)

Notifies the MultiValue Property Change Listeners of a property change.

---

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)

---

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)

---

fireVetoableChange

public void fireVetoableChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)
                        throws java.beans.PropertyVetoException

---

destroy

public void destroy()
             throws IntegrityViolationException

Permanently removes this object from the topic map. Depending upon the backend implementation, this method may also free up the memory or other storage space used by the object. An object may only be destroyed after all references to it from other objects have been removed. If the object detects that there is an existing reference still held to it, then an IntegrityViolationException is thrown

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> tm4j >> [ topicmap overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---