public
interface
TransformDefns
implements ConfigurationElement| com.microstrategy.web.transform.TransformDefns |
 Known Indirect Subclasses
|
Class Overview
The TransformDefns interface is used to manage a collection of transform definition objects.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
clear()
Removes all of the TransformDefn objects from the collection
| ||||||||||
| abstract int |
getCount()
Returns the number of TransformDefn objects in the collection.
| ||||||||||
| abstract TransformDefn |
getTransformDefn(String name)
Retrives a specific TransformDefn object by its name.
| ||||||||||
| abstract TransformDefn |
getTransformDefn(int index)
Retrieves a specific TransformDefn object by its numeric index.
| ||||||||||
| abstract TransformDefn |
newTransformDefn(String transformName)
Creates a new TransformDefn object and adds it to the collection.
| ||||||||||
| abstract void |
remove(int index)
Removes the TransformDefn object at the specified position in the collection.
| ||||||||||
| abstract void |
remove(int index, boolean removeStyles)
Removes the TransformDefn object at the specified position in the collection.
| ||||||||||
| abstract void |
remove(String name, boolean removeStyles)
Removes the TransformDefn object with the specified name from the collection.
| ||||||||||
| abstract void |
remove(String name)
Removes the TransformDefn object with the specified name from the collection.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.config.ConfigurationElement
| |||||||||||
Public Methods
public abstract void clear ()
Removes all of the TransformDefn objects from the collection
Throws
| UnsupportedOperationException | thrown if the collection is read-only. |
|---|
public abstract int getCount ()
Returns the number of TransformDefn objects in the collection.
Returns
- number of TransformDefn objects contained in the collection.
See Also
public abstract TransformDefn getTransformDefn (String name)
Retrives a specific TransformDefn object by its name.
Parameters
| name | the name of the TransformDefn object. |
|---|
Returns
- the
TransformDefnobject in the collection with the given name.
Throws
| IllegalArgumentException | thrown if no transform definition has the given name in the collection. |
|---|
public abstract TransformDefn getTransformDefn (int index)
Retrieves a specific TransformDefn object by its numeric index.
Parameters
| index | the index of the TransformDefn object in collection. |
|---|
Returns
- the
TransformDefnobject in the collection with the given index.
Throws
| IndexOutOfBoundsException | thrown if the index is invalid. |
|---|
public abstract TransformDefn newTransformDefn (String transformName)
Creates a new TransformDefn object and adds it to the collection.
Parameters
| transformName | the name of the new TransformDefn object. |
|---|
Returns
- the
TransformDefnobject just created.
Throws
| IllegalArgumentException | thrown if the transform definition name is used by another TransformDefn object in the collection or if the style name is empty. |
|---|---|
| UnsupportedOperationException | thrown if the collection is read-only. |
public abstract void remove (int index)
Removes the TransformDefn object at the specified position in the collection. This method will not remove the associations made to the object deleted in a Style object.
Parameters
| index | the index of the TransformDefn object to remove. |
|---|
Throws
| thrown if the specified index is out of range. | |
| UnsupportedOperationException | thrown if the collection is read-only. |
| IndexOutOfBoundsException |
public abstract void remove (int index, boolean removeStyles)
Removes the TransformDefn object at the specified position in the collection.
Parameters
| index | the index of the TransformDefn object to remove. |
|---|---|
| removeStyles | whether you want to remove the styles associated with the TransformDefn object deleted or not. |
Throws
| thrown if the specified index is out of range. | |
| UnsupportedOperationException | thrown if the collection is read-only. |
| IndexOutOfBoundsException |
public abstract void remove (String name, boolean removeStyles)
Removes the TransformDefn object with the specified name from the collection.
Parameters
| name | the name of the TransformDefn object to remove. |
|---|---|
| removeStyles | whether you want to remove the styles associated with the TransformDefn object deleted or not. |
Throws
| IllegalArgumentException | thrown if no transform definition has the given name in the collection. |
|---|---|
| UnsupportedOperationException | thrown if the collection is read-only. |
public abstract void remove (String name)
Removes the TransformDefn object with the specified name from the collection. This method will not remove the associations made to the object deleted in a Style object.
Parameters
| name | the name of the TransformDefn object to remove. |
|---|
Throws
| IllegalArgumentException | thrown if no transform definition has the given name in the collection. |
|---|---|
| UnsupportedOperationException | thrown if the collection is read-only. |