Package ro.sync.ecss.dita

Class ContextKeyManager

java.lang.Object

ro.sync.ecss.dita.ContextKeyManager

All Implemented Interfaces:

KeysManagerBase

@API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public abstract class ContextKeyManager
extends Object
implements KeysManagerBase

Context aware key manager. One can use the provided factory methods to create a key manager that uses the informations provided by the user to resolve the keys. It is an opaque class that can be passed to various DITAAccess methods.

Since:

15.2

Method Summary

Modifier and Type	Method	Description
static ContextKeyManager	createFromDitaMapUrl(URL ditaMapUrl, ro.sync.ecss.dita.map.checker.ditaval.ConditionProcessor conditionProcessor, ro.sync.ecss.dita.map.representation.DITAMapTreeModelCreatedListener ditaMapTreeModelCreatedListener)	Creates a key manager that uses the DITA map with the given URL to resolve the keys.
static ContextKeyManager	createFromKeyDefinitionManager(KeyDefinitionManager keyDefinitionManager)	Creates a key manager that uses an user-provided KeyDefinitionManager to resolve the keys.
static ContextKeyManager	getDefault()	Returns the default key manager that uses the currently opened DITA map.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.dita.KeysManagerBase

getCopyToMapping, getEnumerationDefs, getKeyDefinitionForKeyName, getKeyDefinitionForTarget, getKeys, getReltableRelationships, getURLKeyScopeContexts

Method Details

createFromDitaMapUrl

public static ContextKeyManager createFromDitaMapUrl(URL ditaMapUrl,
 ro.sync.ecss.dita.map.checker.ditaval.ConditionProcessor conditionProcessor,
 ro.sync.ecss.dita.map.representation.DITAMapTreeModelCreatedListener ditaMapTreeModelCreatedListener)

Creates a key manager that uses the DITA map with the given URL to resolve the keys.

Parameters:

ditaMapUrl - The URL of the DITA map.

conditionProcessor - A condition processor.

ditaMapTreeModelCreatedListener - Listener to be notified when the DITA Map tree model is created.

Returns:

The key manager.

createFromKeyDefinitionManager

public static ContextKeyManager createFromKeyDefinitionManager(KeyDefinitionManager keyDefinitionManager)

Creates a key manager that uses an user-provided KeyDefinitionManager to resolve the keys.

Parameters:

keyDefinitionManager - The key definition manager.

Returns:

The key manager.

getDefault

public static ContextKeyManager getDefault()

Returns the default key manager that uses the currently opened DITA map.

Returns:

The key manager.