LTMProcessor (Ceryle API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.ceryle.tm
Class LTMProcessor

java.lang.Object
  org.ceryle.tm.LTMProcessor

All Implemented Interfaces:: Constants, TopicMapBuilder

public class LTMProcessor
extends Object
implements Constants, TopicMapBuilder
extends Object
implements Constants, TopicMapBuilder

Implements a parser for the Linear Topic Map Notation as described in the Ontopia paper of the same name, by Lars Marius Garshol. This implementation is used with TM4J, and extends the LTM 1.2 functionality; instances of this are marked by the phrase "LTM Extension".

It will accept Occurrences with either a quote-delimited value or the new LTM 1.2 "[[" and "]]" delimited value for resource data. Values that are URLs are automatically created as resource references (there is currently no way to store a URL as a String).

Because of #MERGEMAP directives, this LTMProcessor may end up processing multiple LTM files during the course of a single build. The base and resource locators of the initial LTM document are used for the resulting TopicMap. If a #BASEURI directive is encountered, this takes precedence.

Since:: JDK1.3
Version:: $Id: LTMProcessor.java,v 3.9 2007-06-15 12:09:32 altheim Exp $
Author:: Murray Altheim

Field Summary
`boolean`	`displayNameIsLabel` Variable controlling whether display names should call `TopicMapProcessor.setLabel(Topic,String)`.
`protected Locator`	`m_baseLoc` The base Locator of the current TopicMap, as set by its source Locator or its own `#BASEURI` directive.
`protected Locator`	`m_srcLoc` The source Locator of the current TopicMap, as provided by its source Locator.
`boolean`	`strictParsing` Variable controlling whether strict XML parsing is active.
`Topic`	`topicDescription` A PSI-based Topic identifying the subject of "topic description".

Fields inherited from interface org.ceryle.util.Constants
Amp, AMP, Apos, APOS, APP_NAME, APP_VERSION_NAME, APP_VERSION_NUMBER, AT, BANG, BAR, BIT_dev, BIT_http, BIT_ignoreCom, BIT_merge, BIT_none, BIT_noPreload, BIT_simple, BIT_ui, BIT_unused1, BIT_unused2, BIT_unused3, BIT_validating, BIT_verbose, BIT_xcatalog, BIT_xlink, BIT_xmlnsAware, BIT_xsd, BROKB, BSlash, BSLASH, CERYLE_CREDITS_FILE, CERYLE_DATA_DIR, CERYLE_HIST_FILE, CERYLE_LICENSE_FILE, CERYLE_PREF_FILE, CERYLE_PROP, CERYLE_PROP_BASE, CERYLE_PROP_FILE, CERYLE_RSRC_DIR, CERYLE_THANKS_FILE, CFLEX, Colon, COLON, Comma, COMMA, CR, CRet, Dash, DASH, DEFAULT_DIRECTORY, DEVELOPER, DOLR, Dot, DOT, EIGHT, Ellip, EOF, EqQuot, EQUAL, Equals, False, FALSE, FileProt, Filesep, FileURL, Five, FIVE, FONTSIZES, Four, FOUR, FSchar, GCOL_PROP, GRAPH_PROP, GRAVE, GT, Hash, HASH, HOME_DIRECTORY, HOME_DIRECTORY_PATH, HOME_DIRECTORY_URL, HTML, HttpProt, HttpURL, INDENT, INDENT_0, INDENT_1, INDENT_10, INDENT_2, INDENT_3, INDENT_4, INDENT_5, INDENT_6, INDENT_7, INDENT_8, INDENT_9, INIT, LCURL, LCurly, LF, LFS, Localhost, LPAR, LParen, LS, LSBrkt, LSBrkt2, LSQB, LT, MT, NBSP, NEL, NINE, NL, NL20x, NLchar, No, Null, NULL, NULL_STATE, NumParams, One, ONE, Pathsep, Percent, PERO, PLUS, Prcnt, PS, QMark, QMARK, Quot, QUOT, RCURL, RCurly, RESOURCE_BUNDLE, RPAR, RParen, RSBrkt, RSBrkt2, RSQB, Semi, SEMI, SEVEN, SIX, Slash, SLASH, SP, SPACE, Stago, Star, STAR, Tab, TAB, Tee, Three, THREE, Tilde, TILDE, TM_PROP, True, TRUE, Two, TWO, Under, UNDER, URI, URL, VBar, WIKI_PROP, XNodePfx, XNodeURL, XtmExt, Yes, Zero, ZERO

Fields inherited from interface org.ceryle.util.Constants

Amp, AMP, Apos, APOS, APP_NAME, APP_VERSION_NAME, APP_VERSION_NUMBER, AT, BANG, BAR, BIT_dev, BIT_http, BIT_ignoreCom, BIT_merge, BIT_none, BIT_noPreload, BIT_simple, BIT_ui, BIT_unused1, BIT_unused2, BIT_unused3, BIT_validating, BIT_verbose, BIT_xcatalog, BIT_xlink, BIT_xmlnsAware, BIT_xsd, BROKB, BSlash, BSLASH, CERYLE_CREDITS_FILE, CERYLE_DATA_DIR, CERYLE_HIST_FILE, CERYLE_LICENSE_FILE, CERYLE_PREF_FILE, CERYLE_PROP, CERYLE_PROP_BASE, CERYLE_PROP_FILE, CERYLE_RSRC_DIR, CERYLE_THANKS_FILE, CFLEX, Colon, COLON, Comma, COMMA, CR, CRet, Dash, DASH, DEFAULT_DIRECTORY, DEVELOPER, DOLR, Dot, DOT, EIGHT, Ellip, EOF, EqQuot, EQUAL, Equals, False, FALSE, FileProt, Filesep, FileURL, Five, FIVE, FONTSIZES, Four, FOUR, FSchar, GCOL_PROP, GRAPH_PROP, GRAVE, GT, Hash, HASH, HOME_DIRECTORY, HOME_DIRECTORY_PATH, HOME_DIRECTORY_URL, HTML, HttpProt, HttpURL, INDENT, INDENT_0, INDENT_1, INDENT_10, INDENT_2, INDENT_3, INDENT_4, INDENT_5, INDENT_6, INDENT_7, INDENT_8, INDENT_9, INIT, LCURL, LCurly, LF, LFS, Localhost, LPAR, LParen, LS, LSBrkt, LSBrkt2, LSQB, LT, MT, NBSP, NEL, NINE, NL, NL20x, NLchar, No, Null, NULL, NULL_STATE, NumParams, One, ONE, Pathsep, Percent, PERO, PLUS, Prcnt, PS, QMark, QMARK, Quot, QUOT, RCURL, RCurly, RESOURCE_BUNDLE, RPAR, RParen, RSBrkt, RSBrkt2, RSQB, Semi, SEMI, SEVEN, SIX, Slash, SLASH, SP, SPACE, Stago, Star, STAR, Tab, TAB, Tee, Three, THREE, Tilde, TILDE, TM_PROP, True, TRUE, Two, TWO, Under, UNDER, URI, URL, VBar, WIKI_PROP, XNodePfx, XNodeURL, XtmExt, Yes, Zero, ZERO

Fields inherited from interface org.tm4j.topicmap.utils.TopicMapBuilder
`OPTION_ADDED_THEMES`

Constructor Summary
`LTMProcessor(TopicMapProcessor tmprocessor)` Constructor using a TopicMapProcessor `tmprocessor`.

Method Summary
`void`	`build(InputStream source, Locator srcLoc, TopicMap topicmap)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(InputStream source, Locator srcLoc, TopicMap topicmap, Topic[] addedThemes)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(InputStream source, Locator srcLoc, TopicMap topicmap, TopicMapProvider provider)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(InputStream source, Locator srcLoc, TopicMap topicmap, TopicMapProvider provider, Topic[] addedThemes)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(InputStream source, TopicMap topicmap)` Parses the source indicated by the TypedInputSource `source`, populating the provided Document.
`void`	`build(InputStream source, TopicMap topicmap, TopicMapProvider provider)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(Reader reader, Locator srcLoc, TopicMap topicmap)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(Reader reader, Locator srcLoc, TopicMap topicmap, Topic[] addedThemes)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(Reader reader, Locator srcLoc, TopicMap topicmap, TopicMapProvider provider)` Parses the source indicated by the TypedInputSource `source`, populating the provided TopicMap.
`void`	`build(Reader reader, Locator srcLoc, TopicMap topicmap, TopicMapProvider provider, Topic[] addedThemes)` Parses the source indicated by the TypedInputSource `source`, populating the provided Document.
`protected boolean`	`forward(Reader r)` Read one character into thisChar, then read ahead nextChar.
`TopicMap`	`getTopicMap()` Returns the TopicMap generated as a result of parsing, or null if not available.
`boolean`	`isSupportedProperty(String propertyName)` Determines whether or not a specific property is supported by the TopicMapBuilder implementation.
`void`	`mergeMap(TypedInputSource source)` Merges the LTM file indicated by the TypedInputSource `source`, populating the provided Document.
`void`	`require(Reader r, String string, String errMsg)` Parse a required string.
`Association`	`scanAssociation(Reader r)` Scans until an association end delimiter (")"), returning the Association object.
`void`	`scanComment(Reader r)` Scans a C++ style comment.
`protected void`	`scanDescription(Reader r, Topic topic)` Scans forward for a topic description.
`protected void`	`scanDirective(Reader r)` Scans an LTM directive.
`protected String`	`scanLiteral(Reader r, boolean normWS)` Scans forward until the closing literal delimiter, returning a String whose LT, GT, QUOT, APOS and AMP characters have been converted to entities.
`protected String`	`scanName(Reader r)` Scans a Name [XML production 5].
`Occurrence`	`scanOccurrence(Reader r)` Scans until an occurrence end delimiter ("}"), returning the Occurrence object.
`protected String`	`scanSpace(Reader r, boolean required)` Scans space characters, reading forward until a non-space character is encountered.
`protected void`	`scanSubjectIdentifier(Reader r, Topic topic)` Scans forward for Published Subject Indicator (PSI).
`void`	`scanSuperclass(Reader r, Topic subclass)` Creates a superclass-subclass Association between the provided Topic and the scanned token representing a reference to the superclass Topic.
`protected String`	`scanToEndOfLine(Reader r)` Scans forward until an end-of-line character, returning the string.
`Topic`	`scanTopic(Reader r)` Scans until a topic end delimiter ("]"), returning the Topic object.
`protected void`	`scanTopicName(Reader r, Topic topic)` Scans forward for base name, sort name, and/or display name.
`protected Topic`	`scanType(Reader r)` Scans forward for topic, occurrence or association type (roleSpec), returning a Topic that serves as the object's type, i.e., the referent in its `<instanceOf>` or `<roleSpec>` element.
`protected String`	`scanURI(Reader r)` Scans a URI, rather loosely.
`protected void`	`scanWhitespace(Reader r, boolean required)` Scans white space [XML production 3], reading forward until a non-whitespace character is encountered.
`protected void`	`setBaseLocator(TopicMap tm, Locator loc, Locator from)` Because during processing of an LTM file we might encounter `#MERGEMAP` directives, causing sub-modules to be parsed, and because these sub-modules may themselves include their own `#MERGEMAP` or `#BASEURI` directives, only the original LTM source is able to set the resulting base URI.
`void`	`setProperty(String propertyName, Object value)` Set a configuration property for the builder which will be applied to the processing of subsequent invocations of the `build()` method.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

topicDescription

public Topic topicDescription

A PSI-based Topic identifying the subject of "topic description".

strictParsing

public boolean strictParsing

Variable controlling whether strict XML parsing is active. This mostly affects constraints on the content of XML Names.

displayNameIsLabel

public boolean displayNameIsLabel

Variable controlling whether display names should call TopicMapProcessor.setLabel(Topic,String). Default value is true.

m_baseLoc

protected Locator m_baseLoc

The base Locator of the current TopicMap, as set by its source Locator or its own #BASEURI directive.

m_srcLoc

protected Locator m_srcLoc

The source Locator of the current TopicMap, as provided by its source Locator.

Constructor Detail

LTMProcessor

public LTMProcessor(TopicMapProcessor tmprocessor)

Constructor using a TopicMapProcessor tmprocessor.

Parameters:: tmprocessor - the topic map processor used
See Also:: MessageHandler, Constants, TopicMapProcessor, TopicMap

Method Detail

mergeMap

public void mergeMap(TypedInputSource source)
              throws TopicMapException

Merges the LTM file indicated by the TypedInputSource source, populating the provided Document. This spawns a new parse() process.

LTM Extension

Parameters:: source - the TypedInputSource source to be parsed.
Throws:: TopicMapException

build

public void build(InputStream source,
                  TopicMap topicmap)
           throws IOException,
                  LocatorFactoryException,
                  TopicMapProcessingException,
                  PropertyVetoException,
                  TopicMapProviderException

Parses the source indicated by the TypedInputSource source, populating the provided Document. A convenience method that calls build(InputStream,Locator,TopicMap,TopicMapProvider).

Parameters:: source - the TypedInputSource source to be parsed; topicmap - the TopicMap to be populated
Throws:: TopicMapException - if any errors are encountered during parsing; IOException; LocatorFactoryException; TopicMapProcessingException; PropertyVetoException; TopicMapProviderException

build

public void build(InputStream source,
                  TopicMap topicmap,
                  TopicMapProvider provider)
           throws IOException,
                  LocatorFactoryException,
                  TopicMapProcessingException,
                  PropertyVetoException,
                  TopicMapProviderException

Parses the source indicated by the TypedInputSource source, populating the provided TopicMap. A convenience method that calls build(InputStream,Locator,TopicMap,TopicMapProvider).