Package ro.sync.ecss.extensions.dita.map.topicref

Class PromoteTopicrefOperation

java.lang.Object

ro.sync.ecss.extensions.dita.map.topicref.PromoteTopicrefOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class PromoteTopicrefOperation
extends java.lang.Object
implements AuthorOperation

Implements a promote operation. The operation may change the type of element e.g. topicref becomes chapter

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARGUMENT_RELATIVE_LOCATION	The insert position argument.
static java.lang.String	ARGUMENT_SOURCE_LOCATION	An XPath expression that identifies the content to be demoted.

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
PromoteTopicrefOperation()	Constructs a new promote operation with a defined set of argument descriptors

Method Summary

Modifier and Type	Method	Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Executes the operation
ArgumentDescriptor[]	getArguments()	Returns the arguments of this operatons
java.lang.String	getDescription()	Returns the description of this operation

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_SOURCE_LOCATION

public static final java.lang.String ARGUMENT_SOURCE_LOCATION

An XPath expression that identifies the content to be demoted.

See Also:

Constant Field Values

ARGUMENT_RELATIVE_LOCATION

public static final java.lang.String ARGUMENT_RELATIVE_LOCATION

The insert position argument.

See Also:

Constant Field Values

Constructor Detail

PromoteTopicrefOperation

public PromoteTopicrefOperation()

Constructs a new promote operation with a defined set of argument descriptors

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of this operation

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()

getArguments

public ArgumentDescriptor[] getArguments()

Returns the arguments of this operatons

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws AuthorOperationException

Executes the operation

Specified by:

doOperation in interface AuthorOperation

Parameters:

authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.

args - The map of arguments. All the arguments defined by method AuthorOperation.getArguments() must be present in the map of arguments.

Throws:

AuthorOperationException - Thrown when the operation fails.

See Also:

AuthorOperation.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)