| Home >> All >> org >> tm4j >> [ topicmap Javadoc ] |
• org.tm4j.topicmap: Javadoc index of package org.tm4j.topicmap.
Package Samples:
• org.tm4j.topicmap.cmd
• org.tm4j.topicmap.dom.test
• org.tm4j.topicmap.dom
• org.tm4j.topicmap.test
• org.tm4j.topicmap.index.test
• org.tm4j.topicmap.index.basic
• org.tm4j.topicmap.index
• org.tm4j.topicmap.ozone
• org.tm4j.topicmap.utils.test
• org.tm4j.topicmap.utils
• org.tm4j.topicmap.memory.index
• org.tm4j.topicmap.memory
• org.tm4j.topicmap.utils.testers
• org.tm4j.topicmap.utils.extractors
• org.tm4j.topicmap.unified.test
• org.tm4j.topicmap.unified.index
• org.tm4j.topicmap.unified
• org.tm4j.topicmap.hibernate.test
• org.tm4j.topicmap.hibernate.index
Classes:
• Topic: This interface describes a topic in a Topic Map. The Topic is perhaps the single most important construct among all those that may occur in a Topic Map. From XTM 1.0 : “A topic is a resource that acts as a proxy for some subject ; it is the topic map system's representation of that subject. The relationship between a topic and its subject is defined to be one of reification . Reification of a subject allows topic characteristics to be assigned to the topic that reifies it.” [...] “A subject is anything that can be spoken about or conceived of by a human being. In the most generic ...
• Member: Represents a member of an association. Members may be typed by a single topic (the roleSpec property) and are defined by zero or more topics. Note that in this definition, members are exclusively defined by Topic s — implementations must ensure that when processing XTM documents, the following rules are obeyed while parsing a <member> element: If the <member> element has one or more child <topicRef> elements, the topic(s) referenced by that topic reference shall be added to the member's set of players. If the <member> element has one or more child <subjectIndicatorRef> ...
• BaseName: This interface describes a base name associated with a topic. A base name is the base form of a topic name; it is always a string. Base names can be scoped, meaning that the name is valid only within certain constraints. A popular way of using scoped base names is to define natural languages as scopes and to thereby be able to name a topic in various languages. One of the trickier implications of this is the Topic Naming Constraint, stating that if in a topic map context there are two topics with identical names in identical scopes, they must be merged. Basic names can also contain Variants, which ...
• TopicMapRuntimeException: Indicates that the engine encountered an unexpected condition at runtime. Note for developers using Java 2 SDK 1.4: In version 1.4 of the Java 2 SDK, two new constructors were added to java.lang.RuntimeException which clash with TopicMapRuntimeException(Exception) 55 and TopicMapRuntimeException(String, Exception) 55 . Furthermore, the getCause() 55 method clashes with a new method of the same signature in java.lang.Throwable . This may lead to conflicts when this class is compiled using the Java 2 SDK 1.4. Please be advised that for the time being, version 1.3 is SDK version TM4J officially supports ...
• 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. Properties supported by this implementation are: http://www.tm4j.org/tm4j/xtmbuilder/validation [XTMBuilder.OPTION_VALIDATION] Specifies whether parsing should use a validating parser or a non-validating parser. If the value of this property is 'true', then a validating parser will be applied to the input stream, otherwise a non-validating parser will be applied. Default value is 'false'. http://www.tm4j.org/tm4j/xtmbuilder/failonveto ...
• TopicMapObject: The generic base interface for topic map objects. All of the interfaces that represent constructs from the topic map are derived from this interface. For a more detailed discussion of the purpose of this interface and its capablities, see the section titled TopicMapObject in the TM4J Developer's Guide . Note: TM4J provides a generic way for any client application to detect changes made in a topic map, which involves the use of properties and the java.beans.PropertyChangeListener interface. For more in-depth information about using properties in TM4J, and for a discussion of available properties, ...
• AppBase: Provides basic topic map parsing and serialisation services which are common to most command-line topic map processing applications. Applications which are derived from this class should implement the setupApplicationArgs() and run() methods. To use this class, derive your own application from this class and in the main() method (or in the constructor invoked from the main() method), make a call to the initialise() method. The initialise method will call back to your class. First, it invokes the setupApplicationArgs() method which allows you to register command line arguments specific to your application. ...
• TopicMapDoclet: A custom Javadoc doclet, to be used for generating topic mapped API documentation. There are three options you may specify when invoking this doclet: -out — the output file to write the generated topic map to. You must specify this option or no topic map will be written. -provider — the class name of the org.tm4j.topicmap.TopicMapProviderFactory you wish to use. If this is not specified, the org.tm4j.topicmap.memory.TopicMapProviderFactoryImpl class is used. -baseuri — the base URI to be used for the xml:base attribute of the topic map's root element. If this is not specified, ...
• 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, ...
• Association: This interface describes an association between one or more topics, subject indicators, or resources. The type of the Association is defined by an optional typing Topic , and its validity may or may not be restricted to a particular Scope . It contains one or more Member objects whose roles may be defined by role-specifying Topic s.
• TopicMapProviderImpl: An implementation of the TopicMapProvider interface which manages topic maps which exist as files accessible via URLs. This implementation adds one additional member function to the TopicMapProvider interface, addTopicMap(String location) which is called by the associated Factory class to set up each of the topic maps managed by this class. This class is a dumb implementation which attempts to retrieve and parse each topic map when it is added. Subsequent access are then directed to the cached, in-memory representations of the managed topic maps. As a result of this implementation, this class is ...
• DOMReferenceImpl: Abstract base class for DOM Implementations of XTM reference elements. Reference elements are those which may contain an xlink:href attribute. In XTM 1.0, this comprises the following elements: <topicRef> , <subjectIndicatorRef> , <resourceRef> , <mergeMap> .
• VariantContainer: The base interface for an object which may contain a list of child Variants. Rather than only allowing for variants being defined as children of base names, XTM also provides the possibility of nesting variants, thus establishing a context hierarchy in which variants at lower levels inherit the parameter contexts of their ancestors. TM4J deals with this provision by providing this interface being the parent interface for both BaseName and Variant .
• TopicMapList: Parses a list of strings from a command line into a set of topic map source/base URI pairs In the list of strings, the first list item is treated as a topic map source address and is parsed to either a file name or a URL. Then, if the following item in the list matches the short or long base uri option strings, then the string following that is parsed as a Locator and set as the base URI for the topic map. If the item following the topic map source address does not match the short or the long base uri option strings, then the string is treated as the address of another topic map and the process ...
• IndexManager: An IndexManager controls access to all of the indexes for a particular topic map. Depending upon the implementation, this manager may be responsible for initialising indexes when it is created (or initialisation may be deferred until a specific index is requested). As well as managing the Index objects, this class also manages real-time meta data about the indexes - this meta data includes whether or not the index is already initialised, whether or not an explicit runtime initialisation is required and whether or not the index automatically updates itself as the topic map contents change.
• IDGeneratorFactory: A Factory for creating IDGenerator implementations. The implementation returned depends upon the value of the system property org.tm4j.topicmap.idGenerator . If this property is defined, then the value of the property is treated as a class name and an attempt is made to create an new instance of the class. If that object creation fails or if the specified class does not implement the IDGenerator interface or if no value is specified for the property, then a new instance of the default implementation (org.tm4j.topicmap.utils.IDGeneratorImpl) will be created.
• DOMTypedObjectImpl: Abstract base class for DOM Implementations of typed XTM elements. Typed elements are those which may contain an <instanceOf> child element. In XTM 1.0, this comprises the following elements: <topic> , <occurrence> , <association> .
• DOMScopedObjectImpl: Abstract base class for DOM Implementations of scoped XTM elements. Scoped elements are those which may contain a <scope> child element. In XTM 1.0, this comprises the following elements: <baseName> , <occurrence> , <association> .
• DataObject: Base interface for interfaces which represent topic map elements containing character data or remote resource references. In XTM , occurrences and variant names may contain resource data, which can be one of the following: Character data ("inline data"), A locateable resource, specified by an XLink URI. This interface defines the basic methods for retrieving and manipulating resource data of both these kinds.
• TypeInstanceAssociationFilter: 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. Note This filter does not check for the uses of the topics before removing them. Therefore, if this filter is used with a topic map which makes use of the XTM defined subjects for purposes other than duplicating the topic <instanceOf> construct, then the filtered topic map may be left internally inconsistent.
• TypeInstanceAssociationFilter: 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. Note This filter does not check for the uses of the topics before removing them. Therefore, if this filter is used with a topic map which makes use of the XTM defined subjects for purposes other than duplicating the topic <instanceOf> construct, then the filtered topic map may be left internally inconsistent.
• XTMUtils: Utility class containing methods to reduce the number of objects in a TM4J topic map. The static methods contained in this class implement one or more of the XTM duplicate suppression rules. This class also contains an implementation of the XTM topic merging rules. The implementations in this class are safe to use with any TM4J backend. Warning Many of the duplicate suppression algorithms are brute-force algorithms and may take some time to execute against large topic maps.
• Index: The basic interface which must be supported by all index implementations. A typical implementation will support this interface plus additional operations to access the index itself. For example a TopicTypesIndex would implement this interface plus getTopicByType(Topic t) or something similar. This interface simply provides methods to open and close the index and to force it to rebuild itself (unless it is an index which automatically stays in-sync with the topic map data.
• ScopedObject: This interface describes a Topic Map construct which is scoped, and whose validity is thereby constrained to the set of topics that comprise the scope. Association s, BaseName s, and Occurrence s may be restricted by a scope.
• DOMTopicImpl: DOM Implementation of an XTM <topic> element. NOTE: This class inherits from DOMTypedObjectImpl and is thus a descendant of DOMScopedObjectImpl . Nonetheless, topics can't be scoped in XTM and the scope-related methods in this class are useless.
| Home | Contact Us | Privacy Policy | Terms of Service |