ro.sync.exml.workspace.api.standalone.ditamap
Class TopicRefTargetInfo

java.lang.Object
  ro.sync.exml.workspace.api.standalone.ditamap.TopicRefTargetInfo

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class TopicRefTargetInfo
extends java.lang.Object

A map holding information about the target of a topic reference. This is filled on the API side.

Since:

12.2

Field Summary

static java.lang.String	CLASS_VALUE The class value of the target.
static java.lang.String	ELEMENT_NAME The element name.
static java.lang.String	PARSE_ERROR An error message if error (file not found or parse) occured reading the topic
static java.lang.String	RESOLVED If set to the string "true" then the Plugin API handled the reference, if not the default approach should be performed (Oxygen requests the entire content of the reference and parses the title and other properties).
static java.lang.String	TITLE The title of the target

Constructor Summary

TopicRefTargetInfo()

Method Summary

java.lang.Object	getProperty(java.lang.String propertyName) Get the value of a recognized property.
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Get the value of a recognized property.

Methods inherited from class java.lang.Object

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

Field Detail

TITLE

public static final java.lang.String TITLE

The title of the target

See Also:

Constant Field Values

CLASS_VALUE

public static final java.lang.String CLASS_VALUE

The class value of the target.

See Also:

Constant Field Values

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME

The element name.

See Also:

Constant Field Values

PARSE_ERROR

public static final java.lang.String PARSE_ERROR

An error message if error (file not found or parse) occured reading the topic

See Also:

Constant Field Values

RESOLVED

public static final java.lang.String RESOLVED

If set to the string "true" then the Plugin API handled the reference, if not the default approach should be performed (Oxygen requests the entire content of the reference and parses the title and other properties).

See Also:

Constant Field Values

Constructor Detail

TopicRefTargetInfo

public TopicRefTargetInfo()

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Get the value of a recognized property.

Parameters:

propertyName - The property name. One of the following constants:

• RESOLVED
• TITLE
• CLASS_VALUE
• ELEMENT_NAME
• PARSE_ERROR

Returns:

The property value or null if not available.

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.Object propertyValue)
                 throws java.lang.IllegalArgumentException

Get the value of a recognized property.

Parameters:

propertyName - The property name. One of the following constants:

• RESOLVED
• TITLE
• CLASS_VALUE
• ELEMENT_NAME
• PARSE_ERROR

propertyValue - The value of the property.

Throws:

java.lang.IllegalArgumentException - If the property name is not one of the constants in this class.