net.ontopia.infoset.fulltext.topicmaps
Class TopicMapIteratorGenerator

java.lang.Object
  net.ontopia.infoset.fulltext.topicmaps.TopicMapIteratorGenerator

All Implemented Interfaces:

EventGeneratorIF

public class TopicMapIteratorGenerator
extends java.lang.Object
implements EventGeneratorIF

INTERNAL: A topic map event generator that iterates the objects in a topic map and produces documents for an indexer.

Basenames, variant names, and occurrences are indexed.

Note: the properties topicMap, indexer and documentGenerator must be set before the event generation can be started.

Field Summary

protected TopicMapDocumentGeneratorIF	docgen
protected IndexerIF	indexer
protected TopicMapIF	topicmap

Constructor Summary

TopicMapIteratorGenerator()

TopicMapIteratorGenerator(TopicMapIF topicmap, IndexerIF indexer, TopicMapDocumentGeneratorIF docgen)

Method Summary

void	generate() INTERNAL: Iterates over the objects in a topic map and generates indexable documents for objects in the topic map.
TopicMapDocumentGeneratorIF	getDocumentGenerator() INTERNAL: Gets the topic map document generator that is to be used.
IndexerIF	getIndexer() INTERNAL: Gets the indexer that should receive the documents that are generated during the iteration.
TopicMapIF	getTopicMap() INTERNAL: Gets the topic map that is to be iterated.
void	setDocumentGenerator(TopicMapDocumentGeneratorIF docgen) INTERNAL: Gets the topic map document generator that is to be used.
void	setIndexer(IndexerIF indexer) INTERNAL: Sets the indexer that should receive the documents that are generated during the iteration.
void	setTopicMap(TopicMapIF topicmap) INTERNAL: Sets the topic map that is to be iterated.

Methods inherited from class java.lang.Object

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

Field Detail

docgen

protected TopicMapDocumentGeneratorIF docgen

topicmap

protected TopicMapIF topicmap

indexer

protected IndexerIF indexer

Constructor Detail

TopicMapIteratorGenerator

public TopicMapIteratorGenerator()

TopicMapIteratorGenerator

public TopicMapIteratorGenerator(TopicMapIF topicmap,
                                 IndexerIF indexer,
                                 TopicMapDocumentGeneratorIF docgen)

Method Detail

getTopicMap

public TopicMapIF getTopicMap()

INTERNAL: Gets the topic map that is to be iterated.

setTopicMap

public void setTopicMap(TopicMapIF topicmap)

INTERNAL: Sets the topic map that is to be iterated.

getIndexer

public IndexerIF getIndexer()

INTERNAL: Gets the indexer that should receive the documents that are generated during the iteration.

setIndexer

public void setIndexer(IndexerIF indexer)

INTERNAL: Sets the indexer that should receive the documents that are generated during the iteration.

getDocumentGenerator

public TopicMapDocumentGeneratorIF getDocumentGenerator()

INTERNAL: Gets the topic map document generator that is to be used.

setDocumentGenerator

public void setDocumentGenerator(TopicMapDocumentGeneratorIF docgen)

INTERNAL: Gets the topic map document generator that is to be used.

generate

public void generate()
              throws java.io.IOException

INTERNAL: Iterates over the objects in a topic map and generates indexable documents for objects in the topic map. Basenames, variant names, and occurrences are indexed.

Throws:

java.io.IOException