Package ro.sync.exml.workspace.api.standalone.ditamap

Class TopicRefInfo

java.lang.Object
ro.sync.exml.workspace.api.standalone.ditamap.TopicRefInfo
@API(type=NOT_EXTENDABLE, src=PUBLIC) public class TopicRefInfo extends Object
A map holding information about the topic reference in the DITA Map. This is filled on the Oxygen side.
Since:
12.2

  • Field Details

    • ABSOLUTE_URL

      public static final String ABSOLUTE_URL
      The absolute URL of the topic reference computed by Oxygen from the "href" value. It does not include the id location.
      See Also:

    • ID_PATH

      public static final String ID_PATH
      The ID location (if any) inside the targeted URL.
      See Also:

    • HREF_VALUE

      public static final String HREF_VALUE
      The value of the "href" attribute of the <topicref> element.
      See Also:

    • KEY_SCOPES

      public static final String KEY_SCOPES
      The key scopes context in which the topicref is placed. Either empty string or something like "ks1.ks2".
      See Also:

    • ABSOLUTE_BASE_URL

      public static final String ABSOLUTE_BASE_URL
      The absolute URL of the map in which the topicref is located.
      See Also:

  • Constructor Details

    • TopicRefInfo

      public TopicRefInfo()

  • Method Details

    • getProperty

      public Object getProperty(String propertyName)
      Get the value of a recognized property.
      Parameters:
      propertyName - The property name. One of the following constants: For example if a DITA Map with the URL "cms://test/file.ditamap" references a topic using the HREF_VALUE task.dita#task then the ABSOLUTE_URL of the topic reference will be cms://test/task.dita and the ID_PATH will be task
      Returns:
      The property value or null if not available.

    • setProperty

      public void setProperty(String propertyName, Object propertyValue)
      Get the value of a recognized property.
      Parameters:
      propertyName - The property name. One of the following constants:
      propertyValue - The value of the property.
      Throws:
      IllegalArgumentException - If the property name is not one of the constants in this class.