StatsProcessor

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> tm4j >> topicmap >> [ cmd overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.tm4j.topicmap.cmd.StatsProcessor

SOURCE |

Download org.tm4j.topicmap.cmd.StatsProcessor

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.tm4j.topicmap.cmd
Interface StatsProcessor

All Known Implementing Classes:: DefaultStatsProcessor

public interface StatsProcessor

Defines the interface for a processing package for the org.tm4j.topicmap.cmd.Stats commandline processor. The processor interface is called by the command-line app as follows: First the constructor is called, followed by the initialise() member. For each topic map processed, setTopicMap is called. willProcessTopics() is called and if it returns true, processTopic() is called once for each topic in the topic map. willProcessAssociations is called and if it returns true, processAssociation() is called once for each Association in the topic map. willProcessFacets() is called and if it returns true, processFacet() is called once for each Facet in the topic map. After all topic maps have been processed, writeStats() is called once.

Field Summary

static int MINIMAL


static int STANDARD


static int VERBOSE


Method Summary

void initialise()
          Called once at the invocation of the stats process.

void processAssociation(org.tm4j.topicmap.Association a)
          Called once for each association in the topic map, iff willProcessAssociations() returned true.

void processTopic(org.tm4j.topicmap.Topic t)
          Called once for each topic in the topic map, iff willProcessTopics() returned true.

void setTopicMap(org.tm4j.topicmap.TopicMap tm)
          Called once for each topic map before processing any members of the topic map.

boolean willProcessAssociations()
          Called once to determine whether or not the processor wants to be told about each Association in the topic map.

boolean willProcessTopics()
          Called once to determine whether or not the processor wants to be told about

void writeStats(int statsStyle, java.io.PrintStream out)
          Called once to request that the processor writes its results to an output stream.

Field Detail

MINIMAL

public static final int MINIMAL

See Also:: Constant Field Values

STANDARD

public static final int STANDARD

See Also:: Constant Field Values

VERBOSE

public static final int VERBOSE

See Also:: Constant Field Values

Method Detail

initialise

public void initialise()

Called once at the invocation of the stats process.

setTopicMap

public void setTopicMap(org.tm4j.topicmap.TopicMap tm)

Called once for each topic map before processing any members of the topic map.

willProcessTopics

public boolean willProcessTopics()

Called once to determine whether or not the processor wants to be told about

processTopic

public void processTopic(org.tm4j.topicmap.Topic t)

Called once for each topic in the topic map, iff willProcessTopics() returned true.

willProcessAssociations

public boolean willProcessAssociations()

Called once to determine whether or not the processor wants to be told about each Association in the topic map.

processAssociation

public void processAssociation(org.tm4j.topicmap.Association a)

Called once for each association in the topic map, iff willProcessAssociations() returned true.

writeStats

public void writeStats(int statsStyle,
                       java.io.PrintStream out)

Called once to request that the processor writes its results to an output stream.