Java Class Summary

Java Class Summary
org.tm4j.config.xml.AddTopicMapSourceRule Rule for adding a TopicMapSource to a TopicMapProvider in the TopicMapManager The Provider is specified via its id, the Source implementation can be choosen via the clazz xml attribute, the default is SerializedTopicMapSource
org.tm4j.config.xml.NonRemovingOCRule This is a version of the ObjectCreateRule which does not remove the created object from the stack
org.tm4j.config.xml.RegisterProviderRule A Digester rule for creating and configuration a TopicMapProvider.
org.tm4j.config.xml.SetMemberRule This rule supports setting of Params, it accepts either value or type as attributes to the associated tag.
org.tm4j.config.xml.TopicMapManagerConfiguration Reads the configuration of a TopicMapManager Implementation from an XML file using jakarta digester.
org.tm4j.config.xml.TopicMapManagerRuleSet Rule Set for the whole configuration of the TopicMapManager An abstract base class for a locator, with the equals() method implemented. An abstract base class implementing the Locator interface. A basic implementation of the LocatorFactory interface with the createLocator() method implemented. A "default" LocatorResolverManager. A generic URI locator resolver.
org.tm4j.panckoucke.abstraction.AbstractionOptions This class serves to supply a set of customizable Options to an Abstraction Process Currently the format of the AbstractionOptions is completely undefined.
org.tm4j.panckoucke.impl.abstraction.AbstractionContextImpl Collection of properties which provide more detailed input to the abstraction process
org.tm4j.panckoucke.impl.abstraction.AbstractionManager ManagerClass, which serves as a single point of entry to the abstraction process.The AbstractionManager helds a number of Abstractor-Implementations and dispatches incoming abstraction requests to the appropriate abstractors
org.tm4j.panckoucke.impl.abstraction.AssocTypeClassifier This classifier groups players of all associations where the given topic plays a role in.
org.tm4j.panckoucke.impl.abstraction.AssociationCompressDispatcher The AssociationCompressDispatcher allows to decide on-the-fly how associations are transformed into models.
org.tm4j.panckoucke.impl.abstraction.AssociationRoleMatrixBuilder This implementation builds a Matrix from a list of associations.
org.tm4j.panckoucke.impl.abstraction.AssociationRoleMatrixClassifier The AssociationRoleMatrixClassifier classifies all associations where the given topic plays a role in.
org.tm4j.panckoucke.impl.abstraction.AssociationRoleShelfmark This ShelfMark reflects all the roles that are played in an Association.
A ShelfMark is a signature, that does not necessarily reflect the individual itself but certain properties of it.
org.tm4j.panckoucke.impl.abstraction.ClassificationItem Helper class to build hierachical classification trees.
org.tm4j.panckoucke.impl.abstraction.HierarchicalMolder The HierarchicalMolder adds elements to a given model.

The Molder builds the elements from a very simple basic template.
org.tm4j.panckoucke.impl.abstraction.MatrixCreator The MatrixCreator takes a MatrixClassifier and creates AModel-structures that represents tabular data.
The class uses the org.tm4j.panckoucke.impl.abstraction.util.MatrixMolder to build the model.
org.tm4j.panckoucke.impl.abstraction.RoleOfCenterClassifier This classifier groups players of all associations where the given topic t0 plays a role in.

The players are classified by the role, that t0 plays in the particular association.

The players are organized in a tree with two levels.
created 30.11.2003
org.tm4j.panckoucke.impl.abstraction.RoleTypePlayerCountClassifier This classifier organizes associations, roles and players on up to six levels.

All associations where the given Topic t0 plays a role in, are taken into account.

The classification process is divided into three steps;

In the first step, the associations are grouped under the role that t0 plays.
This step contribute the first level to the resulting tree.

In the second step, the associations are grouped under their type.
This step contribute level 2 and 3 to the resulting tree.

In the third step, associations are grouped by the number of their members and by the role that theese member plays.
This step adds the remaining three levels to the classification tree.

org.tm4j.panckoucke.impl.abstraction.RolesOfOthersClassifier This classifier groups players of all associations where the given topic t0 plays a role in.

