ro.sync.ecss.dita

Interface KeysManagerBase

All Known Implementing Classes:

ContextKeyManager

@API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public interface KeysManagerBase

Common keys manager methods

Method Summary

Modifier and Type	Method and Description
java.util.LinkedHashMap<java.net.URL,java.net.URL>	getCopyToMapping(java.net.URL originatorURL) Get mappings between URLs referenced with copy-to and actual URL.
java.util.LinkedHashSet<EnumerationDefInfo>	getEnumerationDefs(java.net.URL originatorURL) Gets all enumeration defs found in the subject scheme mapping starting from the currently opened DITA Map.
java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo>	getKeys(java.net.URL originatorURL) Gets all keys in the currently opened DITA Map.
java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>>	getURLKeyScopeContexts(java.net.URL originatorURL) Get mapping between URLs and list of key scope contexts where they appeared in the map.

Method Detail

getKeys

java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo> getKeys(java.net.URL originatorURL)

Gets all keys in the currently opened DITA Map.

Parameters:

originatorURL - The URL of the topic which needs to resolve keys.

Returns:

All keys found in the currently opened DITA Map.

getEnumerationDefs

java.util.LinkedHashSet<EnumerationDefInfo> getEnumerationDefs(java.net.URL originatorURL)

Gets all enumeration defs found in the subject scheme mapping starting from the currently opened DITA Map. Can be null.

Parameters:

originatorURL - The URL of the topic which needs to resolve the enumeration dejs.

Returns:

All enumeration defs in the currently opened DITA Map.

getURLKeyScopeContexts

java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>> getURLKeyScopeContexts(java.net.URL originatorURL)

Get mapping between URLs and list of key scope contexts where they appeared in the map.

Parameters:

originatorURL - The URL of the topic which needs to resolve the enumeration dejs.

Returns:

Returns the mapping between URLs and list of key scope contexts where they appeared in the map.

getCopyToMapping

java.util.LinkedHashMap<java.net.URL,java.net.URL> getCopyToMapping(java.net.URL originatorURL)

Get mappings between URLs referenced with copy-to and actual URL.

Parameters:

originatorURL - The originator URL.

Returns:

Returns the mappings between URLs referenced with copy-to and actual URL..