com.xmlmind.xmleditapp.docset.modulardoc

Class ModularDocument

java.lang.Object

com.xmlmind.xmleditapp.docset.DocumentSetBase

com.xmlmind.xmleditapp.docset.modulardoc.ModularDocument

All Implemented Interfaces:

Constants, DocumentSet

public final class ModularDocument
extends DocumentSetBase

A implementation of DocumentSet which considers that any modular document (that is, a master document including modules by the means of an inclusion scheme such as XInclude or DITA conref) may be used to specify a document set.

Field Summary

Fields inherited from class com.xmlmind.xmleditapp.docset.DocumentSetBase

clientProperties

Fields inherited from interface com.xmlmind.xmleditapp.docset.DocumentSet

ACTION_REDRAW, ACTION_TRANSCLUDE, ACTION_VALIDATE

Fields inherited from interface com.xmlmind.xmleditapp.docset.Constants

DOCUMENT_SET_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ModularDocument(Document specDoc)

Method Summary

Modifier and Type	Method and Description
URL[]	getMemberURLs() Convenience method: same as DocumentSet.getMemberURLSet() but returns an array.
Set<URL>	getMemberURLSet() Returns the URLs of the members of this document set.
URL	getSpecificationURL() Returns the URL of the XML file specifying this document set (example: the DITA topmost map).
boolean	update(Console console) Update this document set.

Methods inherited from class com.xmlmind.xmleditapp.docset.DocumentSetBase

getActionsAfterUpdate, getClientProperty, setClientProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ModularDocument

public ModularDocument(Document specDoc)

Method Detail

getSpecificationURL

public URL getSpecificationURL()

Description copied from interface: DocumentSet

Returns the URL of the XML file specifying this document set (example: the DITA topmost map).

May return null, in which case the specification of this document set does not come from an XML file.

getMemberURLSet

public Set<URL> getMemberURLSet()

Description copied from interface: DocumentSet

Returns the URLs of the members of this document set.

May return an empty set (not null).

In the case of a modular document, the master document (example: DocBook modular book) is at the same time a member and the specification of this document set.

Important: the returned set must not be modified by client code.

getMemberURLs

public URL[] getMemberURLs()

Description copied from interface: DocumentSet

Convenience method: same as DocumentSet.getMemberURLSet() but returns an array.

update

public boolean update(Console console)

Description copied from interface: DocumentSet

Update this document set.

important: if the document set cannot be updated, do not corrupt it, keep it in its previous state. (Temporary errors may happen while the master document is being modified by the user.)

Parameters:

console - console used to report progress, warnings and errors

Returns:

true if successfully updated; false otherwise