The players are classified by the role, that they play in the particular association.
org.tm4j.panckoucke.impl.abstraction.SimpleAbstractor Simple abstractor allows to generate a simple graph from a given root topic object.
org.tm4j.panckoucke.impl.abstraction.compact.ClassContributor Processes all Associations, in which tmo plays the role of Instance.
org.tm4j.panckoucke.impl.abstraction.compact.CompactAbstractor The CompactAbstractor generates a simple, compacted model of the enviroment of a given root object.
org.tm4j.panckoucke.impl.abstraction.compact.CompactAssocAbstractor This Abstractor generates a compact graph from a given association root object.
org.tm4j.panckoucke.impl.abstraction.compact.InstanceContributor This implementation of AbstractionContributor adds information about all Topic, Associations and Occurrences to the model which are instances of tmo Dependant on the property createNodeWithGestaltInstance the class adds the information in the following shape:
if createNodeWithGestaltInstance evaluates to true, the following AMMembers are created - a new Node(n1) with GESTALT_INSTANCE AMGestaltRegistry#GESTALT_INSTANCE is added.
org.tm4j.panckoucke.impl.abstraction.compact.OccurrenceContributor This implementation of AbstractionContributor adds information about occurrences to the model
org.tm4j.panckoucke.impl.abstraction.compact.PlayerContributor This implementation of AbstractionContributor adds information about all topics playing the role of tmo to the model
org.tm4j.panckoucke.impl.abstraction.extended.ExtendedAbstractor The ExtendedAbstractor generates a somewhat verbose model of the enviroment of a given root object.
org.tm4j.panckoucke.impl.abstraction.extended.ExtendedOccurrenceContributor This implementation of AbstractionContributor adds information about occurrences to the model
org.tm4j.panckoucke.impl.abstraction.extended.ExtendedSubjectContributor This implementation of AbstractionContributor adds information about the subject-relevant characteristics to the model
org.tm4j.panckoucke.impl.abstraction.section.AssociationMemberSection The matrix of this Section contains a row for each topic that plays a role in the given association.

Besides the role playing topic, each row contains the topic that defines the role being played by the role-player.
org.tm4j.panckoucke.impl.abstraction.section.AssociationSectionGroup This extension of SectionGroup holds sections for all associations where the driving topic plays a role in.
Associations are grouped under the role that the driving topic plays.
org.tm4j.panckoucke.impl.abstraction.section.InstanceSection The matrix of this Section contains all topics, associations and occurrencess that refer to the driving topic as their type
org.tm4j.panckoucke.impl.abstraction.section.MetaSectionGroup This sectiongroups contains sections for
  • the types of the driving topic
  • the subject of the driving topic
  • the subject indicators of the driving topic
  • and the resource locator of the driving topic
org.tm4j.panckoucke.impl.abstraction.section.OccurrenceSection The matrix of this Section contains all occurrences of the given Topic.

The matrix is organized as follows
  • the occurrence itself is stored as the row object
  • cell 0 of every row stores the data or the data locator
  • of the current occurrence
  • cell 1 of every row stores the type of that occurrence
