public interface

TransformInstance

com.microstrategy.web.beans.TransformInstance

Class Overview

This interface manages a Transform object and its associated MarkupOutput object. This enables the caller to determine which transform is the "default" one and to associate a unique name for each Transform object.

A TransformInstance may possibly have no key or a null key associated with it. If such a TransformInstance object is neither the default transform, it becomes unreachable in the sense that it can not be retrieved from the collection of transforms.

Summary

Public Methods
abstract String getKey()
Returns the key associated with this instance.
abstract Transform getTransform()
Returns the Transform instance held by this instance.
abstract boolean isDefault()
Determines whether this instance is the default TransformInstance.
abstract void setDefault(boolean def)
Sets the flag that determines whether the current instance is the default TransformInstance.
abstract void setFormalParameter(String name, String value)

Convenience method to set a formal parameter.

abstract void setKey(String key)
Sets a new key to this instance.

Public Methods

public abstract String getKey ()

Returns the key associated with this instance. Null key is generally not allowed. A TransformInstance with no key, neither is it the default transform, becomes unreachable from the collection of transforms.

Returns
  • the key associated with this instance.

public abstract Transform getTransform ()

Returns the Transform instance held by this instance.

Returns
  • the Transform instance

public abstract boolean isDefault ()

Determines whether this instance is the default TransformInstance. Only one TransformInstance could be the default one.

Returns
  • true if this is the default TransformInstance.

public abstract void setDefault (boolean def)

Sets the flag that determines whether the current instance is the default TransformInstance. Only one TransformInstance could be the default one.

Parameters
def a boolean value indicating default or not.

public abstract void setFormalParameter (String name, String value)

Convenience method to set a formal parameter.

Parameters
name name of the formal parameter
value new value of the formal parameter
Throws
IllegalArgumentException thrown if the formal parameter by the given name does not exist

public abstract void setKey (String key)

Sets a new key to this instance. Null key is generally not allowed. A TransformInstance with no key, neither is it the default transform, becomes unreachable from the collection of transforms.

Parameters
key a new key to associate with
Throws
KeyAlreadyExistsException thrown if the key already exists.