Package net.ontopia.topicmaps.core

Interface TopicMapReaderIF

All Known Implementing Classes:

AbstractTopicMapReader, CTMTopicMapReader, JTMTopicMapReader, LTMTopicMapReader, RDBMSTopicMapReader, RDFTopicMapReader, TMXMLReader, XFMLTopicMapReader, XTMTopicMapReader

public interface TopicMapReaderIF

PUBLIC: A topic map reader is used to read topic maps from an implementation specific, implicit source.

See Also:

net.ontopia.topicmaps.core.TopicMapImporterIF , net.ontopia.topicmaps.core.TopicMapWriterIF

Method Summary

Modifier and Type	Method	Description
void	importInto(TopicMapIF topicmap)	PUBLIC: Imports an implicitly designated topic map into the given topic map.
TopicMapIF	read()	PUBLIC: Reads the next topic map available from some implicit, implementation dependent source.
Collection<TopicMapIF>	readAll()	PUBLIC: Reads all the topic map available from some implicit, implementation dependent source.
void	setAdditionalProperties(Map<String,Object> properties)	PUBLIC: set additional properties to the topic map reader.

Method Detail

read

TopicMapIF read()
         throws IOException

PUBLIC: Reads the next topic map available from some implicit, implementation dependent source.

A topic map source may contain multiple topic maps. The read method returns the next topic map that is available from that source. null is returned when there are no more topic maps available. In a sense this is iterator-like behaviour.

Returns:

The next topic map read from the source; an object implementing TopicMapIF. null is returned when there are no more topic maps available from the source.

Throws:

IOException - Thrown if reading the source fails.

readAll

Collection<TopicMapIF> readAll()
                        throws IOException

PUBLIC: Reads all the topic map available from some implicit, implementation dependent source.

A topic map source may contain multiple topic maps. The readAll method returns a collection contain all the topic maps available from the source.

Returns:

A collection containing all the topic maps read from the source; objects implementing TopicMapIF.

Throws:

IOException - Thrown if reading the source fails.

importInto

void importInto(TopicMapIF topicmap)
         throws IOException

PUBLIC: Imports an implicitly designated topic map into the given topic map.

Parameters:

topicmap - The topic map into which the import will be done; an object implementing TopicMapIF.

Throws:

IOException

setAdditionalProperties

void setAdditionalProperties(Map<String,Object> properties)

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

Parameters:

properties - Additional properties for the reader