org.tm4j.panckoucke.impl.abstraction.section.RolePlayerSection The matrix of this Section contains all topics that are players in a member that uses the driving topic as its role-spec
org.tm4j.panckoucke.impl.abstraction.section.SectionAbstractor The SectionAbstractor organizes characteristics of a topic in Sections and SectionGroups.
Each Section arranges their data in one or more matrices (using the org.tm4j.panckoucke.impl.abstraction.util.Matrix).
SectionGroups are a container for Sections.
The model generated by the SectionAbstractor is therefore suitable to be rendered in a little-interactive, cleanly organized environment.
org.tm4j.panckoucke.impl.abstraction.tolog.TologAbstractor The TologAbstractor returns the result of a TologQuery as an AbstractModel.
org.tm4j.panckoucke.impl.abstraction.tolog.TologMatrixAbstractor The TologMatrixAbstractor returns the result of a TologQuery as an AbstractModel.
org.tm4j.panckoucke.impl.abstraction.util.Matrix Java bean that exposes the semantics of a matrix.
org.tm4j.panckoucke.impl.abstraction.util.MatrixMolder The MatrixMolder implements the Matrix-Pattern.
org.tm4j.panckoucke.impl.abstraction.util.MatrixNode Instances of this class form a wrapper around an AMNode that represents the root-node of a Matrix.
org.tm4j.panckoucke.impl.abstraction.util.MatrixUtil.ColumnFiller Helper that fills up a column of a given Matrix.
org.tm4j.panckoucke.impl.abstraction.util.MemberProxy This class is a container for the properties that an AMMember defines.
org.tm4j.panckoucke.impl.abstraction.util.Section A Section is the main building block of the model that the SectionAbstractor creates.
org.tm4j.panckoucke.impl.abstraction.util.SectionGroup A SectionGroup is a container for sections.
org.tm4j.panckoucke.impl.abstraction.util.SectionGroupNode A wrapper around an AMNode that represents a SectionGroup.
org.tm4j.panckoucke.impl.abstraction.util.SectionMolder The SectionMolder implements the Section-Pattern.
org.tm4j.panckoucke.impl.abstraction.util.SectionNode A wrapper around an AMNode that represents a Section.
org.tm4j.panckoucke.impl.abstraction.util.TopicCentricSection Extension of Section that is used by all specialisations that create a Section for Topics
org.tm4j.panckoucke.impl.context.reader.AbstractorRuleSet A Digester Rule Set for creating and Configurationg Abstractors
org.tm4j.panckoucke.impl.context.reader.CheckVersionRule This rules compares the panckoucke version with the panckoucke version specified in the xml file
org.tm4j.panckoucke.impl.context.reader.ContextRuleSet A Digester Rule Set for creating and configuring the elements of the context not handled in other RuleSets of this package
org.tm4j.panckoucke.impl.context.reader.CreateProviderRule A Digester rule for creating and configuration a TopicMapProvider
org.tm4j.panckoucke.impl.context.reader.GestaltenRuleSet A Digester Rule Set for creating and configuring the AMGestaltRegistry
org.tm4j.panckoucke.impl.context.reader.LoadMapRule New Rule for Loading Maps via the context This rule tries to load a specified map an InMemoryProvider taken from the Context If no InMemoryProvider is found in the context, an exception is thrown
org.tm4j.panckoucke.impl.context.reader.NonRemovingOCRule This is a version of the ObjectCreateRule which does not remove the created object from the stack
org.tm4j.panckoucke.impl.context.reader.PanckouckeContextReader Reads the configuration of a panckoucke based application from an XML file using jakarta digester.
org.tm4j.panckoucke.impl.context.reader.RendererRuleSet A Digester Rule Collection for configuration of renderers
org.tm4j.panckoucke.impl.context.reader.RepresentationsRuleSet A Digester Rule Set for creating and configuring the RepresentationRegistry
org.tm4j.panckoucke.impl.context.reader.SetMemberRule This rule supports setting of Params, it accepts either value or type as attributes to the associated tag.
org.tm4j.panckoucke.impl.context.reader.StoreManagerRuleSet Rule Set for creating a StoreManager and related objects
org.tm4j.panckoucke.impl.model.AModelImpl Panckoucke-Implementation of the Model-Interface This implementaion works internally with the classes AMArcImpl and AMNodeImpl.
org.tm4j.panckoucke.impl.model.ModelProviderImpl Created on 21.02.2003
org.tm4j.panckoucke.impl.model.ModelUtil Created on 21.02.2003
org.tm4j.panckoucke.impl.notification.NotificationDispatcher The send-mechanics of this Dispatcher works with a copy of the listener-registry.
org.tm4j.panckoucke.impl.notification.NotificationImpl Created on 21.02.2003
org.tm4j.panckoucke.impl.notification.NotificationRegistryImpl Created on 21.02.2003
org.tm4j.panckoucke.impl.renderer.AbstractSAXRenderer Abstract class that implements functions that can be used by XML-Renderers The class uses SAX to create the XML-Data.
org.tm4j.panckoucke.impl.renderer.GraphMLRenderer This class implements the renderer interface and renders the model as XML.
org.tm4j.panckoucke.impl.renderer.PanckouckeXMLRenderer Implementation of the renderer Interface, which produces a xml-serialisation of the model
org.tm4j.panckoucke.impl.renderer.graph.Point1Dim This represents a point in an x Coordinate System
org.tm4j.panckoucke.impl.renderer.graph.Point2Dim This represents a point in an xy Coordinate System
org.tm4j.panckoucke.impl.renderer.graph.Point3Dim This represents a position in an xyz Coordinate System
org.tm4j.panckoucke.impl.renderer.graph.RadialPosition This represents a position in an angel, radius system Starts a topic map harvesting in a distinct thread. Created on 18.02.2003 Loads a topic map in a distinct thread. Merges a topic map in a distinct thread. Created on 17.02.2003 Created on 18.02.2003 Created on 17.02.2003 Created on 20.02.2003 Wrapper around a TopicMap and a TopicMapProvider.
org.tm4j.panckoucke.model.AMGestaltRegistry This class provides Applications with an extendable Registry for AMGestalt-Instances.
org.tm4j.panckoucke.notification.StateChangedNotification Datastructure which is passes as the related object of a Notification from Type TM_STATE_CHANGED.
org.tm4j.panckoucke.render.rep.RepresentationRegistryImpl Simple implementation of IRepresentationRegistry using a HashMap for managing the instances Instances of this class are collecting MetaData for a TopicMapReference Dependent on the origin and the store state of the related TopicMapReference only some of the meta data properties will contain valid data
org.tm4j.panckoucke.test.ConfigTest Created on 21.02.2003
org.tm4j.panckoucke.test.abstraction.AssociationRoleMatrixBuilderTest Tests the filling of Matrices with various list of associations
org.tm4j.panckoucke.test.abstraction.model.AMGestaltTest Testcases for manipulating an AbstractionModel
org.tm4j.panckoucke.test.abstraction.model.AModelTest Testcases for manipulating an AbstractionModel
org.tm4j.panckoucke.test.context.ContextFactoryImplTest Started to implement tests for ContextFactoryImplementation
org.tm4j.panckoucke.test.context.PanckouckeContextImplTest Started to implement tests for the panckoucke-context
org.tm4j.panckoucke.test.renderer.GraphMLRendererTest Last Checkin $Date: 2004/07/14 13:14:45 $ $Revision: 1.5 $ A Test class for the GraphML renderer. Created on 21.02.2003 Created on 18.02.2003 Created on 18.02.2003 Created on 21.02.2003 Created on 20.02.2003
org.tm4j.panckoucke.util.AMNodeIterator Implementation of the Iterator-Interface that returns AMNodes.
org.tm4j.panckoucke.util.AMNodeList An extension of ArrayList that guarantees, that the list does only contain Members of class org.tm4j.panckoucke.model.AMNode
org.tm4j.panckoucke.util.AMUtil Utility class containing some helper methods for creating nodes
org.tm4j.panckoucke.util.AbstractionNodeUtils Utility class containing some helper methods for creating nodes
org.tm4j.panckoucke.util.BesteckUtils Utility class for Converting different Besteck implementations
org.tm4j.panckoucke.util.InstanceExtractor An extractor which returns a collection of all the topic(s), association(s) and occurrence(s) which use the topic specified on the input as a type.
If the input object is not a Topic, an empty collection will be returned.
org.tm4j.panckoucke.util.NameUtil Collection of static methods to generate names for different TopicMapObjects.
org.tm4j.panckoucke.util.PSIUtil Utility-Class to manage PSIs *
org.tm4j.panckoucke.util.RolePlayersExtractor An extractor which takes a Topic instance as input and returns a Collection of the Topics which are playing the role defined by that Topic in any associciation If the input object is not a Topic, an empty collection will be returned.
org.tm4j.tmapi.core.TMAPIVariantImpl A View that displays all currently loaded topicmaps. Static methods to concentrate logging-facility at one point This is a helper class for managing LookAndFeel New Look and Feels can be added into the LookAdFell.props property file However, this class also ensures that only look and feels whoose implementations are on the classpath, will be listed as available.
This class also implements ActionListener. An extension of the History class that is able to write its data to and to restore it from a persistency store The Main class of TMNav, its the entry point and the location to fetch static resources. The main frame of tmnav. Opens the AboutTMNav-Dialog Creates the singleton instrance of the AbstractionHint-Dialog. Creates the singleton instrance of the CreateProviderDialog. Opens the Harvest-Dialog Opens the Load-Topicmap-Dialog Opens the Create-Provider-Dialog Opens the Load-Topicmap-Dialog Opens the Load-Topicmap-Dialog TM-NAV-Shutdown Opens the Create-Provider-Dialog The send-mechanics of this Dispatcher works with a copy of the listener-registry. An simple Event implementation. The Indexpanel visualizes several indexes of tmnav. Collects and renders an Index-View for generic contents. The IndexRenderer is a lightweight specialisation of the ListRenderer, designed to work in cojunction with the IndexAbstractor.
In its renderModel-method the IndexAbstractor extracts the list of nodes that form the index. A base class for treeNodes which contains children. creates a JMenuItem th Container that manages Menuitems This class builds a PopupMenue for a distinct Member and opens it The class may be used by renderers as a helper. JMenuItem, that opens the AbstractionHint- Property-Editor JMenu, used as a submenu that displays all settings relevant to Abstractors JMenu, used as a submenu to choose a Renderer Dialog to harvest a topic map. Dialog to load a topic map. Thread that sets the amount of free and total memory each second as the text of a JLabel. A menuItem that opens a given Member in the Users Browser
What exactly is passed to the browser, depends on the given Member. A RendererView combines an Abstractor that builds a model and a Renderer that presents it. Dialog to customize a RendererView. A ComboBox which holds references to all Loaded TopicMaps. The menu bar of the TMNav main frame. JMenu, that displays a set of available Renderers.
Only Renderers that are marked as user chooseable will be displayed in this Menu. A specialisation of JFrame that stores its size and position * from session to session * * @author Christoph Froehlich, A specialisation of JSplitPane that is capable to store the location of its divider between sessions.
The two methods store and restore must be called manually on startup and shutdown Helper to return preinitialised components. Some utility functions that deal with Arrays Collection of static helper methods for file handling Generic Pool-Implementation. Created on 22.02.2003
org.tm4j.tmnav.env.AbstractionEnviroment An AbstractionEnviroment manages the collaboration between an Abstractor and a Renderer.

