Package net.ontopia.topicmaps.impl.rdbms

Class RDBMSTopicMapReader

java.lang.Object

net.ontopia.topicmaps.impl.rdbms.RDBMSTopicMapReader

All Implemented Interfaces:

TopicMapReaderIF

public class RDBMSTopicMapReader
extends Object
implements TopicMapReaderIF

INTERNAL: Topic map reader that reads topic maps from the RDBMS backend connector.

Since:

1.2.5

Field Summary

Fields

Modifier and Type	Field	Description
protected Map	properties
protected String	propfile
protected long	topicmap_id

Constructor Summary

Constructors

Constructor	Description
RDBMSTopicMapReader(long topicmap_id)
RDBMSTopicMapReader(String propfile, long topicmap_id)
RDBMSTopicMapReader(Map properties, long topicmap_id)

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)	RDBMSTopicMapReader does not accept any additional properties outside of the specified properties file.

Methods inherited from class java.lang.Object

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

Field Detail

propfile

protected String propfile

properties

protected Map properties

topicmap_id

protected long topicmap_id

Constructor Detail

RDBMSTopicMapReader

public RDBMSTopicMapReader(long topicmap_id)

RDBMSTopicMapReader

public RDBMSTopicMapReader(String propfile,
                           long topicmap_id)

RDBMSTopicMapReader

public RDBMSTopicMapReader(Map properties,
                           long topicmap_id)

Method Detail

read

public TopicMapIF read()
                throws IOException

Description copied from interface: TopicMapReaderIF

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.

Specified by:

read in interface TopicMapReaderIF

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

public Collection<TopicMapIF> readAll()
                               throws IOException

Description copied from interface: TopicMapReaderIF

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.

Specified by:

readAll in interface TopicMapReaderIF

Returns:

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

Throws:

IOException - Thrown if reading the source fails.

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> properties)

RDBMSTopicMapReader does not accept any additional properties outside of the specified properties file.

Specified by:

setAdditionalProperties in interface TopicMapReaderIF

Parameters:

properties -

importInto

public void importInto(TopicMapIF topicmap)
                throws IOException

Description copied from interface: TopicMapReaderIF

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

Specified by:

importInto in interface TopicMapReaderIF

Parameters:

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

Throws:

IOException