Package net.ontopia.topicmaps.xml

Class XTMFragmentExporter

java.lang.Object

net.ontopia.topicmaps.xml.AbstractTopicMapExporter

net.ontopia.topicmaps.xml.XTMTopicMapExporter

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.

Note that the TopicMapFragmentWriterIF implementation is not this class, but XTMTopicMapFragmentWriter.

WARNING: This class is not thread-safe.

See Also:

XTMTopicMapFragmentWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	XTMFragmentExporter.LocatorHandlerIF	EXPERIMENTAL: Handler class used for processing locators.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set	alreadyExported
protected static String	EMPTY_LOCALNAME
protected static String	EMPTY_NAMESPACE
protected XTMFragmentExporter.LocatorHandlerIF	locator_handler
protected Collection	reifiers
protected boolean	use_local_ids
static String	VIRTUAL_URN

Fields inherited from class net.ontopia.topicmaps.xml.XTMTopicMapExporter

atts, EMPTY_ATTR_LIST, export_srclocs

Fields inherited from class net.ontopia.topicmaps.xml.AbstractTopicMapExporter

add_ids, filter

Constructor Summary

Constructors

Constructor	Description
XTMFragmentExporter()	PUBLIC: Initializes the exporter.
XTMFragmentExporter(String tmid)

Method Summary

Modifier and Type	Method	Description
void	endTopicMap(ContentHandler dh)	PUBLIC: Outputs the end tag.
void	exportAll(Iterator it, ContentHandler dh)	PUBLIC: Exports an XTM Fragment (complete with root element) to the given ContentHandler, containing all the topics retrieved from the Iterator.
void	exportTopicNames(Iterator it, ContentHandler dh)	PUBLIC: Exports a set of topic names without any wrapping element.
void	exportTopics(Iterator it, ContentHandler dh)	PUBLIC: Exports a set of topics without any wrapping element.
boolean	getUseLocalIds()	PUBLIC: Whether or not internal references of the form '#id' will be exported.
static boolean	isVirtualReference(String address)
protected String	makeVirtualReference(TopicIF topic)
static String	makeVirtualReference(TopicIF topic, String topicmap_id)
static String	resolveVirtualReference(String address, 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 String	sourceTopicMapFromVirtualReference(String address)
void	startTopicMap(ContentHandler dh)	PUBLIC: Outputs the start tag.
protected void	writeAssociation(AssociationIF assoc, ContentHandler dh)
protected void	writeMembers(AssociationIF assoc, ContentHandler dh)
protected void	writeOccurrences(Collection occurrences, ContentHandler dh)
protected void	writeSubjectIdentity(TopicIF topic, ContentHandler dh)
protected void	writeTopic(TopicIF topic, ContentHandler dh)
protected void	writeTopicNames(Collection names, ContentHandler dh)
protected void	writeTopicNames(TopicIF topic, ContentHandler dh)
protected void	writeTopicRef(TopicIF topic, ContentHandler dh)
protected void	writeVariants(Collection variants, ContentHandler dh)

Methods inherited from class net.ontopia.topicmaps.xml.XTMTopicMapExporter

export, export, getAddIds, getExportSourceLocators, getSubjectIndicatorRef, reportInvalidLocator, setAddIds, setExportSourceLocators, writeInstanceOf, writeInstanceOf, writeMembers, writeParameters, writeRoleSpec, writeScope, writeVariantName

Methods inherited from class net.ontopia.topicmaps.xml.AbstractTopicMapExporter

addId, filterCollection, filterOk, getElementId, isValidXMLId, mayCollide, setFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VIRTUAL_URN

public static final String VIRTUAL_URN

See Also:

Constant Field Values

EMPTY_NAMESPACE

protected static final String EMPTY_NAMESPACE

See Also:

Constant Field Values

EMPTY_LOCALNAME

protected static final String EMPTY_LOCALNAME

See Also:

Constant Field Values

locator_handler

protected XTMFragmentExporter.LocatorHandlerIF locator_handler

reifiers

protected Collection reifiers

alreadyExported

protected Set alreadyExported

use_local_ids

protected boolean use_local_ids

Constructor Detail

XTMFragmentExporter

public XTMFragmentExporter()

PUBLIC: Initializes the exporter.

XTMFragmentExporter

public XTMFragmentExporter(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.

getUseLocalIds

public boolean getUseLocalIds()

PUBLIC: Whether or not internal references of the form '#id' will be exported.

exportAll

public void exportAll(Iterator it,
                      ContentHandler dh)
               throws SAXException

PUBLIC: Exports an XTM Fragment (complete with root element) to the given ContentHandler, containing all the topics retrieved from the Iterator. Duplicates do not cause problems.

Throws:

SAXException

exportTopics

public void exportTopics(Iterator it,
                         ContentHandler dh)
                  throws SAXException

PUBLIC: Exports a set of topics without any wrapping element.

Throws:

SAXException

exportTopicNames

public void exportTopicNames(Iterator it,
                             ContentHandler dh)
                      throws SAXException

PUBLIC: Exports a set of topic names without any wrapping element.

Throws:

SAXException

startTopicMap

public void startTopicMap(ContentHandler dh)
                   throws SAXException

PUBLIC: Outputs the start tag.

Throws:

SAXException

endTopicMap

public void endTopicMap(ContentHandler dh)
                 throws SAXException

PUBLIC: Outputs the end tag.

Throws:

SAXException

writeTopic

protected void writeTopic(TopicIF topic,
                          ContentHandler dh)
                   throws SAXException

Overrides:

writeTopic in class XTMTopicMapExporter

Throws:

SAXException

writeTopicNames

protected void writeTopicNames(TopicIF topic,
                               ContentHandler dh)
                        throws SAXException

Throws:

SAXException

writeTopicNames

protected void writeTopicNames(Collection names,
                               ContentHandler dh)
                        throws SAXException

Overrides:

writeTopicNames in class XTMTopicMapExporter

Throws:

SAXException

writeTopicRef

protected void writeTopicRef(TopicIF topic,
                             ContentHandler dh)
                      throws SAXException

Overrides:

writeTopicRef in class XTMTopicMapExporter

Throws:

SAXException

writeSubjectIdentity

protected void writeSubjectIdentity(TopicIF topic,
                                    ContentHandler dh)
                             throws SAXException

Overrides:

writeSubjectIdentity in class XTMTopicMapExporter

Throws:

SAXException

writeVariants

protected void writeVariants(Collection variants,
                             ContentHandler dh)
                      throws SAXException

Overrides:

writeVariants in class XTMTopicMapExporter

Throws:

SAXException

writeOccurrences

protected void writeOccurrences(Collection occurrences,
                                ContentHandler dh)
                         throws SAXException

Overrides:

writeOccurrences in class XTMTopicMapExporter

Throws:

SAXException

writeAssociation

protected void writeAssociation(AssociationIF assoc,
                                ContentHandler dh)
                         throws SAXException

Overrides:

writeAssociation in class XTMTopicMapExporter

Throws:

SAXException

writeMembers

protected void writeMembers(AssociationIF assoc,
                            ContentHandler dh)
                     throws SAXException

Throws:

SAXException

isVirtualReference

public static boolean isVirtualReference(String address)

resolveVirtualReference

public static String resolveVirtualReference(String address,
                                             String tmid)

sourceTopicMapFromVirtualReference

public static String sourceTopicMapFromVirtualReference(String address)

makeVirtualReference

protected String makeVirtualReference(TopicIF topic)

makeVirtualReference

public static String makeVirtualReference(TopicIF topic,
                                          String topicmap_id)