An AbstractionEnviroment consists of
  • a current Renderer
  • the RendererDesc of the current Renderer
  • an AbstractorDesc
  • an AbstractionContext
  • a list of AbstractorDescs that are suitable for the current renderer
  • a list of SetableOptions that may be set in the current AbstractionContext.
org.tm4j.tmnav.env.DescriptionManager This class manages all Renderer- and Abstractor-Descriptions.
org.tm4j.tmnav.env.NavContext Holds references to Manager-Objects that are widely used in TMNav.
org.tm4j.tmnav.env.Option A Java Bean that describes a predefined option.
Instances of this class may be used to build a set of available options for a certain property.
org.tm4j.tmnav.env.Property A Java Bean that represents a key-value-pair.
org.tm4j.tmnav.env.RendererViewManager This class manages all RendererViews.
org.tm4j.tmnav.env.SetableProperty A Java bean that describes a setable property, optionally along with a set of predefined values .
The bean combines
  • a property
  • a value for that property
  • an optional defaultvalue for that property
  • optional options for the value of that property.
org.tm4j.tmnav.env.TMNavEnvironment This class stores and provides access to tmnav user configuration that is once read at startup time.
org.tm4j.tmnav.env.TMNavSettings This class is a beanish container for several properties that are not related to the collaboration with panckoucke
org.tm4j.tmnav.env.TMNavUserDir This class manages the UserDirectory of TMNav where all the individual settings files goes.
org.tm4j.tmnav.env.desc.AbstractorDesc Holds metadata about an Abstractor.

