Package 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 Object

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

Since:

12.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_VALUE	The class value of the target.
static final String	ELEMENT_NAME	The element name.
static final String	PARSE_ERROR	An error message if error (file not found or parse) occured reading the topic
static final 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 final String	TITLE	The title of the target

Constructor Summary

Constructors

Constructor	Description
TopicRefTargetInfo()

Method Summary

Modifier and Type	Method	Description
Object	getProperty(String propertyName)	Get the value of a recognized property.
void	setProperty(String propertyName, 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 Details

TITLE

public static final String TITLE

The title of the target

See Also:

• Constant Field Values

CLASS_VALUE

public static final String CLASS_VALUE

The class value of the target.

See Also:

• Constant Field Values

ELEMENT_NAME

public static final String ELEMENT_NAME

The element name.

See Also:

• Constant Field Values

PARSE_ERROR

public static final 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 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 Details

TopicRefTargetInfo

public TopicRefTargetInfo()

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:

• RESOLVED
• TITLE
• CLASS_VALUE
• ELEMENT_NAME
• PARSE_ERROR

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:

• RESOLVED
• TITLE
• CLASS_VALUE
• ELEMENT_NAME
• PARSE_ERROR

propertyValue - The value of the property.

Throws:

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