Package net.ontopia.topicmaps.xml

Class XTMPathTopicMapSource

java.lang.Object

net.ontopia.topicmaps.entry.AbstractPathTopicMapSource

net.ontopia.topicmaps.entry.AbstractOntopolyTopicMapSource

net.ontopia.topicmaps.xml.XTMPathTopicMapSource

All Implemented Interfaces:

FileFilter, AutoCloseable, TopicMapSourceIF

public class XTMPathTopicMapSource
extends AbstractOntopolyTopicMapSource

INTERNAL: Source that locates XTM topic map documents in a directory on the file system.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	followTopicRefs
protected ExternalReferenceHandlerIF	ref_handler
protected boolean	validate

Fields inherited from class net.ontopia.topicmaps.entry.AbstractOntopolyTopicMapSource

alwaysReindexOnLoad, indexDirectory, maintainFulltextIndexes, supportsCreate, supportsDelete

Fields inherited from class net.ontopia.topicmaps.entry.AbstractPathTopicMapSource

base_address, duplicate_suppression, hidden, id, path, refmap, suffix, title

Constructor Summary

Constructors

Constructor	Description
XTMPathTopicMapSource()
XTMPathTopicMapSource(String path, FileFilter filter)	INTERNAL: Constructor that takes the file directory and a file filter.
XTMPathTopicMapSource(String path, String suffix)

Method Summary

Modifier and Type	Method	Description
TopicMapReferenceIF	createReference(URL url, String id, String title, LocatorIF base_address)
ExternalReferenceHandlerIF	getExternalReferenceHandler()	PUBLIC: Gets the external reference handler.
String	getExternalReferenceHandlerClass()	EXPERIMENTAL: Gets the name of the external reference handler class.
boolean	getValidation()	PUBLIC: Returns true if validation is on, false otherwise.
protected TopicMapWriterIF	getWriter(File file)	INTERNAL: Used by createTopicMap to serialize the new topic map.
void	setExternalReferenceHandler(ExternalReferenceHandlerIF ref_handler)	PUBLIC: Sets the external reference handler.
void	setExternalReferenceHandlerClass(String ref_handler)	EXPERIMENTAL: Sets the name of the external reference handler class.
void	setFollowTopicRefs(boolean followTopicRefs)	PUBLIC: If set to false topicRef elements pointing to external documents will not be traversed.
void	setValidation(boolean validate)	PUBLIC: Turn validation of XTM documents according to DTD on or off.

Methods inherited from class net.ontopia.topicmaps.entry.AbstractOntopolyTopicMapSource

createTopicMap, getAlwaysReindexOnLoad, getIndexDirectory, getMaintainFulltextIndexes, getSupportsCreate, getSupportsDelete, setAlwaysReindexOnLoad, setIndexDirectory, setMaintainFulltextIndexes, setSupportsCreate, setSupportsDelete, supportsCreate, supportsDelete

Methods inherited from class net.ontopia.topicmaps.entry.AbstractPathTopicMapSource

accept, close, createReference, getBase, getBaseAddress, getDuplicateSuppression, getFileFilter, getHidden, getId, getPath, getReferences, getSuffix, getTitle, refresh, refreshFromClasspath, refreshFromFilesystem, setBase, setBaseAddress, setDuplicateSuppression, setFileFilter, setHidden, setId, setPath, setSuffix, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

ref_handler

protected ExternalReferenceHandlerIF ref_handler

followTopicRefs

protected boolean followTopicRefs

validate

protected boolean validate

Constructor Detail

XTMPathTopicMapSource

public XTMPathTopicMapSource()

XTMPathTopicMapSource

public XTMPathTopicMapSource(String path,
                             String suffix)

XTMPathTopicMapSource

public XTMPathTopicMapSource(String path,
                             FileFilter filter)

INTERNAL: Constructor that takes the file directory and a file filter.

Parameters:

path - the path to search for TopicMaps

filter - a java.io.FileFilter to filter the specified path

Since:

1.3.4

Method Detail

createReference

public TopicMapReferenceIF createReference(URL url,
                                           String id,
                                           String title,
                                           LocatorIF base_address)

Specified by:

createReference in class AbstractOntopolyTopicMapSource

setFollowTopicRefs

public void setFollowTopicRefs(boolean followTopicRefs)

PUBLIC: If set to false topicRef elements pointing to external documents will not be traversed. The default is that the documents pointed to by those elements will be loaded (as per the XTM 1.0 specification).

Since:

3.2

setExternalReferenceHandler

public void setExternalReferenceHandler(ExternalReferenceHandlerIF ref_handler)

PUBLIC: Sets the external reference handler.

setExternalReferenceHandlerClass

public void setExternalReferenceHandlerClass(String ref_handler)

EXPERIMENTAL: Sets the name of the external reference handler class. The specified class must have a default constructor.

getExternalReferenceHandlerClass

public String getExternalReferenceHandlerClass()

EXPERIMENTAL: Gets the name of the external reference handler class.

getExternalReferenceHandler

public ExternalReferenceHandlerIF getExternalReferenceHandler()

PUBLIC: Gets the external reference handler. The reference handler will receive notifications on references to external topics and topic maps.

setValidation

public void setValidation(boolean validate)

PUBLIC: Turn validation of XTM documents according to DTD on or off. The validation checks if the documents read follow the DTD, and will abort import if they do not.

Parameters:

validate - Will validate if true, will not if false.

Since:

2.0

getValidation

public boolean getValidation()

PUBLIC: Returns true if validation is on, false otherwise.

Since:

2.0

getWriter

protected TopicMapWriterIF getWriter(File file)
                              throws IOException

INTERNAL: Used by createTopicMap to serialize the new topic map.

Specified by:

getWriter in class AbstractOntopolyTopicMapSource

Throws:

IOException