Any AbstractorDesc is identified by an id, that is unique in the scope of the org.tm4j.tmnav.env.DescriptionManager in charge.

org.tm4j.tmnav.env.desc.MenuDesc A bean, that stores information about a RendererView in a manner, that is suitable for serialisation.
org.tm4j.tmnav.env.desc.MenuItemDesc Describes either a MenuItemProvider or a Class that implements the Invokable-Interface
org.tm4j.tmnav.env.desc.MenuRefDesc Holds a reference - string that is meant to be resolved as a MenuDesc
org.tm4j.tmnav.env.desc.RendererDesc Holds metainformation about a Renderer.

A RendererDesc may be created for every class that implements the Renderer-Interface.
org.tm4j.tmnav.env.desc.RendererViewDesc A bean, that stores information about a RendererView in a manner, that is suitable for serialisation.
org.tm4j.tmnav.env.digester.AbstractorRuleSet RuleSet for the description of an Abstractor.
This rule creates an instance of org.tm4j.tmnav.env.desc.AbstractorDesc
org.tm4j.tmnav.env.digester.MenuItemRuleSet RuleSet for the description of a MenuItem.
This rule creates an instance of org.tm4j.tmnav.env.desc.MenuDesc and adds it to the enclosing instance (usually an instance of org.tm4j.tmnav.env.TMNavEnvironment).
org.tm4j.tmnav.env.digester.MenuRuleSet RuleSet for the description of a Property.
This rule creates an instance of org.tm4j.tmnav.env.SetableProperty
org.tm4j.tmnav.env.digester.OptionRuleSet RuleSet for an option of a Property.
This rule creates an org.tm4j.tmnav.env.Option-Instance.
org.tm4j.tmnav.env.digester.OptionSetRuleSet RuleSet for the container of options.
This rule creates no instance, but sets properties in the containing PropertyDesc
org.tm4j.tmnav.env.digester.PanckouckeRuleSet RuleSet for the digesting of a <panckoucke>-element.
org.tm4j.tmnav.env.digester.PropertyRuleSet RuleSet for a simple key value pair.
This rule expects an onject on the top of the stack, that has a method: setProperty(String key, String value).
org.tm4j.tmnav.env.digester.ProviderRuleSet RuleSet for the description of a Provider.
This rule creates an instance of org.tm4j.tmnav.env.desc.ProviderDesc
org.tm4j.tmnav.env.digester.RendererRuleSet RuleSet for the description of a Renderer.
This rule creates an instance of org.tm4j.tmnav.env.desc.RendererDesc and adds it to the enclosing instance (usually an instance of org.tm4j.tmnav.env.TMNavEnvironment).
org.tm4j.tmnav.env.digester.RendererViewRuleSet RuleSet for the description of a RendererView.
This rule creates an instance of org.tm4j.tmnav.env.desc.RendererViewDesc
org.tm4j.tmnav.env.digester.SelectRuleSet RuleSet for the description of a Property.
This rule creates an instance of org.tm4j.tmnav.env.SetableProperty
org.tm4j.tmnav.env.digester.SettingsRuleSet RuleSet for the description of a Property.
This rule creates an instance of org.tm4j.tmnav.env.SetableProperty
org.tm4j.tmnav.example.InvokableExample Small Exmaple that shows a basic implementation of the invokable interface.
org.tm4j.tmnav.example.MenuItemProviderExample Demonstrates the use of the JMenuItemProvider-Interface.
org.tm4j.tmnav.renderer.ColorRepresentation Useable when representing AMMember objects by colors
org.tm4j.tmnav.renderer.CommonRendererMouseAdapter MouseAdapter which may be used by Renderers.
org.tm4j.tmnav.renderer.hg.HypergraphRenderer A renderer that uses the graph visualisation from
org.tm4j.tmnav.renderer.section.AssociationSectionGroupPanel Section that displays all Associations where the currently driving topic plays a role in.
org.tm4j.tmnav.renderer.section.CellRenderer This class contains a collection of inner classes that implement CellRenderer-Interfaces for several gestalten and components.
org.tm4j.tmnav.renderer.section.GridBagPanel This class implements a Panel which serves as the basic visual building block of the section renderer.
org.tm4j.tmnav.renderer.section.MemberSectionPanel Section that displays all Members of an Association
org.tm4j.tmnav.renderer.section.MetaSectionGroupPanel Panel that displays all the information from the MetaSectionGroup
org.tm4j.tmnav.renderer.section.RoleHeader A JPanel with a Label and a Button, used as a Subheader throughout various sections
org.tm4j.tmnav.renderer.section.SectionPanel Section that displays all Occurrences in a JTable
org.tm4j.tmnav.renderer.section.SectionRenderer Renders Models that have a CenterNode of either gestalt TOPIC or gestalt ASSOCIATION.
org.tm4j.tmnav.renderer.section.SectionTableModel A TableModel, used by several sections
org.tm4j.tmnav.renderer.section.SectionUtil Collection of helper methods
org.tm4j.tmnav.renderer.section.UICommons Collection of helper methods -some return atomic parts for section renderers from a cache in order to reduce Object Creation - some return Common-Layout-Properties that should be shared by all sections, as, for example, colors and fonts Useable when representing AMMember objects by ImageIcons A Implementation of the Representation interface for the TouchGraphRenderer User interface for navigating through the Hypergraph-View This code is based heavily on the work of Alex Shapiro.
org.tm4j.tolog.PlayerRole Interface to a special member/player pair in which each of the elements can be either a value (a Topic) or a variable.
org.tm4j.tologx.TologFragmentBuilderImpl Default implementation of the TologFragmentBuilder interface.
org.tm4j.topicmap.PSI This class defines constants for the original, pre-XTM 1.0 Published Subject Indicators Each constant defines the PSI as a full URL.
org.tm4j.topicmap.TMTypes This class provides a utility function for determining the type of a Topic Map object
org.tm4j.topicmap.TopicMapProviderBase Provides a skeleton implementation of a basic TopicMapProvider with the addTopicMap() method implemented.
org.tm4j.topicmap.TopicMapProviderFactory Abstract class to be extended by implementations which allow access to TopicMaps using the TopicMapProvider interface.
org.tm4j.topicmap.Types Contains numerical symbols used for the purpose of identifying the type of a particular topic map object.
org.tm4j.topicmap.XTMPSI This class defines constants for the XTM 1.0 Published Subject Indicators.

