public
interface
MapperDefns
implements ConfigurationElement| com.microstrategy.web.transform.MapperDefns |
 Known Indirect Subclasses
|
Class Overview
The MapperDefns interface represents a collection of mapper definition objects for this Style Catalog.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
clear()
Clears the collection of mapper definition objects.
| ||||||||||
| abstract int |
getCount()
Returns the number of
MapperDefn objects in this collection. | ||||||||||
| abstract MapperDefn |
getMapperDefn(String name)
Gets the
MapperDefn associated with a given name. | ||||||||||
| abstract MapperDefn |
getMapperDefn(int index)
Gets the
MapperDefn associated with supplied index. | ||||||||||
| abstract MapperDefn |
newMapperDefn(String mapperName)
Creates a new mapper definition object with the supplied name.
| ||||||||||
| abstract void |
remove(int index)
Removes the
MapperDefn object at the specified index. | ||||||||||
| abstract void |
remove(String name)
Removes the
MapperDefn object at the specified index. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.config.ConfigurationElement
| |||||||||||
Public Methods
public abstract void clear ()
Clears the collection of mapper definition objects.
Throws
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |
|---|
public abstract int getCount ()
Returns the number of MapperDefn objects in this collection.
Returns
- The count of mapper definition objects.
public abstract MapperDefn getMapperDefn (String name)
Gets the MapperDefn associated with a given name.
Parameters
| name | The name of the mapper definition object to return. |
|---|
Returns
- The
MapperDefnobject with the supplied name.
Throws
| IllegalArgumentException | This exception is thrown if the argument does not match one of the stored names. |
|---|
public abstract MapperDefn getMapperDefn (int index)
Gets the MapperDefn associated with supplied index. A valid
index begins at 0 and continues to getCount() - 1.
Parameters
| index | The index of the MapperDefn to return. |
|---|
Returns
- The
MapperDefnat the supplied index.
Throws
| IndexOutOfBoundsException | This exception is thown if the argument is outside the range of a valid index. |
|---|
public abstract MapperDefn newMapperDefn (String mapperName)
Creates a new mapper definition object with the supplied name.
Parameters
| mapperName | The name of the new MapperDefn object to create. |
|---|
Returns
- The new mapper definition object.
Throws
| IllegalArgumentException | This exception is thrown if the argument already matches one of the stored names. |
|---|---|
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |
public abstract void remove (int index)
Removes the MapperDefn object at the specified index.
Parameters
| index | The index of the mapper definition object to remove. |
|---|
Throws
| IndexOutOfBoundsException | This exception is thown if the argument is outside the range of a valid index. |
|---|---|
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |
public abstract void remove (String name)
Removes the MapperDefn object at the specified index.
Parameters
| name | The name of the mapper definition object to remove. |
|---|
Throws
| IllegalArgumentException | This exception is thrown if the argument does not match one of the stored names. |
|---|---|
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |