net.ontopia.topicmaps.xml
Class XTMFragmentExporter

java.lang.Object
  extended by net.ontopia.topicmaps.xml.AbstractTopicMapExporter
      extended by net.ontopia.topicmaps.xml.XTMTopicMapExporter
          extended by net.ontopia.topicmaps.xml.XTMFragmentExporter

public class XTMFragmentExporter
extends XTMTopicMapExporter

PUBLIC: Exports partial topic maps using an approach inspired by the XTM Fragment Interchange 0.1 specification, but different.

WARNING: This class is not thread-safe.


Nested Class Summary
static interface XTMFragmentExporter.LocatorHandlerIF
          EXPERIMENTAL: Handler class used for processing locators.
 
Field Summary
static java.lang.String VIRTUAL_URN
           
 
Constructor Summary
XTMFragmentExporter()
          PUBLIC: Initializes the exporter.
XTMFragmentExporter(java.lang.String tmid)
           
 
Method Summary
 void endTopicMap(org.xml.sax.DocumentHandler dh)
          PUBLIC: Outputs the end tag.
 void exportAll(java.util.Iterator it, org.xml.sax.DocumentHandler dh)
          PUBLIC: Exports an XTM Fragment (complete with root element) to the given DocumentHandler, containing all the topics retrieved from the Iterator.
 void exportTopicNames(java.util.Iterator it, org.xml.sax.DocumentHandler dh)
          PUBLIC: Exports a set of topic names without any wrapping element.
 void exportTopics(java.util.Iterator it, org.xml.sax.DocumentHandler dh)
          PUBLIC: Exports a set of topics without any wrapping element.
static boolean isVirtualReference(java.lang.String address)
           
static java.lang.String makeVirtualReference(TopicIF topic, java.lang.String topicmap_id)
           
static java.lang.String resolveVirtualReference(java.lang.String address, java.lang.String tmid)
           
 void setLocatorHandler(XTMFragmentExporter.LocatorHandlerIF locator_handler)
          EXPERIMENTAL: Sets the locator handler.
 void setUseLocalIds(boolean use_local_ids)
          PUBLIC: Controls whether or not internal references of the form '#id' will be used.
static java.lang.String sourceTopicMapFromVirtualReference(java.lang.String address)
           
 void startTopicMap(org.xml.sax.DocumentHandler dh)
          PUBLIC: Outputs the start tag.
 
Methods inherited from class net.ontopia.topicmaps.xml.XTMTopicMapExporter
export, export, getAddIds, getExportSourceLocators, setAddIds, setExportSourceLocators
 
Methods inherited from class net.ontopia.topicmaps.xml.AbstractTopicMapExporter
getElementId, mayCollide, setFilter
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VIRTUAL_URN

public static final java.lang.String VIRTUAL_URN
See Also:
Constant Field Values
Constructor Detail

XTMFragmentExporter

public XTMFragmentExporter()
PUBLIC: Initializes the exporter.


XTMFragmentExporter

public XTMFragmentExporter(java.lang.String tmid)
Method Detail

setLocatorHandler

public void setLocatorHandler(XTMFragmentExporter.LocatorHandlerIF locator_handler)
EXPERIMENTAL: Sets the locator handler. Currently only used for occurrences.


setUseLocalIds

public void setUseLocalIds(boolean use_local_ids)
PUBLIC: Controls whether or not internal references of the form '#id' will be used. TMRAP cannot use this, whereas when self-contained XTM fragment files are produced this should be used.


exportAll

public void exportAll(java.util.Iterator it,
                      org.xml.sax.DocumentHandler dh)
               throws org.xml.sax.SAXException
PUBLIC: Exports an XTM Fragment (complete with root element) to the given DocumentHandler, containing all the topics retrieved from the Iterator. Duplicates do not cause problems.

Throws:
org.xml.sax.SAXException

exportTopics

public void exportTopics(java.util.Iterator it,
                         org.xml.sax.DocumentHandler dh)
                  throws org.xml.sax.SAXException
PUBLIC: Exports a set of topics without any wrapping element.

Throws:
org.xml.sax.SAXException

exportTopicNames

public void exportTopicNames(java.util.Iterator it,
                             org.xml.sax.DocumentHandler dh)
                      throws org.xml.sax.SAXException
PUBLIC: Exports a set of topic names without any wrapping element.

Throws:
org.xml.sax.SAXException

startTopicMap

public void startTopicMap(org.xml.sax.DocumentHandler dh)
                   throws org.xml.sax.SAXException
PUBLIC: Outputs the start tag.

Throws:
org.xml.sax.SAXException

endTopicMap

public void endTopicMap(org.xml.sax.DocumentHandler dh)
                 throws org.xml.sax.SAXException
PUBLIC: Outputs the end tag.

Throws:
org.xml.sax.SAXException

isVirtualReference

public static boolean isVirtualReference(java.lang.String address)

resolveVirtualReference

public static java.lang.String resolveVirtualReference(java.lang.String address,
                                                       java.lang.String tmid)

sourceTopicMapFromVirtualReference

public static java.lang.String sourceTopicMapFromVirtualReference(java.lang.String address)

makeVirtualReference

public static java.lang.String makeVirtualReference(TopicIF topic,
                                                    java.lang.String topicmap_id)


Copyright © 2000-2009 Ontopia.