net.ontopia.topicmaps.core

Interface TopicMapWriterIF

All Known Implementing Classes:

CanonicalTopicMapWriter, CanonicalXTMWriter, JTMTopicMapWriter, LTMTopicMapWriter, RDFTopicMapWriter, TMXMLWriter, XTM21TopicMapWriter, XTM2TopicMapWriter, XTMTopicMapWriter

public interface TopicMapWriterIF

PUBLIC: A topic map writer is used to write/export topic maps in an implementation dependent way to an implicit destination.

See Also:

net.ontopia.core.topicmaps.TopicMapReaderIF, net.ontopia.core.topicmaps.TopicMapImporterIF

Method Summary

Modifier and Type	Method and Description
void	setAdditionalProperties(Map<String,Object> properties) PUBLIC: set additional properties to the topic map writer.
void	write(TopicMapIF source_topicmap) PUBLIC: Writes the given topic map to an implicit implementation dependent destination.

Method Detail

write

void write(TopicMapIF source_topicmap)
    throws IOException

PUBLIC: Writes the given topic map to an implicit implementation dependent destination. The write method will close any resources opened internally. This means that the write method can only be called once if the stream/writer was opened internally.

Parameters:

source_topicmap - The topic map to be exported/written; an object implementing TopicMapIF

Throws:

IOException - Thrown if writing the topic map fails.

setAdditionalProperties

void setAdditionalProperties(Map<String,Object> properties)

PUBLIC: set additional properties to the topic map writer. The set of accepted properties differs per writer implementation, see the specific writer documentation for details on accepted properties.

Parameters:

properties - Additional properties for the writer