Package net.ontopia.topicmaps.xml

Class TMXMLReader

java.lang.Object

net.ontopia.xml.AbstractXMLFormatReader

net.ontopia.topicmaps.xml.TMXMLReader

All Implemented Interfaces:

TopicMapReaderIF

public class TMXMLReader
extends AbstractXMLFormatReader
implements TopicMapReaderIF

PUBLIC: A reader importing topic maps (or fragments) from the TM/XML syntax.

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_VALIDATE

Fields inherited from class net.ontopia.xml.AbstractXMLFormatReader

base_address, source

Constructor Summary

Constructors

Constructor	Description
TMXMLReader(File file)	PUBLIC: Creates a reader reading from the given file name.
TMXMLReader(InputStream stream, LocatorIF base_address)	PUBLIC: Creates a reader reading from the given InputStream using the specified base address.
TMXMLReader(Reader reader, LocatorIF base_address)	PUBLIC: Creates a reader reading from the given Reader using the specified base address.
TMXMLReader(URL url)	PUBLIC: Creates a reader reading from the given url.
TMXMLReader(URL url, LocatorIF base_address)
TMXMLReader(InputSource source, LocatorIF base)	PUBLIC: Creates a reader reading from the given location, using a different base address.

Method Summary

Modifier and Type	Method	Description
boolean	getValidate()
void	importInto(TopicMapIF topicmap)	PUBLIC: Imports an implicitly designated topic map into the given topic map.
TopicMapIF	read()	PUBLIC: Reads the next topic map available from some implicit, implementation dependent source.
Collection	readAll()	PUBLIC: Reads all the topic map available from some implicit, implementation dependent source.
void	setAdditionalProperties(Map<String,Object> properties)	Sets additional properties for the TMXMLReader.
void	setValidate(boolean validate)

Methods inherited from class net.ontopia.xml.AbstractXMLFormatReader

getBaseAddress, getInputSource, setBaseAddress, setInputSource

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_VALIDATE

public static final String PROPERTY_VALIDATE

See Also:

Constant Field Values

Constructor Detail

TMXMLReader

public TMXMLReader(URL url)
            throws MalformedURLException

PUBLIC: Creates a reader reading from the given url.

Throws:

MalformedURLException

TMXMLReader

public TMXMLReader(URL url,
                   LocatorIF base_address)

TMXMLReader

public TMXMLReader(File file)
            throws MalformedURLException

PUBLIC: Creates a reader reading from the given file name.

Throws:

MalformedURLException

TMXMLReader

public TMXMLReader(Reader reader,
                   LocatorIF base_address)

PUBLIC: Creates a reader reading from the given Reader using the specified base address.

TMXMLReader

public TMXMLReader(InputStream stream,
                   LocatorIF base_address)

PUBLIC: Creates a reader reading from the given InputStream using the specified base address.

TMXMLReader

public TMXMLReader(InputSource source,
                   LocatorIF base)

PUBLIC: Creates a reader reading from the given location, using a different base address.

Method Detail

getValidate

public boolean getValidate()

setValidate

public void setValidate(boolean validate)

read

public TopicMapIF read()
                throws IOException

Description copied from interface: TopicMapReaderIF

PUBLIC: Reads the next topic map available from some implicit, implementation dependent source.

A topic map source may contain multiple topic maps. The read method returns the next topic map that is available from that source. null is returned when there are no more topic maps available. In a sense this is iterator-like behaviour.

Specified by:

read in interface TopicMapReaderIF

Returns:

The next topic map read from the source; an object implementing TopicMapIF. null is returned when there are no more topic maps available from the source.

Throws:

IOException - Thrown if reading the source fails.

importInto

public void importInto(TopicMapIF topicmap)
                throws IOException

Description copied from interface: TopicMapReaderIF

PUBLIC: Imports an implicitly designated topic map into the given topic map.

Specified by:

importInto in interface TopicMapReaderIF

Parameters:

topicmap - The topic map into which the import will be done; an object implementing TopicMapIF.

Throws:

IOException

readAll

public Collection readAll()
                   throws IOException

Description copied from interface: TopicMapReaderIF

PUBLIC: Reads all the topic map available from some implicit, implementation dependent source.

A topic map source may contain multiple topic maps. The readAll method returns a collection contain all the topic maps available from the source.

Specified by:

readAll in interface TopicMapReaderIF

Returns:

A collection containing all the topic maps read from the source; objects implementing TopicMapIF.

Throws:

IOException - Thrown if reading the source fails.

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> properties)

Sets additional properties for the TMXMLReader. Only accepts the property "validate", which corresponds to the setValidate(boolean) method. Only accepts a boolean value.

Specified by:

setAdditionalProperties in interface TopicMapReaderIF

Parameters:

properties -