com.xmlmind.xmleditapp.docset

Interface DocumentSet

All Superinterfaces:

Constants

All Known Implementing Classes:

DocumentSetBase, ModularDocument, PageSet, TopicSet, TopicSet

public interface DocumentSet
extends Constants

A DocumentSet is a set of closely related documents. Documents which are members of the same document set have links to each other and/or includes all or parts of each other.

For example, when a document is modular, all the modules may be considered to be part of the same document set.

DocBook example: a book including a number of chapters, each chapter being stored in a file of its own, specifies document set comprising the master document, the book, and its modules, the chapters.

DITA example: a map specifies a document set. More precisely, this document set is specified by the main map and all the submaps included by the main map. This document set comprises all the topic files referenced by the main map and its submaps.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_REDRAW After a document set update(com.xmlmind.util.Console), redraw the member documents.
static int	ACTION_TRANSCLUDE After a document set update(com.xmlmind.util.Console), update all inclusions in the member documents.
static int	ACTION_VALIDATE After a document set update(com.xmlmind.util.Console), validate the member documents.

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

DOCUMENT_SET_PROPERTY

Method Summary

Modifier and Type	Method and Description
int	getActionsAfterUpdate(Document memberDoc) Returns an OR-set of actions specifying which actions to perform on specified member document after a document set has been updated.
Object	getClientProperty(Object key) Returns the value of the "client property" with the specified key.
URL[]	getMemberURLs() Convenience method: same as 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).
Object	setClientProperty(Object key, Object value) Add, replace or remove specified "client property".
boolean	update(Console console) Update this document set.

Field Detail

ACTION_VALIDATE

static final int ACTION_VALIDATE

After a document set update(com.xmlmind.util.Console), validate the member documents.

This action is almost always useful.

See Also:

getActionsAfterUpdate(com.xmlmind.xml.doc.Document), Constant Field Values

ACTION_REDRAW

static final int ACTION_REDRAW

After a document set update(com.xmlmind.util.Console), redraw the member documents.

This action is useful for member DITA documents making use of attribute keyref and when some of keyrefs point to image files.

See Also:

getActionsAfterUpdate(com.xmlmind.xml.doc.Document), Constant Field Values

ACTION_TRANSCLUDE

static final int ACTION_TRANSCLUDE

After a document set update(com.xmlmind.util.Console), update all inclusions in the member documents.

This action is useful for member DITA documents making use of attribute conkeyref.

See Also:

getActionsAfterUpdate(com.xmlmind.xml.doc.Document), Constant Field Values

Method Detail

getSpecificationURL

URL getSpecificationURL()

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

Set<URL> getMemberURLSet()

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

URL[] getMemberURLs()

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

update

boolean update(Console console)

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

getActionsAfterUpdate

int getActionsAfterUpdate(Document memberDoc)

Returns an OR-set of actions specifying which actions to perform on specified member document after a document set has been updated.

Parameters:

memberDoc - a member of this document set

Returns:

an OR-set of actions ACTION_VALIDATE, ACTION_REDRAW, ACTION_TRANSCLUDE

See Also:

update(com.xmlmind.util.Console)

setClientProperty

Object setClientProperty(Object key,
                         Object value)

Add, replace or remove specified "client property".

Parameters:

key - the property key

value - the property value; specify null to remove the property with the specified key

Returns:

the replaced or removed value of the property if any; null otherwise

See Also:

getClientProperty(java.lang.Object)

getClientProperty

Object getClientProperty(Object key)

Returns the value of the "client property" with the specified key.

Parameters:

key - the property key

Returns:

the value of the property if found; null otherwise

See Also:

setClientProperty(java.lang.Object, java.lang.Object)