Package com.microstrategy.web.transform

Interface MapperDefns

All Superinterfaces:

java.lang.Cloneable, ConfigurationElement

All Known Implementing Classes:

MapperDefnsImpl

public interface MapperDefns
extends ConfigurationElement

The MapperDefns interface represents a collection of mapper definition objects for this Style Catalog.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the collection of mapper definition objects.
int	getCount()	Returns the number of MapperDefn objects in this collection.
MapperDefn	getMapperDefn(int index)	Gets the MapperDefn associated with supplied index.
MapperDefn	getMapperDefn(java.lang.String name)	Gets the MapperDefn associated with a given name.
MapperDefn	newMapperDefn(java.lang.String mapperName)	Creates a new mapper definition object with the supplied name.
void	remove(int index)	Removes the MapperDefn object at the specified index.
void	remove(java.lang.String name)	Removes the MapperDefn object at the specified index.

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Method Detail

getCount

int getCount()

Returns the number of MapperDefn objects in this collection.

Returns:

The count of mapper definition objects.

getMapperDefn

MapperDefn getMapperDefn(int index)
                  throws java.lang.IndexOutOfBoundsException

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 MapperDefn at the supplied index.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.

getMapperDefn

MapperDefn getMapperDefn(java.lang.String name)
                  throws java.lang.IllegalArgumentException

Gets the MapperDefn associated with a given name.

Parameters:

name - The name of the mapper definition object to return.

Returns:

The MapperDefn object with the supplied name.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the argument does not match one of the stored names.

clear

void clear()
    throws java.lang.UnsupportedOperationException

Clears the collection of mapper definition objects.

Throws:

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

remove

void remove(int index)
     throws java.lang.IndexOutOfBoundsException,
            java.lang.UnsupportedOperationException

Removes the MapperDefn object at the specified index.

Parameters:

index - The index of the mapper definition object to remove.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

remove

void remove(java.lang.String name)
     throws java.lang.IllegalArgumentException,
            java.lang.UnsupportedOperationException

Removes the MapperDefn object at the specified index.

Parameters:

name - The name of the mapper definition object to remove.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the argument does not match one of the stored names.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

newMapperDefn

MapperDefn newMapperDefn(java.lang.String mapperName)
                  throws java.lang.IllegalArgumentException,
                         java.lang.UnsupportedOperationException

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:

java.lang.IllegalArgumentException - This exception is thrown if the argument already matches one of the stored names.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.