An abstract implementation of an IndexProvider that provides access to one or more topic map indexes which require configuration information to be correctly initialised.

org.tm4j.topicmap.index.IndexMetaImpl Simple implementation of the IndexMeta interface.
org.tm4j.topicmap.index.text.LuceneDocumentFactory Utility class for LuceneFullTextIndex Creates fields for not locator data, and Locators from Occurrences, adds object ids as unindexed fields BaseName values get a boost in order to increase their importance
org.tm4j.topicmap.index.text.LuceneIndexBase INTERNAL Abstract base class for FullTextIndexes using lucene for TextIndexing Concrete Implementations have to set an analyzer and directory implementation before starting the indexing.
org.tm4j.topicmap.index.text.LuceneQueryHitImpl This is an implementation of QueryHit for the Lucene Full Text Engine
org.tm4j.topicmap.index.text.LuceneQueryResultImpl This is an implementation of QueryResult for the Lucene Full Text Engine
org.tm4j.topicmap.source.SerializedTopicMapSource This is a implementation of the TopicMapSource Interface representing serialized TopicMaps.
org.tm4j.topicmap.unified.IDUtils Provides utility methods for converting TopicMapObject IDs to and from fully-qualified IDs.
org.tm4j.topicmap.unified.UnifiedAssociation Wrapper class around an object implementing the Association interface.
org.tm4j.topicmap.unified.UnifiedTopicMap Implements a unified topic navigation structure over multiple seperate TopicMap objects.
org.tm4j.topicmap.utils.HelperBase Abstract base class for bean-like helper classes.
org.tm4j.topicmap.utils.IDGeneratorFactory A Factory for creating IDGenerator implementations.
org.tm4j.topicmap.utils.IDGeneratorImpl The default IDGenerator implementation.
org.tm4j.topicmap.utils.ImprovedIDGeneratorImpl The default IDGenerator implementation.
org.tm4j.topicmap.utils.InScopeWalkerFilter A WalkerFilter implementation that allows through only those ScopedObjects that are in a given context.
org.tm4j.topicmap.utils.LTMLexer INTERNAL: Lexer for LTM syntax.
org.tm4j.topicmap.utils.LTMParser INTERNAL: Parser for the LTM syntax.
org.tm4j.topicmap.utils.ScopeWalkerFilter A WalkerFilter implementation that filters out all scoped objects that do not match the specified predicate.
org.tm4j.topicmap.utils.TopicMapCopier Encapsulates an algorithm for copying topics and associations between topic maps while ensuring that copied references do not result in multiple topic copies.
org.tm4j.topicmap.utils.TopicMapDoclet A custom Javadoc doclet, to be used for generating topic mapped API documentation.
org.tm4j.topicmap.utils.TopicMapFragment Encapsulates an algorithm for extracting a subset of topic map constructs from a source topic map and adding them to a destination topic map.
org.tm4j.topicmap.utils.TopicMapHandlerAdapter Provides a default implementation of the TopicMapHandler which may be overridden by derived classes.
org.tm4j.topicmap.utils.TopicMapMerger A "beanish" helper class for merging topic maps.
org.tm4j.topicmap.utils.TopicMapSerializer A subclass of HelperBase capable of serializing a TopicMap to an OutputStream.
org.tm4j.topicmap.utils.TopicUtils Contains common utilities for working with Topics.

