Package com.microstrategy.web.transform
Interface StyleMaps
-
- All Superinterfaces:
java.lang.Cloneable
,ConfigurationElement
- All Known Implementing Classes:
StyleMapsImpl
public interface StyleMaps extends ConfigurationElement
The StyleMaps interface represents a collection of individual style map objects for this Style Catalog.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear()
Clears the collection of style map objects.int
getCount()
Returns the number ofStyleMap
objects in this collection.StyleMap
getStyleMap(int index)
Gets theStyleMap
associated with supplied index.StyleMap
getStyleMap(java.lang.String name)
Gets theStyleMap
associated with a given style name.java.lang.String
mapStyle(java.lang.String origStyleName, StyleRequestContext context)
Map an incoming style ('origStyleName') to a new style, based on the definition of the maps and any contextual data.StyleMap
newStyleMap(java.lang.String styleName)
Creates a new style map object for the supplied style name.void
remove(int index)
Removes theStyleMap
object at the specified index.void
remove(java.lang.String name)
Removes theStyleMap
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 ofStyleMap
objects in this collection.- Returns:
- The count of style map objects.
-
getStyleMap
StyleMap getStyleMap(int index) throws java.lang.IndexOutOfBoundsException
Gets theStyleMap
associated with supplied index. A valid index begins at 0 and continues togetCount() - 1
.
-
getStyleMap
StyleMap getStyleMap(java.lang.String name) throws java.lang.IllegalArgumentException
Gets theStyleMap
associated with a given style name.- Parameters:
name
- The name of the style map object to return.- Returns:
- The
StyleMap
object for the associated style. - 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 style map 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 theStyleMap
object at the specified index.- Parameters:
index
- The index of the style map 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 theStyleMap
object at the specified index.- Parameters:
name
- The name of the style map 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.
-
newStyleMap
StyleMap newStyleMap(java.lang.String styleName) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
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:
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.
-
mapStyle
java.lang.String mapStyle(java.lang.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
- TheStyleRequestContext
that can be used to determine whether a mapping should be performed.- Returns:
- The name of the mapped style.
-
-