net.ontopia.topicmaps.xml
Class XTMTopicMapReference

java.lang.Object
  extended by net.ontopia.topicmaps.entry.AbstractTopicMapReference
      extended by net.ontopia.topicmaps.entry.AbstractURLTopicMapReference
          extended by net.ontopia.topicmaps.entry.AbstractOntopolyURLReference
              extended by net.ontopia.topicmaps.xml.XTMTopicMapReference
All Implemented Interfaces:
TopicMapReferenceIF, net.ontopia.topicmaps.impl.utils.TransactionEventListenerIF

public class XTMTopicMapReference
extends AbstractOntopolyURLReference

INTERNAL: An XTM document topic map reference.


Constructor Summary
XTMTopicMapReference(java.net.URL url, java.lang.String id, java.lang.String title)
           
XTMTopicMapReference(java.net.URL url, java.lang.String id, java.lang.String title, LocatorIF base_address)
           
 
Method Summary
 ExternalReferenceHandlerIF getExternalReferenceHandler()
          PUBLIC: Gets the external reference handler.
 boolean getValidation()
          PUBLIC: Returns true if validation is on, false otherwise.
 void save()
          INTERNAL: Saves the topic map as an XTM document in the location managed by the reference's source.
 void setExternalReferenceHandler(ExternalReferenceHandlerIF handler)
          PUBLIC: Sets the external reference handler.
 void setFollowTopicRefs(boolean followTopicRefs)
          PUBLIC: If set to false topicRef elements pointing to external documents will not be traversed.
 void setValidation(boolean validate)
          PUBLIC: Turn validation of XTM documents according to DTD on or off.
 
Methods inherited from class net.ontopia.topicmaps.entry.AbstractOntopolyURLReference
close, delete, getAlwaysReindexOnLoad, getSearcher, setAlwaysReindexOnLoad, synchronizeFulltextIndex, transactionAbort, transactionCommit
 
Methods inherited from class net.ontopia.topicmaps.entry.AbstractURLTopicMapReference
createStore, getBaseAddress, getDuplicateSuppression, getIndexDirectory, getMaintainFulltextIndexes, getReuseStore, getURL, open, setBaseAddress, setDuplicateSuppression, setIndexDirectory, setMaintainFulltextIndexes, setReuseStore, toString
 
Methods inherited from class net.ontopia.topicmaps.entry.AbstractTopicMapReference
addTopicListener, clear, getId, getSource, getTitle, isDeleted, isOpen, registerTopicListeners, removeTopicListener, setId, setSource, setTitle, storeClosed
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XTMTopicMapReference

public XTMTopicMapReference(java.net.URL url,
                            java.lang.String id,
                            java.lang.String title)

XTMTopicMapReference

public XTMTopicMapReference(java.net.URL url,
                            java.lang.String id,
                            java.lang.String title,
                            LocatorIF base_address)
Method Detail

setFollowTopicRefs

public void setFollowTopicRefs(boolean followTopicRefs)
PUBLIC: If set to false topicRef elements pointing to external documents will not be traversed. The default is that those the documents pointed to by those elements will be loaded (as per the XTM specification).

Since:
3.2

setExternalReferenceHandler

public void setExternalReferenceHandler(ExternalReferenceHandlerIF handler)
PUBLIC: Sets the external reference handler.


getExternalReferenceHandler

public ExternalReferenceHandlerIF getExternalReferenceHandler()
PUBLIC: Gets the external reference handler. The reference handler will receive notifications on references to external topics and topic maps.


setValidation

public void setValidation(boolean validate)
PUBLIC: Turn validation of XTM documents according to DTD on or off. The validation checks if the documents read follow the DTD, and will abort import if they do not.

Parameters:
validate - Will validate if true, will not if false.
Since:
2.0

getValidation

public boolean getValidation()
PUBLIC: Returns true if validation is on, false otherwise.

Since:
2.0

save

public void save()
          throws java.io.IOException
INTERNAL: Saves the topic map as an XTM document in the location managed by the reference's source.

Throws:
java.io.IOException


Copyright © 2000-2010 Ontopia.