net.ontopia.topicmaps.utils.ltm
Class LTMTopicMapWriter

java.lang.Object
  net.ontopia.topicmaps.utils.ltm.LTMTopicMapWriter

All Implemented Interfaces:

TopicMapWriterIF

public class LTMTopicMapWriter
extends Object
implements TopicMapWriterIF

PUBLIC: Exports topic maps to the LTM 1.3 interchange format.

Since:

2.2

Field Summary

protected Comparator	associationComparator
protected String	base
protected Comparator	baseNameComparator
protected Calendar	calendar
protected Comparator	elementIdComparator
protected String	encoding
protected DeciderIF	filter
protected String	groupString1
protected net.ontopia.topicmaps.utils.ltm.LTMTopicMapWriter.IdManager	idManager
protected Comparator	occurrenceComparator
protected Writer	out
protected boolean	preserveIds
protected Comparator	reifierComparator
protected Comparator	roleComparator
protected Map	roleCounter
protected Map	rolesCounted
protected Comparator	scopeComparator
protected Comparator	supersubComparator
protected Comparator	supersubRoleComparator
protected Comparator	topicComparator
protected Comparator	variantComparator

Constructor Summary

LTMTopicMapWriter(OutputStream stream)
PUBLIC: Create an LTMTopicMapWriter that writes to a given OutputStream in UTF-8.

LTMTopicMapWriter(OutputStream stream, String encoding)
PUBLIC: Create an LTMTopicMapWriter that writes to a given OutputStream in the given encoding.

LTMTopicMapWriter(Writer out)
Deprecated.

LTMTopicMapWriter(Writer out, String encoding)
PUBLIC: Create an LTMTopicMapWriter that writes to a given Writer.

Method Summary

void	setFilter(DeciderIF filter) PUBLIC: Sets the filter that decides which topic map constructs are accepted in the exprted ltm.
void	setPreserveIds(boolean preserveIds) PUBLIC: Set whether IDs should be preserved or generated.
void	write(TopicMapIF tm) PUBLIC: Writes out the given topic map.

Methods inherited from class java.lang.Object

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

Field Detail

encoding

protected String encoding

preserveIds

protected boolean preserveIds

roleCounter

protected Map roleCounter

rolesCounted

protected Map rolesCounted

out

protected Writer out

calendar

protected Calendar calendar

base

protected String base

filter

protected DeciderIF filter

associationComparator

protected Comparator associationComparator

baseNameComparator

protected Comparator baseNameComparator

elementIdComparator

protected Comparator elementIdComparator

supersubComparator

protected Comparator supersubComparator

supersubRoleComparator

protected Comparator supersubRoleComparator

occurrenceComparator

protected Comparator occurrenceComparator

reifierComparator

protected Comparator reifierComparator

roleComparator

protected Comparator roleComparator

scopeComparator

protected Comparator scopeComparator

topicComparator

protected Comparator topicComparator

variantComparator

protected Comparator variantComparator

idManager

protected net.ontopia.topicmaps.utils.ltm.LTMTopicMapWriter.IdManager idManager

groupString1

protected String groupString1

Constructor Detail

LTMTopicMapWriter

public LTMTopicMapWriter(OutputStream stream)
                  throws IOException

PUBLIC: Create an LTMTopicMapWriter that writes to a given OutputStream in UTF-8. Warning: Use of this method is discouraged, as it is very easy to get character encoding errors with this method.

Parameters:

stream - Where the output should be written.

Throws:

IOException

LTMTopicMapWriter

public LTMTopicMapWriter(OutputStream stream,
                         String encoding)
                  throws IOException

PUBLIC: Create an LTMTopicMapWriter that writes to a given OutputStream in the given encoding.

Parameters:

stream - Where the output should be written.

encoding - The desired character encoding.

Throws:

IOException

LTMTopicMapWriter

public LTMTopicMapWriter(Writer out)

Deprecated.

PUBLIC: Create an LTMTopicMapWriter that writes to a given Writer.

Parameters:

out - Where the output should be written.

LTMTopicMapWriter

public LTMTopicMapWriter(Writer out,
                         String encoding)

PUBLIC: Create an LTMTopicMapWriter that writes to a given Writer.

Parameters:

out - Where the output should be written.

encoding - The encoding used by the writer. This is the encoding that will be declared on the first line of the LTM file. It must be reported, because there is no way for the LTMTopicMapWriter to know what encoding the writer uses.

Since:

4.0

Method Detail

setPreserveIds

public void setPreserveIds(boolean preserveIds)

PUBLIC: Set whether IDs should be preserved or generated.

Parameters:

preserveIds - Should be set to true if IDs should be preserved.

setFilter

public void setFilter(DeciderIF filter)

PUBLIC: Sets the filter that decides which topic map constructs are accepted in the exprted ltm. Uses 'filter' to identify individual topic constructs as allowed or disallowed. TM constructs that depend on the disallowed topics are also disallowed.

Parameters:

filter - Places constraints on individual topicmap constructs.

write

public void write(TopicMapIF tm)
           throws IOException

PUBLIC: Writes out the given topic map.

Specified by:

write in interface TopicMapWriterIF

Parameters:

tm - The topic map to be exported/written; an object implementing TopicMapIF

Throws:

IOException - Thrown if writing the topic map fails.