public
interface
StyleMaps
implements ConfigurationElement| com.microstrategy.web.transform.StyleMaps |
 Known Indirect Subclasses
|
Class Overview
The StyleMaps interface represents a collection of individual style map objects for this Style Catalog.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
clear()
Clears the collection of style map objects.
| ||||||||||
| abstract int |
getCount()
Returns the number of
StyleMap objects in this collection. | ||||||||||
| abstract StyleMap |
getStyleMap(String name)
Gets the
StyleMap associated with a given style name. | ||||||||||
| abstract StyleMap |
getStyleMap(int index)
Gets the
StyleMap associated with supplied index. | ||||||||||
| abstract String |
mapStyle(String origStyleName, StyleRequestContext context)
Map an incoming style ('origStyleName') to a new style, based on the
definition of the maps and any contextual data.
| ||||||||||
| abstract StyleMap |
newStyleMap(String styleName)
Creates a new style map object for the supplied style name.
| ||||||||||
| abstract void |
remove(int index)
Removes the
StyleMap object at the specified index. | ||||||||||
| abstract void |
remove(String name)
Removes the
StyleMap 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 style map objects.
Throws
| UnsupportedOperationException | This exception is thrown if the Style Catalog is in "read only" mode. |
|---|
public abstract int getCount ()
Returns the number of StyleMap objects in this collection.
Returns
- The count of style map objects.
public abstract StyleMap getStyleMap (String name)
public abstract StyleMap getStyleMap (int index)
Gets the StyleMap associated with supplied index. A valid index
begins at 0 and continues to getCount() - 1.
Parameters
| index | The index of the StyleMap to return. |
|---|
Returns
- The
StyleMapat the supplied index.
Throws
| IndexOutOfBoundsException | This exception is thown if the argument is outside the range of a valid index. |
|---|
public abstract String mapStyle (String origStyleName, StyleRequestContext context)
Map an incoming style ('origStyleName') to a new style, based on the definition of the maps and any contextual data.
Parameters
| origStyleName | The original name of the style being requested. |
|---|---|
| context | The StyleRequestContext that can be used to
determine whether a mapping should be performed. |
Returns
- The name of the mapped style.
public abstract StyleMap newStyleMap (String styleName)
Creates a new style map object for the supplied style name.
Parameters
| styleName | The name of the style to create a map for. |
|---|
Returns
- The new style map 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 StyleMap object at the specified index.
Parameters
| index | The index of the style map 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 StyleMap object at the specified index.
Parameters
| name | The name of the style map 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. |