com.xmlmind.xmleditext.dita

Class TopicSet

java.lang.Object

com.xmlmind.xmleditapp.docset.DocumentSetBase

com.xmlmind.xmleditext.dita.TopicSet

All Implemented Interfaces:

Constants, DocumentSet, KeyDefinitions

public final class TopicSet
extends DocumentSetBase
implements KeyDefinitions

Field Summary

Fields

Modifier and Type	Field and Description
static Name	CHUNK_NAME
static Name	CLASS_NAME
static Name	CODEBASEKEYREF_NAME
static Name	CONACTION_NAME
static Name	CONKEYREF_NAME
static Name	CONREF_NAME
static Name	CONREFEND_NAME
static Name	COPY_TO_NAME
static Name	DATAKEYREF_NAME
static Name	DITA_NAME
static Name	DITAVALREF_NAME
static Name	DOMAINS_NAME
static Name	FORMAT_NAME
static Name	HEIGHT_NAME
static Name	HREF_NAME
static Name	ID_NAME
static Name	KEYREF_NAME
static Name	KEYS_NAME
static Name	LOCKTITLE_NAME
static Name	MAPREF_NAME
static Name	NAVTITLE_NAME
static Name	PROCESSING_ROLE_NAME
static Name	SCOPE_NAME
static Name	TITLE_NAME
static Name	TOPICMETA_NAME
static Name	TYPE_NAME
static String	USE_CONREF_TARGET_VALUE
static Name	VALUE_NAME
static Name	WIDTH_NAME
static Name	XTRC_NAME
static Name	XTRF_NAME

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

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.
com.xmlmind.ditac.preprocess.KeyDefinition	getKeyDefinition(String key, Node context) Returns the definition corresponding to specified key.
com.xmlmind.ditac.preprocess.KeyDefinition[]	getKeyDefinitions(Node context) Returns all the key definitions contained in this set.
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

getClientProperty, setClientProperty

Methods inherited from class java.lang.Object

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

Field Detail

DITA_NAME

public static final Name DITA_NAME

DITAVALREF_NAME

public static final Name DITAVALREF_NAME

MAPREF_NAME

public static final Name MAPREF_NAME

TITLE_NAME

public static final Name TITLE_NAME

TOPICMETA_NAME

public static final Name TOPICMETA_NAME

CHUNK_NAME

public static final Name CHUNK_NAME

CLASS_NAME

public static final Name CLASS_NAME

CODEBASEKEYREF_NAME

public static final Name CODEBASEKEYREF_NAME

CONACTION_NAME

public static final Name CONACTION_NAME

CONKEYREF_NAME

public static final Name CONKEYREF_NAME

CONREFEND_NAME

public static final Name CONREFEND_NAME

CONREF_NAME

public static final Name CONREF_NAME

COPY_TO_NAME

public static final Name COPY_TO_NAME

DATAKEYREF_NAME

public static final Name DATAKEYREF_NAME

DOMAINS_NAME

public static final Name DOMAINS_NAME

FORMAT_NAME

public static final Name FORMAT_NAME

HEIGHT_NAME

public static final Name HEIGHT_NAME

HREF_NAME

public static final Name HREF_NAME

ID_NAME

public static final Name ID_NAME

KEYREF_NAME

public static final Name KEYREF_NAME

KEYS_NAME

public static final Name KEYS_NAME

LOCKTITLE_NAME

public static final Name LOCKTITLE_NAME

NAVTITLE_NAME

public static final Name NAVTITLE_NAME

PROCESSING_ROLE_NAME

public static final Name PROCESSING_ROLE_NAME

SCOPE_NAME

public static final Name SCOPE_NAME

TYPE_NAME

public static final Name TYPE_NAME

VALUE_NAME

public static final Name VALUE_NAME

WIDTH_NAME

public static final Name WIDTH_NAME

XTRC_NAME

public static final Name XTRC_NAME

XTRF_NAME

public static final Name XTRF_NAME

USE_CONREF_TARGET_VALUE

public static final String USE_CONREF_TARGET_VALUE

See Also:

Constant Field Values

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.

Specified by:

getSpecificationURL in interface DocumentSet

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.

Specified by:

getMemberURLSet in interface DocumentSet

getMemberURLs

public URL[] getMemberURLs()

Description copied from interface: DocumentSet

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

Specified by:

getMemberURLs in interface DocumentSet

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.)

Specified by:

update in interface DocumentSet

Parameters:

console - console used to report progress, warnings and errors

Returns:

true if successfully updated; false otherwise

getActionsAfterUpdate

public int getActionsAfterUpdate(Document memberDoc)

Description copied from class: DocumentSetBase

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

Returns DocumentSet.ACTION_VALIDATE whatever the contents of specified member document.

Specified by:

getActionsAfterUpdate in interface DocumentSet

Overrides:

getActionsAfterUpdate in class DocumentSetBase

Parameters:

memberDoc - a member of this document set

Returns:

an OR-set of actions DocumentSet.ACTION_VALIDATE, DocumentSet.ACTION_REDRAW, DocumentSet.ACTION_TRANSCLUDE

See Also:

DocumentSet.update(com.xmlmind.util.Console)

getKeyDefinition

public com.xmlmind.ditac.preprocess.KeyDefinition getKeyDefinition(String key,
                                                                   Node context)

Description copied from interface: KeyDefinitions

Returns the definition corresponding to specified key. Returns null if specified key is unknown.

Specified by:

getKeyDefinition in interface KeyDefinitions

Parameters:

key - key searched for

context - used to determine the key space (AKA key scope)

getKeyDefinitions

public com.xmlmind.ditac.preprocess.KeyDefinition[] getKeyDefinitions(Node context)

Description copied from interface: KeyDefinitions

Returns all the key definitions contained in this set.

Specified by:

getKeyDefinitions in interface KeyDefinitions

Parameters:

context - used to determine the key space (AKA key scope)