Package com.microstrategy.web.transform
Interface StyleMapClause
-
- All Superinterfaces:
java.lang.Cloneable
,ConfigurationElement
- All Known Subinterfaces:
StyleMapCondition
,StyleMapDefault
- All Known Implementing Classes:
StyleMapConditionImpl
,StyleMapDefaultImpl
public interface StyleMapClause extends ConfigurationElement
This interface represents a generic clause in a Style Map.- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
CLAUSE_CONDITION
A condition clause.static int
CLAUSE_DEFAULT
A default clause.static int
CLAUSE_UNKNOWN
An unknown clause.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getToStyle()
Returns the style to map to.int
getType()
Returns the type of the clause.StyleMapperResult
mapStyle(java.lang.String fromStyle, StyleRequestContext context)
Maps the specified style to a new style based on the data in theStyleRequestContext
object as well as any additional data specified on the condition.void
setToStyle(java.lang.String toStyle)
Sets the style to map to.-
Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement
getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML
-
-
-
-
Field Detail
-
CLAUSE_UNKNOWN
static final int CLAUSE_UNKNOWN
An unknown clause.- See Also:
- Constant Field Values
-
CLAUSE_CONDITION
static final int CLAUSE_CONDITION
A condition clause.- See Also:
- Constant Field Values
-
CLAUSE_DEFAULT
static final int CLAUSE_DEFAULT
A default clause.- See Also:
- Constant Field Values
-
-
Method Detail
-
getType
int getType()
Returns the type of the clause.- Returns:
- The type of the clause.
- See Also:
CLAUSE_CONDITION
,CLAUSE_DEFAULT
-
getToStyle
java.lang.String getToStyle()
Returns the style to map to.- Returns:
- The style to map to.
-
setToStyle
void setToStyle(java.lang.String toStyle)
Sets the style to map to.- Parameters:
toStyle
- The style to map to.
-
mapStyle
StyleMapperResult mapStyle(java.lang.String fromStyle, StyleRequestContext context)
Maps the specified style to a new style based on the data in theStyleRequestContext
object as well as any additional data specified on the condition.- Parameters:
fromStyle
- The style that is being requested.context
- The data in the current style's request context.- Returns:
- A
StyleMapperResult
object that describes the result of the mapping condition.
-
-