Package 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method 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.
      ro.sync.ecss.dita.reference.keyref.KeyInfo getKeyDefinitionForKeyName​(java.net.URL originatorURL, java.lang.String keyName)
      Get the key definition corresponding to the given key name.
      ro.sync.ecss.dita.reference.keyref.KeyInfo getKeyDefinitionForTarget​(java.net.URL originatorURL, java.net.URL targetURL)
      Get the key definition corresponding to the target URL.
      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.List<RelLink> getReltableRelationships​(java.net.URL originatorURL)
      Get a list with relationships between topics established in the reltable.
      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. Can be null in rare cases when the keys are asked for nodes which part of an AuthorDocumentFragment, in which case usually the callback can be ignored.
        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 defs. Can be null in rare cases when the keys are asked for nodes which part of an AuthorDocumentFragment, case in which usually the callback can be ignored.
        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 defs. Can be null in rare cases when the keys are asked for nodes which part of an AuthorDocumentFragment, case in which usually the callback can be ignored.
        Returns:
        Returns the mapping between URLs and list of key scope contexts where they appeared in the map. Can be null

      • getKeyDefinitionForTarget

        ro.sync.ecss.dita.reference.keyref.KeyInfo getKeyDefinitionForTarget​(java.net.URL originatorURL,
                                                                     java.net.URL targetURL)
        Get the key definition corresponding to the target URL. This method may be asked when Oxygen's "Paste as content key reference" action is used. If it returns null, Oxygen will ask for all keys and find the key itself.
        Parameters:
        originatorURL - The DITA topic or map for which the keys are requested to resolve something (either a clicked keyref or a conkeyref).
        targetURL - The URL for which we want to know the key which is bound to it.
        Returns:
        the key definition corresponding to the target URL

      • getKeyDefinitionForKeyName

        ro.sync.ecss.dita.reference.keyref.KeyInfo getKeyDefinitionForKeyName​(java.net.URL originatorURL,
                                                                      java.lang.String keyName)
        Get the key definition corresponding to the given key name. If it returns null, Oxygen will ask for all keys using the "getContextKeyDefinitions" method and find the key itself.
        Parameters:
        originatorURL - The current DITA topic or map.
        keyName - The key name for which we request the key definition.
        Returns:
        the key definition corresponding to the target URL

      • 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. Can be null in rare cases when the keys are asked for nodes which part of an AuthorDocumentFragment, case in which usually the callback can be ignored.
        Returns:
        Returns the mappings between URLs referenced with copy-to and actual URL..

      • getReltableRelationships

        java.util.List<RelLink> getReltableRelationships​(java.net.URL originatorURL)
        Get a list with relationships between topics established in the reltable.
        Parameters:
        originatorURL - The originator URL.
        Returns:
        a list with relationships between topics established in the reltable.