net.ontopia.topicmaps.impl.rdbms
Class RDBMSTopicMapReader

java.lang.Object
  net.ontopia.topicmaps.impl.rdbms.RDBMSTopicMapReader

All Implemented Interfaces:

TopicMapReaderIF

public class RDBMSTopicMapReader
extends java.lang.Object
implements TopicMapReaderIF

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

Since:

1.2.5

Field Summary

protected java.util.Map	properties
protected java.lang.String	propfile
protected long	topicmap_id

Constructor Summary

RDBMSTopicMapReader(long topicmap_id)

RDBMSTopicMapReader(java.util.Map properties, long topicmap_id)

RDBMSTopicMapReader(java.lang.String propfile, long topicmap_id)

Method Summary

TopicMapIF	read() PUBLIC: Reads the next topic map available from some implicit, implementation dependent source.
java.util.Collection<TopicMapIF>	readAll() PUBLIC: Reads all the topic map available from some implicit, implementation dependent source.

Methods inherited from class java.lang.Object

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

Field Detail

propfile

protected java.lang.String propfile

properties

protected java.util.Map properties

topicmap_id

protected long topicmap_id

Constructor Detail

RDBMSTopicMapReader

public RDBMSTopicMapReader(long topicmap_id)

RDBMSTopicMapReader

public RDBMSTopicMapReader(java.lang.String propfile,
                           long topicmap_id)

RDBMSTopicMapReader

public RDBMSTopicMapReader(java.util.Map properties,
                           long topicmap_id)

Method Detail

read

public TopicMapIF read()
                throws java.io.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:

java.io.IOException - Thrown if reading the source fails.

readAll

public java.util.Collection<TopicMapIF> readAll()
                                         throws java.io.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:

java.io.IOException - Thrown if reading the source fails.