net.ontopia.topicmaps.utils.rdf
Class RDFTopicMapReader

java.lang.Object
  net.ontopia.topicmaps.utils.rdf.RDFTopicMapReader

All Implemented Interfaces:

TopicMapImporterIF, TopicMapReaderIF

public class RDFTopicMapReader
extends java.lang.Object
implements TopicMapReaderIF, TopicMapImporterIF

PUBLIC: Converts an RDF model to a topic map using a schema-specific mapping defined using RDF. The mapping is taken from the RDF model unless a different model is specifically indicated to contain the mapping.

Since:

2.0

Field Summary

protected boolean	duplicate_suppression
protected boolean	generate_names
protected java.lang.String	infileurl
protected boolean	lenient
protected java.lang.String	mappingsyntax
protected java.lang.String	mappingurl
protected java.lang.String	syntax

Constructor Summary

RDFTopicMapReader(java.io.File infile)
PUBLIC: Creates a reader that will read RDF/XML from the given file.

RDFTopicMapReader(java.io.File infile, java.lang.String syntax)
PUBLIC: Creates a reader that will read RDF from the given file in the indicated syntax.

RDFTopicMapReader(LocatorIF url)
PUBLIC: Creates a topic map reader bound to the URL given in the arguments.

RDFTopicMapReader(LocatorIF url, java.lang.String syntax)
PUBLIC: Creates a topic map reader bound to the URL given in the arguments.

RDFTopicMapReader(java.lang.String infileurl)
PUBLIC: Creates a reader that will read RDF/XML from the given URL.

RDFTopicMapReader(java.lang.String infileurl, java.lang.String syntax)
PUBLIC: Creates a reader that will read RDF from the given URL in the indicated syntax.

Method Summary

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.
java.util.Collection	readAll() PUBLIC: Reads all the topic map available from some implicit, implementation dependent source.
void	setDuplicateSuppression(boolean duplicate_suppression) PUBLIC: Tells the reader whether or not to perform duplicate suppression at the end of the import.
void	setGenerateNames(boolean generate_names) PUBLIC: Controls whether or not to automatically generate names for nameless topics from their subject indicators.
void	setLenient(boolean lenient) PUBLIC: Tells the reader whether or not to stop when errors are found in the mapping.
void	setMappingFile(java.io.File mappingfile) PUBLIC: Sets the file from which the reader will read the RDF-to-topic map mapping definition.
void	setMappingFile(java.io.File mappingfile, java.lang.String syntax) PUBLIC: Sets the file from which the reader will read the RDF-to-topic map mapping definition.
void	setMappingURL(java.lang.String url) PUBLIC: Sets the URL from which the reader will read the RDF-to-topic map mapping definition.
void	setMappingURL(java.lang.String url, java.lang.String syntax) PUBLIC: Sets the URL from which the reader will read the RDF-to-topic map mapping definition.

Methods inherited from class java.lang.Object

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

Field Detail

infileurl

protected java.lang.String infileurl

syntax

protected java.lang.String syntax

mappingurl

protected java.lang.String mappingurl

mappingsyntax

protected java.lang.String mappingsyntax

duplicate_suppression

protected boolean duplicate_suppression

generate_names

protected boolean generate_names

lenient

protected boolean lenient

Constructor Detail

RDFTopicMapReader

public RDFTopicMapReader(java.io.File infile)

PUBLIC: Creates a reader that will read RDF/XML from the given file.

RDFTopicMapReader

public RDFTopicMapReader(LocatorIF url)

PUBLIC: Creates a topic map reader bound to the URL given in the arguments.

Parameters:

url - The URL of the topic map document.

RDFTopicMapReader

public RDFTopicMapReader(LocatorIF url,
                         java.lang.String syntax)

PUBLIC: Creates a topic map reader bound to the URL given in the arguments.

Parameters:

url - The URL of the topic map document.

syntax - The RDF syntax to use. Possible values are "RDF/XML", "N3", "N-TRIPLE". If the value is null it defaults to "RDF/XML".

RDFTopicMapReader

public RDFTopicMapReader(java.io.File infile,
                         java.lang.String syntax)

PUBLIC: Creates a reader that will read RDF from the given file in the indicated syntax.

Parameters:

syntax - The RDF syntax to use. Possible values are "RDF/XML", "N3", "N-TRIPLE". If the value is null it defaults to "RDF/XML".

RDFTopicMapReader

public RDFTopicMapReader(java.lang.String infileurl)

PUBLIC: Creates a reader that will read RDF/XML from the given URL.

RDFTopicMapReader

public RDFTopicMapReader(java.lang.String infileurl,
                         java.lang.String syntax)

PUBLIC: Creates a reader that will read RDF from the given URL in the indicated syntax.

Parameters:

syntax - The RDF syntax to use. Possible values are "RDF/XML", "N3", "N-TRIPLE". If the value is null it defaults to "RDF/XML".

Method Detail

setMappingFile

public void setMappingFile(java.io.File mappingfile)

PUBLIC: Sets the file from which the reader will read the RDF-to-topic map mapping definition. The syntax will be assumed to be "RDF/XML".

setMappingFile

public void setMappingFile(java.io.File mappingfile,
                           java.lang.String syntax)

PUBLIC: Sets the file from which the reader will read the RDF-to-topic map mapping definition.

Parameters:

syntax - The RDF syntax to use. Possible values are "RDF/XML", "N3", "N-TRIPLE". If the value is null it defaults to "RDF/XML".

setMappingURL

public void setMappingURL(java.lang.String url)

PUBLIC: Sets the URL from which the reader will read the RDF-to-topic map mapping definition. The syntax will be assumed to be "RDF/XML".

setMappingURL

public void setMappingURL(java.lang.String url,
                          java.lang.String syntax)

PUBLIC: Sets the URL from which the reader will read the RDF-to-topic map mapping definition.

Parameters:

syntax - The RDF syntax to use. Possible values are "RDF/XML", "N3", "N-TRIPLE". If the value is null it defaults to "RDF/XML".

setGenerateNames

public void setGenerateNames(boolean generate_names)

PUBLIC: Controls whether or not to automatically generate names for nameless topics from their subject indicators.

Since:

2.0.5

setDuplicateSuppression

public void setDuplicateSuppression(boolean duplicate_suppression)

PUBLIC: Tells the reader whether or not to perform duplicate suppression at the end of the import. The default is to not do it.

Since:

2.0.3

setLenient

public void setLenient(boolean lenient)

PUBLIC: Tells the reader whether or not to stop when errors are found in the mapping. The default is to stop.

Since:

2.1

read

public TopicMapIF read()
                throws java.io.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:

java.io.IOException - Thrown if reading the source fails.

readAll

public java.util.Collection readAll()
                             throws java.io.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:

java.io.IOException - Thrown if reading the source fails.

importInto

public void importInto(TopicMapIF topicmap)
                throws java.io.IOException

Description copied from interface: TopicMapImporterIF

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

Specified by:

importInto in interface TopicMapImporterIF

Parameters:

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

Throws:

java.io.IOException