This filter will skip all associations which are an XTM TYPE-INSTANCE association and will skip the topics which are used to define that association type and the roles of that association type.

org.tm4j.topicmap.utils.WalkerFilterAdapter A base implementation of the WalkerFilter interface.
org.tm4j.topicmap.utils.WalkerHandlerAdapter A base class for WalkerHandler implementations.
org.tm4j.topicmap.utils.XTMBuilder Implementation of the TopicMapBuilder interface which supports the parsing of topic map information from XML files conforming to the XTM 1.0 DTD and specification.

Utility class containing methods to reduce the number of objects in a TM4J topic map.

org.tm4j.topicmap.utils.extractors.AssociatedTopicsExtractor An extractor which returns a list of all topics associated with the input topic with an optionally specified association type and role specs for the the input topic and its associated topic.
org.tm4j.topicmap.utils.extractors.AssociationExtractor An unary function which takes a Member object as input and returns the parent Association object as output.
org.tm4j.topicmap.utils.extractors.AssociationGroupsExtractor An extractor which returns a Map of AssociationGroup objects which represent all the associations of a specific type in which the topic plays a specific role.
org.tm4j.topicmap.utils.extractors.AssociationNameExtractor This class implements both a BinaryFunction and a UnaryFunction that return a name string for an Association instance.
org.tm4j.topicmap.utils.extractors.BaseNamesExtractor An extractor which takes a Topic instance as input and returns the Collection of BaseNames of that Topic as output.
org.tm4j.topicmap.utils.extractors.BaseTopicExtractor Extractor that returns the base topic of the input object if and only if the input object implements the Topic interface.
org.tm4j.topicmap.utils.extractors.ExtractorBase Provides an abstract base class for extractors.
org.tm4j.topicmap.utils.extractors.MembersExtractor An extractor which takes an Association instance as input and returns the Collection of Members in that Association as output.
org.tm4j.topicmap.utils.extractors.OccurrencesExtractor This is a UnaryFunction that retrieves a Collection of Occurrence from a Topic.
org.tm4j.topicmap.utils.extractors.PlayersExtractor An extractor which takes a Member instance as input and returns a Collection of the Topics which are role players in that Member instance as Output.
org.tm4j.topicmap.utils.extractors.RefiedObjectExtractor An extractor which takes a Topic instance as input and returns the TopicMapObject which the Topic reifies or null if this Topic does not reify any object in the TM
org.tm4j.topicmap.utils.extractors.ReifyingTopicExtractor An extractor which takes a TopicMapObject instance as input and returns the Topic which reifies it or null
org.tm4j.topicmap.utils.extractors.ScopeExtractor An extractor function which takes a ScopedObject instance as input and returns the collection of Topic instances that define the scope of the object as output.
org.tm4j.topicmap.utils.extractors.SizeExtractor Extracts an integer representing the size of the input object If the input object is a collection, returns the count of the number of objects contained in the collection.
org.tm4j.topicmap.utils.extractors.TopicNameExtractor An extractor function which takes a Topic as input and returns a String as output.
org.tm4j.topicmap.utils.extractors.TypeExtractor An extractor which returns the topic(s) which type the object specified on the input.
org.tm4j.topicmap.utils.extractors.VariantNameExtractor An extractor function which takes a Topic as input and returns a Variant instance as output The Variant returned will be selected from all Variants of the BaseNames of the Topic as follows:
  1. First the BaseName which has the most preferred themes in its scope, and at least one Variant is selected.
