public interface

Transforms

com.microstrategy.web.transform.Transforms

Class Overview

The Transforms interface exposes a collection of Transform objects.

Summary

Public Methods
abstract boolean addTransform(Transform _transform)
Adds a Transform object to the collection.
abstract void clear()
Removes all of the Transform objects from the collection
abstract int getCount()
Returns the number of Transform objects in the collection.
abstract Transform getTransform(String name)
Retrives a specific Transform object by its className.
abstract Transform getTransform(int index)
Retrieves a specific Transform object by its numeric index.
abstract Transform remove(int index)
Removes the Transform object at the specified position in the collection.
abstract Transform remove(String className)
Removes the Transform object with the specified class name from the collection.
abstract Transform remove(Transform trans)
Removes the Transform object from the collection.

Public Methods

public abstract boolean addTransform (Transform _transform)

Adds a Transform object to the collection.

Parameters
_transform the name of the new Transform object.
Returns
  • true if transform was added, false if the transform is already in the collection.
Throws
IllegalArgumentException thrown if this transform is not in the collection

public abstract void clear ()

Removes all of the Transform objects from the collection

public abstract int getCount ()

Returns the number of Transform objects in the collection.

Returns
  • number of Transform objects contained in the collection.
See Also

public abstract Transform getTransform (String name)

Retrives a specific Transform object by its className.

Parameters
name class Name of the Transform object.
Returns
  • the Transform object in the collection with the given class name.
Throws
IllegalArgumentException thrown if no transform has the given class name in the collection.

public abstract Transform getTransform (int index)

Retrieves a specific Transform object by its numeric index.

Parameters
index of the Transform object in collection.
Returns
  • the Transform object in the collection with the given index.
Throws
IndexOutOfBoundsException thrown if the index is invalid.

public abstract Transform remove (int index)

Removes the Transform object at the specified position in the collection.

Parameters
index of the Transform object to remove.
Throws
thrown if the specified index is out of range.
IndexOutOfBoundsException

public abstract Transform remove (String className)

Removes the Transform object with the specified class name from the collection.

Parameters
className the name of the Transform object to remove.
Throws
IllegalArgumentException thrown if no transform definition has the given name in the collection.

public abstract Transform remove (Transform trans)

Removes the Transform object from the collection.

Parameters
trans the Transform object to remove.
Throws
IllegalArgumentException thrown if no transform has the given class name in the collection.