Package ro.sync.ecss.extensions.commons.operations

Class RenameElementOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.RenameElementOperation

All Implemented Interfaces:

AuthorOperation, Extension

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

An implementation of an operation that renames one or more elements identified by the given XPath expression.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARGUMENT_ELEMENT_NAME	The new name for the element(s) which will be renamed.
static java.lang.String	ARGUMENT_ELEMENT_XPATH_LOCATION	The XPath location that identifies the elements.
protected ArgumentDescriptor[]	arguments	The arguments of the operation.

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
RenameElementOperation()	Constructor for the rename element operation.

Method Summary

Modifier and Type	Method	Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_ELEMENT_XPATH_LOCATION

public static final java.lang.String ARGUMENT_ELEMENT_XPATH_LOCATION

The XPath location that identifies the elements. Empty/null for the current element. The value is elementLocation.

See Also:

Constant Field Values

ARGUMENT_ELEMENT_NAME

public static final java.lang.String ARGUMENT_ELEMENT_NAME

The new name for the element(s) which will be renamed.

See Also:

Constant Field Values

arguments

protected ArgumentDescriptor[] arguments

The arguments of the operation.

Constructor Detail

RenameElementOperation

public RenameElementOperation()

Constructor for the rename element operation.

Method Detail

doOperation

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

Description copied from interface: AuthorOperation

Perform the actual operation. You can check if the operation was invoked from the oXygen standalone application or from the oXygen plugin for Eclipse by using the method: ApplicationInformationAccess.getPlatform(). To get to the Workspace you may use: AuthorAccess.getWorkspaceAccess().

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(AuthorAccess, ArgumentsMap)

getArguments

public ArgumentDescriptor[] getArguments()

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()