org.tm4j.topicmap.utils.extractors.VariantsExtractor An extractor which takes a org.tm4j.topicmap.VariantContainer instance as input and returns a the Variant instances that it contains.
org.tm4j.topicmap.utils.testers.ClassInstanceAssocTester A tester which tests Association objects to see if they are XTM class-instance associations which are created by TM4J when a new type is added to a Topic.
org.tm4j.topicmap.utils.testers.ExternalOccurrenceTester Tester which returns true if the supplied object implements the Occurrence interface and if the Occurrence object contains a locator to external occurrence data.
org.tm4j.topicmap.utils.testers.FailTester A predicate which always returns a failure (false).
org.tm4j.topicmap.utils.testers.InScopeTester Predicate function which returns true if the tested object is a scoped object and if the scope of the object matches the context specified in the tester's constructor.
org.tm4j.topicmap.utils.testers.InlineOccurrenceTester Predicate which returns true if the supplied object implements the Occurrence interface and if the Occurrence object has inline data.
org.tm4j.topicmap.utils.testers.TypeTester A Predicate which returns true if the object passed in is a topic map object which is typed by one or more topics and if one or more of the typing topics is found in the list of allowed types or if the subject or subject indicator of one or more of the typing topics is found in the list of allowed subject or subject indicators.
org.tm4j.utils.SetChain A CollectionChain derivative which is flagged as a set.
org.tm4j.utils.predicates.InstanceOf A Mango binary predicate that tests if the first argument is an instance of the second argument.