Package com.microstrategy.web.transform

Interface StyleMapper

  • All Known Implementing Classes:
    OutputFormatStyleMapper, PromptsContainerGUIStyleMapper
    public interface StyleMapper
    This interface represents an object that can check a set of conditions and determine whether the request for the incoming request should be mapped to another style name.
    Since:
    MicroStrategy Web 9.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      StyleMapperResult mapStyle​(java.lang.String styleName, StyleRequestContext context, java.lang.String addlData)
      Determines whether the incoming style name ('styleName') should be mapped to a new style name based on the request context object ('context') and any other additional data ('addlData') provided by the Style Catalog Administrator.

    • Method Detail

      • mapStyle

        StyleMapperResult mapStyle​(java.lang.String styleName,
                           StyleRequestContext context,
                           java.lang.String addlData)
        Determines whether the incoming style name ('styleName') should be mapped to a new style name based on the request context object ('context') and any other additional data ('addlData') provided by the Style Catalog Administrator. The result is encapsulated in an instance of a StyleMapperResult object.
        Parameters:
        styleName - The incoming style name that is being requested.
        context - The StyleRequestContext object.
        addlData - Any additional data supplied by the Style Catalog Administrator when defining this mapping.
        Returns:
        An instance of a StyleMapperResult object indicating whether the conditions for mapper were met and a preferred style name to use.